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

Copy
1<?php
2
3/**
4 * 現在のPHPインクルードパスを取得し、表示するサンプルコードです。
5 * インクルードパスは、PHPが require, include, require_once, include_once
6 * などの関数でファイルを検索するディレクトリのリストです。
7 *
8 * @return void
9 */
10function displayCurrentIncludePath(): void
11{
12    // get_include_path() を呼び出し、現在のインクルードパスを取得します。
13    // この関数は引数を取らず、現在の設定値を string または false で返します。
14    $includePath = get_include_path();
15
16    // 戻り値が false でないかを確認します。
17    // get_include_path() は、設定の取得に失敗した場合に false を返すことがあります。
18    if ($includePath !== false) {
19        echo "現在の PHP インクルードパス: " . $includePath . PHP_EOL;
20
21        // PATH_SEPARATOR 定数を使って、OSごとのパスの区切り文字を表示します。
22        // Unix系OSでは通常コロン (:)、Windows系OSではセミコロン (;) です。
23        echo "複数のパスは '" . PATH_SEPARATOR . "' で区切られています。" . PHP_EOL;
24    } else {
25        echo "PHP インクルードパスの取得に失敗しました。" . PHP_EOL;
26    }
27}
28
29// 上記で定義した関数を実行します。
30displayCurrentIncludePath();
31

PHPのget_include_path関数は、PHPがrequireやinclude、require_once、include_onceといった命令を使ってファイルを読み込む際に、どこからファイルを探すのかを指定する「インクルードパス」を取得するために利用されます。インクルードパスは、PHPがファイルを検索するディレクトリのリストです。

この関数は引数を取らずに呼び出します。戻り値としては、現在のインクルードパスが文字列として返されるか、あるいはパスの取得に失敗した場合にはfalseが返されます。そのため、サンプルコードのように戻り値がfalseでないかを必ず確認し、適切な処理を行うことが重要です。

取得したインクルードパスには、複数のディレクトリが含まれることがあり、それらはOSに応じた特定の区切り文字で連結されています。例えば、Unix系OSではコロン（:）、Windows系OSではセミコロン（;）が使われます。この区切り文字はPHPのPATH_SEPARATOR定数で確認できます。

get_include_path関数を使用することで、現在PHPがどのディレクトリをファイルの検索対象としているかをプログラムから確認でき、ファイルが見つからない際の原因特定や、実行環境に応じたパスの調整に役立てることができます。