PHPのstat()関数とは？使い方と戻り値の詳細を解説

PHPのstat()関数は、指定したファイルに関するさまざまな情報を取得し、配列として返す関数です。ファイルサイズやアクセス日時、更新日時など、ファイル管理に役立つ情報を簡単に取得できます。

注意： stat()関数が返す結果は、実行環境やサーバーによって異なる場合があります。

stat()関数が返す配列の要素

stat()関数は、以下の要素を含む配列を返します。各要素には数値インデックスと文字列キーの両方でアクセス可能です。

• [0] または [dev] － デバイス番号
• [1] または [ino] － iノード番号
• [2] または [mode] － iノード保護モード（パーミッション）
• [3] または [nlink] － リンク数
• [4] または [uid] － 所有者のユーザーID
• [5] または [gid] － 所有者のグループID
• [6] または [rdev] － iノードのデバイスタイプ
• [7] または [size] － ファイルサイズ（バイト単位）
• [8] または [atime] － 最終アクセス時刻（Unixタイムスタンプ）
• [9] または [mtime] － 最終更新時刻（Unixタイムスタンプ）
• [10] または [ctime] － iノードの最終変更時刻（Unixタイムスタンプ）
• [11] または [blksize] － ファイルシステムIOのブロックサイズ
• [12] または [blocks] － 割り当てられたブロック数

構文

stat(ファイルパス)

パラメータ

• file_path － 情報を取得したいファイルへのパスを指定します。

戻り値

stat()関数は、上記の要素を含む配列を返します。処理に失敗した場合はfalseを返します。

使用例①：ファイル情報の一括取得

まず、ファイル「demo.txt」のすべての統計情報を取得する基本的な例を見てみましょう。

<?php
    print_r(stat("demo.txt"));
?>

出力結果

Array
(
[0] => 0
[1] => 0
[2] => 33206
[3] => 1
[4] => 0
[5] => 0
[6] => 0
[7] => 120
[8] => 17128173529
[9] => 1984185875
[10] => 1294322653
[11] => -1
[12] => -1
[dev] => 0
[ino] => 0
[mode] => 33206
[nlink] => 1
[uid] => 0
[gid] => 0
[rdev] => 0
[size] => 120
[atime] => 1718173529
[mtime] => 1984185875
[ctime] => 1294322653
[blksize] => -1
[blocks] => -1
)

使用例②：特定の情報だけを取り出す

次に、配列から必要な要素だけを取り出して表示する例を紹介します。

<?php
    $stat = stat('new.txt');
    echo 'File mode = ' .$stat['mode'];
    echo '<br />Last Modification time of the file = ' .$stat['mtime'];
?>

出力結果

File mode = 33206
Last Modification time of the file = 1241387935

このように、stat()関数を使えば「mode」や「mtime」などのキーを指定することで、必要なファイル情報だけを効率的に取得できます。Unixタイムスタンプで返される日時は、date()関数などと組み合わせることで、人間が読める形式に変換することも可能です。