【PHP8.x】getRealPathメソッドの使い方

getRealPathメソッドは、FilesystemIteratorオブジェクトが現在指しているファイルやディレクトリの、シンボリックリンクを解決した後の「実際のパス」を取得するメソッドです。

このメソッドは、PHPのファイルシステムを効率的に操作するためのFilesystemIteratorクラスに属しており、ディレクトリ内の項目を反復処理する際に、各項目に関する詳細な情報を取得するのに利用されます。通常のパス情報では、ファイルやディレクトリがシンボリックリンク（ショートカットのようなもの）を通じて参照されている場合がありますが、getRealPathメソッドを使用することで、そのシンボリックリンクが最終的に指している先の、物理的に存在するファイルやディレクトリの絶対パスを正確に取得できます。

これにより、アプリケーションが処理するファイルの実体を確実に特定したり、多層的に存在するシンボリックリンクを経由しても最終的な参照先を正確に知る必要があるケースで非常に有用です。例えば、ファイルの読み書きやセキュリティ関連の処理において、意図しない場所へのアクセスを防ぎ、処理の一貫性を保つことが可能になります。

メソッドが成功した場合、解決された実際のパスが文字列として返されます。しかし、もし指定されたファイルやディレクトリが存在しない場合、あるいはパスの解決に失敗した場合は、falseが返されます。そのため、このメソッドを利用する際には、戻り値がfalseでないことを適切に確認し、エラーハンドリングを行うことが重要です。FilesystemIteratorは内部的にSplFileInfoオブジェクトを利用しており、このgetRealPathメソッドもそのSplFileInfoオブジェクトの同名メソッドと同じ機能を提供しています。

Copy
1<?php
2
3$iterator = new FilesystemIterator(__DIR__);
4
5foreach ($iterator as $fileInfo) {
6    $realPath = $fileInfo->getRealPath();
7    break;
8}

引数なし

引数はありません

string|false

指定されたパスの正規化された絶対パスを文字列で返します。ファイルが存在しない場合は false を返します。