PHPのpopen()関数とは？使い方・構文・戻り値をサンプルコード付きで解説

popen()関数は、外部コマンドとの間でデータのやり取りを行うための「パイプ」を開くPHPの関数です。実行したいコマンドを指定すると、そのプロセスへのファイルポインタが返されます。このファイルポインタは、fgets()やfgetss()、fwrite()といった標準的なファイル操作関数と組み合わせて利用できます。

重要なポイントとして、popen()関数で開いたファイルポインタは、必ずpclose()関数で閉じる必要があります。閉じ忘れるとリソースリークの原因になるため、処理の最後には必ずpclose()を呼び出すようにしましょう。

構文

popen(command, mode)

パラメータ

• command − 実行するコマンドを文字列で指定します。

• mode − パイプのモードを指定します。「r」（読み取り専用）や「w」（書き込み専用）などがあります。

戻り値

popen()関数は、成功した場合にTRUE（ファイルポインタ）を返し、エラーが発生した場合にはFALSEを返します。返されたファイルポインタは、pclose()で閉じるまで有効です。

使用例

まずは、最も基本的なパイプの開き方から見ていきましょう。

<?php
   // パイプを開く
   $file_pointer = popen("/bin/ls", "r");
   pclose($file_pointer);
?>

出力結果

TRUE

続いて、別のコマンドを指定した例です。

使用例

<?php
   // パイプを開く
   $file_pointer = popen("/executable/installer.exe", "r");
   pclose($file_pointer);
?>

出力結果

TRUE

補足：コマンドの出力を読み取る実践的な使い方

実務では、fgets()と組み合わせて、実行したコマンドの出力を1行ずつ読み取るケースが多くあります。以下のようにwhileループとfeof()を併用すると、出力全体を取得できます。

<?php
$handle = popen("/bin/ls", "r");
while (!feof($handle)) {
   echo fgets($handle);
}
pclose($handle);
?>

このようにpopen()関数を使えば、シェルコマンドの実行結果をPHPスクリプト内で柔軟に扱うことができます。ただし、ユーザー入力をコマンドに渡す場合は、escapeshellarg()などで適切にエスケープし、セキュリティリスクに十分注意してください。