PHPのclearstatcache()関数の使い方とファイルステータスキャッシュのクリア方法

clearstatcache()関数とは

PHPのclearstatcache()関数は、ファイルステータスキャッシュをクリアするために使用される関数です。

PHPではパフォーマンス向上のため、以下の関数が返す情報（ファイルに関する統計情報）がキャッシュされます。

• stat()
• lstat()
• file_exists()
• is_writable()
• is_readable()
• is_executable()
• is_file()
• is_dir()
• filegroup()
• fileowner()
• filesize()
• filetype()
• fileperms()

なぜキャッシュのクリアが必要か

PHPは上記の関数によるファイル情報へのアクセスを高速化するため、結果をキャッシュします。しかし、スクリプトの実行中に同じファイルに対して複数回操作を行い、その間にファイルの状態（サイズや存在有無など）が変化した場合、キャッシュされた古い情報が返されてしまう可能性があります。そのようなケースでは、clearstatcache()を呼び出してキャッシュをクリアすることで、最新の正確なファイル情報を取得できます。

構文

void clearstatcache ([ bool $clear_realpath_cache = false [, string $filename ]] )

引数を指定せずに呼び出した場合は、すべてのファイルステータスキャッシュがクリアされます。PHP 5.3.0以降では、第1引数にtrueを渡すことでrealpathキャッシュのみをクリアし、第2引数で特定のファイル名を指定して対象を限定することも可能です。

パラメータ

• $clear_realpath_cache（省略可）：realpathキャッシュをクリアするかどうかを示す真偽値。デフォルトはfalse。
• $filename（省略可）：realpathキャッシュをクリア対象とするファイル名。

戻り値

clearstatcache()関数は値を返しません（void型）。

使用例

以下は、ファイル「tmp.txt」の存在を確認し、キャッシュをクリアする例です。

<?php
    $file = fopen("tmp.txt", "a+");

    // ファイルサイズを確認
    echo "ファイルサイズ: " . filesize("tmp.txt") . " バイト";

    // キャッシュをクリア
    clearstatcache();

    echo "キャッシュをクリアしました！";
?>

出力

キャッシュをクリアしました！

まとめ

clearstatcache()関数は、PHPが内部的に保持するファイルステータスのキャッシュを削除するシンプルな関数です。同一スクリプト内でファイルの内容や属性を変更した後に、再度ファイル情報を取得する必要がある場合に活用すると、常に最新の正確なデータを扱うことができます。