【PHP8.x】get_included_files関数の使い方

<?php

/**
 * get_included_files() の使用例を示します。
 *
 * このスクリプトは、デモンストレーションのために2つのPHPファイルを動的に作成し、
 * それらをインクルード（require_once, include_once）します。
 * その後、get_included_files() を呼び出して、現在読み込まれている
 * すべてのファイルの絶対パスを配列として取得し、画面に表示します。
 * 実行後、作成した一時ファイルは自動的に削除されます。
 */
function demonstrateGetIncludedFiles(): void
{
    // デモ用の一時ファイル名
    $tempFile1 = __DIR__ . '/temp_helper_file_1.php';
    $tempFile2 = __DIR__ . '/temp_helper_file_2.php';

    // 一時ファイルを作成
    file_put_contents($tempFile1, '<?php // Helper file 1');
    file_put_contents($tempFile2, '<?php // Helper file 2');

    // 作成したファイルを読み込む
    require_once $tempFile1;
    include_once $tempFile2;

    // include や require によって読み込まれた全てのファイルの一覧を取得する
    // このスクリプトファイル自身のパスも配列に含まれる
    $includedFiles = get_included_files();

    // 結果を整形して出力
    echo "--- Included Files ---" . PHP_EOL;
    foreach ($includedFiles as $index => $filePath) {
        // 配列のインデックスとファイルパスを表示
        echo "[" . $index . "] " . $filePath . PHP_EOL;
    }
    echo "----------------------" . PHP_EOL;

    // 後片付けとして一時ファイルを削除
    unlink($tempFile1);
    unlink($tempFile2);
}

// 関数を実行して結果を表示
demonstrateGetIncludedFiles();

get_included_files()関数は、PHPスクリプトの実行中に読み込まれた全てのファイルのパスを一覧で取得するために使用します。この関数は引数を必要とせず、呼び出すだけで動作します。

戻り値として、include、include_once、require、require_onceといった命令文によって読み込まれた全てのファイルの絶対パスが格納された配列を返します。この配列には、現在実行しているスクリプトファイル自身のパスも含まれるという特徴があります。

サンプルコードでは、まずfile_put_contents()を使ってデモンストレーション用のPHPファイルを2つ動的に作成しています。次に、require_onceとinclude_onceを使ってこれらのファイルをスクリプトに読み込みます。その後get_included_files()を呼び出すことで、実行中のメインスクリプトと先ほど読み込んだ2つのファイルの、合計3つのファイルパスが配列として取得されます。最後に、foreachループでこの配列の内容を画面に表示し、unlink()で作成した一時ファイルを削除して処理を終えています。この関数は、どのファイルが読み込まれているかを確認するデバッグ作業などで役立ちます。

<?php

declare(strict_types=1);

/**
 * get_included_files() の使用例を示します。
 *
 * この関数は、スクリプトの実行中に include, include_once, require, require_once
 * によって読み込まれた全てのファイルのパスを配列で返します。
 *
 * このサンプルでは、実行時に一時的なファイルを作成して 'require' し、
 * どのファイルが読み込まれたかを確認します。
 */
function displayIncludedFiles(): void
{
    // --- 準備: インクルードするための一時ファイルを作成 ---
    $tempFileName = 'temporary_include_file.php';
    $fileContent = "<?php\n// これは一時的なヘルパーファイルです。\n";

    // file_put_contents は、ファイルにデータを書き込みます。
    // ファイルが存在しない場合は新規作成されます。
    file_put_contents($tempFileName, $fileContent);


    // --- 実行: 作成したファイルを読み込む ---
    // これにより、読み込まれたファイルのリストに $tempFileName が追加されます。
    require_once $tempFileName;


    // --- 確認: 読み込まれたファイルの一覧を取得して表示 ---
    // get_included_files() は、実行スクリプト自身と、require/includeされた
    // ファイルの絶対パスを配列で返します。
    $includedFiles = get_included_files();

    echo '現在インクルードされているファイル:' . PHP_EOL;
    // print_r() は、配列の内容を人間が読みやすい形式で出力します。
    print_r($includedFiles);


    // --- 後片付け: 作成した一時ファイルを削除 ---
    unlink($tempFileName);
}

// 関数を実行します
displayIncludedFiles();

get_included_files()関数は、PHPスクリプトの実行中に include、include_once、require、require_once などによって読み込まれた全てのファイルのパスを配列として取得します。この関数は引数を必要としません。戻り値として、実行中のスクリプト自身のパスと、インクルードされた全てのファイルの絶対パスが格納された配列を返します。

サンプルコードでは、まず file_put_contents() を使って一時的なPHPファイルを作成し、次に require_once でそのファイルをスクリプトに読み込ませています。これにより、get_included_files() が返すリストに、この一時ファイルが追加される状況を作り出しています。

その後、get_included_files() を呼び出して、現在読み込まれているファイルの一覧を取得し、print_r() を使ってその配列の内容を画面に表示しています。出力結果には、このサンプルコード自身のファイルパスと、プログラム内で作成・読み込みされた一時ファイルのパスが含まれていることが確認できます。最後に unlink() で不要になった一時ファイルを削除して処理を終了します。この関数は、デバッグ時などにスクリプトの依存関係を確認するのに役立ちます。