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

stat関数はファイルやディレクトリに関する詳細な情報を取得する関数です。この関数は、指定されたファイルまたはディレクトリのメタデータ（属性情報）を配列として返します。取得できる情報には、ファイルのサイズ、パーミッション（読み書き実行権限）、ファイルの所有者IDやグループID、最終アクセス時刻、最終更新時刻などが含まれます。これらの情報は、システム管理やセキュリティ関連の処理、例えばファイルの存在確認、アクセス権の検証、更新日時の取得などに利用されます。

第一引数には、情報を取得したいファイルまたはディレクトリのパスを指定します。この関数が返す配列は、数値添字と連想配列の2つの形式で情報を提供します。特に連想配列のキー名（例: 'size'、'mode'）を使用すると、必要な情報に直感的にアクセスできるため、コードの可読性が向上します。

例えば、Webアプリケーションでユーザーがアップロードしたファイルのサイズを確認したり、特定のログファイルの最終更新日時を監視したりする際に非常に役立ちます。この関数を使うことで、ファイルシステムの低レベルな情報を効率的に取得し、アプリケーションの要件に応じた柔軟なファイル操作を実現できます。初心者の方も、ファイルの情報を取得する基本的な手段として覚えておくと良いでしょう。

$filename = 'path/to/file.txt';
$file_stats = stat($filename);

string $filename

• string $filename: ファイルのパスを指定する文字列

array|false

stat 関数は、指定されたファイルのステータス情報を格納した連想配列を返します。ファイルが存在しない場合やアクセス権がない場合は false を返します。