system

外部プログラムを実行し、出力を表示する

説明

stringfalse system(string $command, int &$result_code = null)

system は、指定した command を実行し、結果を出力する C 言語の system 関数に似ています。

PHP をサーバーモジュールとして実行している場合、 system のコールにより、各行を出力した後、 Web サーバーの出力バッファが自動的にクリアされます。

コマンドを実行し、何の加工もせずに全てのデータをコマンドから直接 返す必要がある場合、passthru 関数を使用してください。

パラメータ

command

実行するコマンド。

result_code

引数 result_code が存在する場合、 実行したコマンドの返すステータスがこの変数に書かれます。

戻り値

成功時はコマンド出力の最後の行を返し、失敗時は false を返します。

エラー / 例外

system が command を実行できない場合、E_WARNING が発生します。

command が空だったり、null バイトが含まれている場合、 ValueError がスローされます。

変更履歴

バージョン 説明
8.0.0 command が空だったり、null バイトが含まれている場合、 system は ValueError をスローするようになりました。 これより前のバージョンでは、 E_WARNING が発生し、false を返していました。

例

例1 system の例

<?php
echo '<pre>';

// シェルコマンド "ls" の全ての結果を出力し、出力の最後の
// 行を $last_line に格納します。シェルコマンドの戻り値は
// $retval に格納されます。
$last_line = system('ls', $retval);

// 追加情報を表示します。
echo '
</pre>
<hr />Last line of the output: ' . $last_line . '
<hr />Return value: ' . $retval;
?>

注意

警告

ユーザーが入力したデータをこの関数に 渡すことを許可する場合、ユーザーが任意のコマンドを実行できるようシステムを欺くことが できないように escapeshellarg または escapeshellcmd を適用する必要があります。

注意: プログラムがこの関数で始まる場合、 バックグラウンドで処理を続けさせるには、 プログラムの出力をファイルや別の出力ストリームにリダイレクトする必要があります。 そうしないと、プログラムが実行を終えるまで PHP はハングしてしまいます。

参考