PHPのpclose()関数とは？使い方と戻り値をわかりやすく解説

はじめに

PHPには、外部コマンドやプロセスを実行するための便利な関数群が用意されています。その中でもpclose()関数は、popen()関数によって開かれたパイプを閉じる役割を担う重要な関数です。

この記事では、pclose()関数の基本的な仕組み、構文、パラメータ、戻り値について、具体的なコード例を交えながら詳しく解説していきます。

pclose()関数とは

pclose()関数は、popen()関数で開いたプロセスへのファイルポインタ（パイプ）を閉じるために使用されます。パイプを閉じる際には、実行されていたプロセスの終了を待ち、その終了ステータスを返り値として受け取ることができます。

もしエラーが発生した場合は、-1が返されます。

主な特徴

• popen()で開いたリソース専用であり、通常のファイルポインタには使用できません
• パイプを閉じる際、接続先のプロセスが終了するまで処理がブロックされます
• プロセスの終了ステータスを取得できるため、外部コマンドの成否判定に活用できます

構文

pclose(file_pointer)

パラメータ

• file_pointer − popen()関数によって返された、有効なパイプ（ファイルポインタ）を指定します。必須のパラメータです。

戻り値

pclose()関数は、実行されたプロセスの終了ステータスを整数値で返します。

• 正常に処理が完了した場合：実行プロセスの終了ステータス
• エラーが発生した場合：-1

使用例

例1：/bin/ls コマンドのパイプを開いて閉じる

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

出力結果

TRUE

この例では、まずpopen()関数を使って「/bin/ls」コマンドを読み取りモード（"r"）で実行し、パイプを開いています。その後、pclose()関数でパイプを閉じています。処理が正常に完了するとTRUEが返ります。

例2：実行可能ファイルのパイプを開いて閉じる

続いて、別の例を見てみましょう。

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

出力結果

TRUE

こちらの例では、「/executable/setup.exe」という実行可能ファイルに対してパイプを開き、pclose()関数で閉じています。この場合も正常に処理され、TRUEが出力されます。

まとめ

pclose()関数は、popen()関数とセットで使われることで初めて機能する関数です。外部コマンドを実行してその結果を扱いたい場合、パイプの後始末として必ずpclose()を呼び出すようにしましょう。

特に注意すべき点は以下の通りです。

• popen()で開いたリソースは、必ずpclose()で閉じる（リソースリーク防止）
• 戻り値の終了ステータスを確認することで、コマンドの成否を判定できる
• エラー時は-1が返るため、必要に応じてエラーハンドリングを行う

外部プロセスとの連携を行うPHPアプリケーションを開発する際には、ぜひ本記事の内容を参考にしてください。