Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【PHP8.x】DEFAULT_INCLUDE_PATH定数の使い方

DEFAULT_INCLUDE_PATH定数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

DEFAULT_INCLUDE_PATH定数は、PHPのスクリプト内で他のファイルを読み込む際に検索されるディレクトリパス、すなわちinclude_path設定のデフォルト値を表す定数です。PHPにおいて、requireincludeといった関数を使って別のファイルを読み込む場合、PHPはまずinclude_pathに設定されているディレクトリのリストの中から、指定されたファイルを探します。この定数は、php.iniファイルでinclude_pathディレクティブが明示的に設定されていない場合に、PHPが内部的に使用する標準の検索パスを保持しています。

このDEFAULT_INCLUDE_PATH定数の値は、PHPのインストール環境やOSによって異なりますが、一般的には現在のスクリプトが実行されているディレクトリ(.)と、PHPの標準ライブラリなどが格納されているシステム上のパスが含まれます。複数のパスが指定される場合は、Windows環境ではセミコロン(;)、Unix系環境ではコロン(:)で区切られています。

開発者がこの定数を直接利用する場面は多くありませんが、PHPがファイルをどのように探索するかの基本的な仕組みを理解する上で重要な情報を提供します。特に、include_pathの設定が意図せず変更された際や、特定のファイルが見つからない問題が発生した場合に、PHPのデフォルトの検索パスがどうなっているかを確認する手がかりとなります。システムエンジニアを目指す方にとっては、PHPのファイルシステム操作や設定の理解を深めるために、このデフォルトパスの概念を知っておくことは役立ちます。

構文(syntax)

1<?php
2echo DEFAULT_INCLUDE_PATH;

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

PHPがデフォルトで使用するインクルードパスを表す文字列です。このパスは、includerequireなどの関数でファイルを探す際に、自動的に参照されます。

サンプルコード

PHPのDEFAULT_INCLUDE_PATHを表示する

1<?php
2
3/**
4 * PHPのデフォルトインクルードパスを表示します。
5 *
6 * DEFAULT_INCLUDE_PATH は、PHPがスクリプトやライブラリファイルを
7 * 検索する際の初期設定パスを示します。
8 * これは、`include()` や `require()` 関数でファイルを読み込む際に、
9 * ファイル名のみを指定した場合に検索されるディレクトリの初期値です。
10 */
11function displayDefaultIncludePath(): void
12{
13    // DEFAULT_INCLUDE_PATH 定数の値を取得
14    $defaultPath = DEFAULT_INCLUDE_PATH;
15
16    // 取得したパスとその説明を出力
17    echo "PHPのデフォルトインクルードパスは次の通りです: " . $defaultPath . PHP_EOL;
18    echo "このパスは、PHPが `include()` や `require()` でファイルを検索する際の初期設定です。" . PHP_EOL;
19    echo "例えば、このパスに '/usr/share/php' が含まれていれば、PHPはこのディレクトリも探します。" . PHP_EOL;
20}
21
22// 関数を実行してデフォルトインクルードパスを表示
23displayDefaultIncludePath();
24

PHPのサンプルコードは、PHPの内部定数であるDEFAULT_INCLUDE_PATHの値を表示します。DEFAULT_INCLUDE_PATHは、PHPがスクリプトやライブラリファイルを検索する際に使用する初期設定のパスを示す文字列です。この定数自体は引数を持ちません。

コードでは、displayDefaultIncludePathという関数内でDEFAULT_INCLUDE_PATH定数の値を取得し、それを$defaultPath変数に格納しています。そして、取得したパスとその説明を画面に出力します。DEFAULT_INCLUDE_PATHの戻り値は文字列型であり、複数のディレクトリパスがコロン(UNIX系)またはセミコロン(Windows系)で区切られた形式で提供されます。

このパスは、include()require()といった関数を使って外部ファイルを読み込む際に、PHPがどのディレクトリを探すかの初期設定となります。もしこれらの関数でファイル名のみを指定した場合、PHPはこのDEFAULT_INCLUDE_PATHで指定されたディレクトリ群を順番に検索し、ファイルを見つけようとします。システムエンジニアを目指す方にとって、PHPがどのように外部ファイルをロードするかの基本的なメカニズムを理解するために重要な情報です。このコードを実行することで、ご自身のPHP環境におけるデフォルトのインクルードパスを簡単に確認できます。

DEFAULT_INCLUDE_PATHは、PHPがスクリプトなどを検索する際の初期設定パスであり、現在のインクルードパスとは異なる場合がある点に注意が必要です。現在のパスはget_include_path()関数で確認できます。この定数の値は固定されており、プログラム内で変更することはできません。もしインクルードパスを実行時に変更したい場合は、set_include_path()関数を使用するか、php.iniファイルで設定してください。include()require()でファイルを読み込む際は、意図しないファイルが実行されるのを防ぐため、適切なパスのみを設定し、セキュリティに十分配慮することが重要です。

関連コンテンツ