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

stream_resolve_include_path関数は、include_pathを検索して、指定されたファイル名への絶対パスを解決する関数です。具体的には、PHPの設定ファイル(php.ini)で設定されているinclude_pathディレクティブに登録されているディレクトリを順番に検索し、指定されたファイルが存在するかどうかを確認します。ファイルが見つかった場合、そのファイルの絶対パスを文字列として返します。ファイルが見つからなかった場合は、falseを返します。

この関数は、includeやrequireなどのファイルインクルード関数で使用されるパス解決処理を、明示的に実行するために利用できます。例えば、特定のファイルがinclude_path上のどこに存在するかを事前に確認したり、include_pathの設定に基づいてファイルの絶対パスを動的に決定したりする場合に役立ちます。

関数の引数には、解決したいファイル名を文字列で指定します。このファイル名には、ディレクトリを含めることも可能です。ただし、ファイル名が既に絶対パスである場合、この関数はパスの解決を試みず、そのままのパスを返します。

戻り値は、ファイルが見つかった場合はそのファイルの絶対パスを表す文字列、見つからなかった場合はfalseです。この関数を使用する際には、返り値がfalseでないかどうかを確認し、ファイルが存在することを確認してからファイル操作を行うようにすることで、エラーを回避できます。

<?php

$resolvedPath = stream_resolve_include_path("filename.php");

?>

string $filename

• string $filename: include_path で指定されたディレクトリから検索するファイル名を指定する文字列

string|false

指定されたファイルパスを、PHPの include_path 設定で検索し、最初に見つかったファイルの絶対パスを文字列として返します。ファイルが見つからなかった場合は false を返します。