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

lstat関数は、指定されたファイルやディレクトリのメタデータ（属性情報）を取得する関数です。この関数は、ファイルサイズ、最終アクセス時刻、最終変更時刻、最終状態変更時刻、ファイルの所有者ID、グループID、ファイルのパーミッション、デバイスIDなど、ファイルシステムに関する詳細な情報を配列として返します。情報を取得したいファイルやディレクトリのパスを引数として指定し、成功した場合はこれらの情報を含む連想配列を返します。パスが存在しない、あるいはアクセス権がないなどの理由で情報の取得に失敗した場合はfalseを返します。

この関数の大きな特徴は、シンボリックリンク（別のファイルやディレクトリを指し示す特殊なファイル）に対して実行された場合です。lstat関数は、シンボリックリンクが指し示す先のファイルではなく、シンボリックリンクファイル自体の属性情報を返します。例えば、シンボリックリンクファイル自身のサイズ、最終更新時刻、パーミッションなどを確認したい場合にこの関数が利用されます。これは、stat()関数がシンボリックリンクの指す先のファイル情報を取得するのとは異なる挙動であり、シンボリックリンク自体の管理や、リンクファイルの状態を正確に把握する必要があるシステム管理のシナリオで特に重要となります。ファイルシステムの整合性を確認したり、特定のファイルタイプ（シンボリックリンク）の状態を詳細に調査したりする際に活用される、PHPにおけるファイル操作の基本的な関数の一つです。

lstat('/path/to/your/file_or_symlink');

string $filename

• string $filename: 統計情報を取得したいファイルまたはシンボリックリンクのパスを指定する文字列

array|false

lstat関数は、指定されたファイルのステータス情報を配列として返します。エラーが発生した場合はfalseを返します。