関数の概要
get_included_filesは、現在のスクリプトで読み込まれたすべてのファイルの一覧を取得するPHP関数です。PHPの実行中にincludeやrequire、include_once、require_onceで読み込まれたファイルを配列として返します。これにより、どのファイルが読み込まれたかを動的に確認することができます。
パラメータの説明
- パラメータなし：引数は一切不要です。
戻り値
戻り値は、読み込まれたファイルのパスを要素とする配列です。配列の1つ目の要素は、通常メインスクリプトのファイルパスになります。全てのファイルパスは絶対パスで返されます。
使用例
基本的な使い方
<?php
// sample.php
include 'header.php';
include 'footer.php';
$includedFiles = get_included_files();
print_r($includedFiles);
?>
このようにスクリプト内で読み込んだファイルの一覧を取得して表示できます。
読み込まれたファイルの数をカウントする
<?php
include 'config.php';
include 'functions.php';
$files = get_included_files();
echo "読み込まれたファイルは " . count($files) . " 個です。";
?>
配列の要素数を調べることで、読み込まれたファイルの合計数も取得可能です。
読み込まれたファイル名だけを一覧表示
<?php
include 'lib.php';
include 'db.php';
foreach (get_included_files() as $file) {
echo basename($file) . "<br>";
}
?>
ファイル名だけを抽出し、画面に表示することでわかりやすく一覧化できます。
関連する関数
include: ファイルを読み込むrequire: ファイルを必須で読み込むinclude_once: 一度だけファイルを読み込むrequire_once: 一度だけ必須でファイルを読み込む
まとめ
get_included_filesは、PHPスクリプト内で実際に読み込まれたファイルの一覧を取得できる便利な関数です。主にデバッグや動的な管理に役立ちます。引数不要で手軽に使え、読み込まれたファイル情報を配列として取得できるため、ファイル管理やトラブルシューティング時に重宝します。複数ファイルを読み込む大規模なPHPプロジェクトでも効果的に活用できます。
