PHPのlstat()関数とは？使い方と戻り値をわかりやすく解説

PHPのlstat()関数は、指定したファイルまたはシンボリックリンクに関する情報を取得するための関数です。stat()関数とよく似ていますが、最大の違いは、引数にシンボリックリンクを指定した場合、リンク先の実体ではなくリンク自体の状態を返すという点にあります。

この関数は、以下の要素を含む配列を返します。

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

なお、返される配列には数値インデックスと文字列キーの両方が含まれるため、どちらの形式でも値にアクセスできます。

構文

lstat(file_path)

パラメータ

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

戻り値

上記の要素を含む連想配列・数値添字配列を返します。エラーが発生した場合は false を返します。

使用例

<?php
    print_r(lstat("new.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
)

まとめ

lstat()は、シンボリックリンクそのものの情報を取得したい場合に便利な関数です。通常のファイル情報を取得する場合はstat()、ファイルサイズだけが必要な場合はfilesize()など、目的に応じて使い分けるとよいでしょう。