(PHP 4, PHP 5, PHP 7, PHP 8)

clearstatcacheОчищает кеш состояния файлов


clearstatcache(bool $clear_realpath_cache = false, string $filename = ""): void

Чтобы повысить производительность при вызове функций stat(), lstat() или любой другой функции из списка, который приводит эта страница, PHP кеширует результаты выполнения этих функций. Однако иногда требуется очистка этого кеша. Например, когда скрипт несколько раз проверяет состояние одного и того же файла, который может быть изменён или удалён во время выполнения скрипта, может потребоваться очистка кеша состояния. Тогда для очистки в PHP кешированной информации о файле вызывают функцию clearstatcache().

Обратите внимание, что PHP не кеширует информацию о несуществующих файлах. Поэтому, если вызывать функцию file_exists() на несуществующем файле, функция будет возвращать false до тех пор, пока вы не создадите этот файл. Если же вы создадите файл, функция будет возвращать true, даже если затем вы удалите файл. Однако функция unlink() очистит этот кеш автоматически.


Эта функция кеширует информацию об отдельных файлах, поэтому имеет смысл вызывать функцию clearstatcache(), только если вы совершаете несколько операций с одним и тем же файлом и не хотите получать кешированную информацию об этом файле.

Список функций, результаты выполнения которых кешируются: stat(), lstat(), file_exists(), is_writable(), is_readable(), is_executable(), is_file(), is_dir(), is_link(), filectime(), fileatime(), filemtime(), fileinode(), filegroup(), fileowner(), filesize(), filetype() и fileperms().

Список параметров


Нужно ли также очищать кеш realpath.


Очистить кеш realpath только для определённого имени файла; используется только в том случае, если у параметра clear_realpath_cache установлено значение true.

Возвращаемые значения

Функция не возвращает значения после выполнения.


Пример #1 Пример использования функции clearstatcache()


= 'output_log.txt';

$stat = stat($file);
$user = posix_getpwuid($stat['uid']);

$format = "UID @ %s: %s\n";

printf($format, date('r'), get_owner($file));

chown($file, 'ross');
printf($format, date('r'), get_owner($file));

printf($format, date('r'), get_owner($file));


Вывод приведённого примера будет похож на:

UID @ Sun, 12 Oct 2008 20:48:28 +0100: root
UID @ Sun, 12 Oct 2008 20:48:28 +0100: root
UID @ Sun, 12 Oct 2008 20:48:28 +0100: ross

add a note

User Contributed Notes 7 notes

vechenjivot at gmail dot com
3 years ago
Not documented, but seems like clearstatcache() is clearing the cache only for the process it is being called from. I have 2 PHP scripts running simultaneously, and the first one does call clearstatcache(), but still the second one deadlocks, unless I call clearstatcache() in it too:

clearstatcache(); // should be done by unlink?

while (is_file('system.lock') {
clearstatcache(); // without this, script 2 will deadlock forever!

I also found this page, which leads to the same conclusion:
msaladna at apisnetworks dot com
4 years ago
clearstatcache() does not canonicalize the path. clearstatcache(true, "/a/b/c") is different from clearstatcache(true, "/a/b//c").
matt_m at me dot com
12 years ago
unlink() does not clear the cache if you are performing file_exists() on a remote file like:

if (file_exists(""))

In this case, even after you unlink() successfully, you must call clearstatcache().


file_exists() then properly returns false.
David Spector
5 years ago
Note that this function affects only file metadata. However, all the PHP file system functions do their own caching of actual file contents as well. You can use the "realpath_cache_size = 0" directive in PHP.ini to disable the content caching if you like. The default content caching timeout is 120 seconds.

Content caching is not a good idea during development work and for certain kinds of applications, since your code may read in old data from a file whose contents you have just changed.

Note: This is separate from the caching typically done by browsers for all GET requests (the majority of Web accesses) unless the HTTP headers override it. It is also separate from optional Apache server caching.
bj at wjblack dot com
9 years ago
Just to make this more obvious (and so search engines find this easier):

If you do fileops of any kind outside of PHP (say via a system() call), you probably want to clear the stat cache before doing any further tests on the file/dir/whatever. For example:

// is_dir() forces a stat call, so the cache is populated
if( is_dir($foo) ) {
system("rm -rf " . escapeshellarg($foo));
is_dir($foo) ) {
// ...will still be true, even if the rm succeeded, because it's just
// reading from cache, not re-running the stat()

Pop a clearstatcache() after the system call and all is good (modulo a bit of a performance hit from having a cleared stat cache :-( ).
5 years ago
Definition of $filename parameter let's you think that it expects the filename only but it works if you give the path + filename also.

It should be more clear about this.
markandrewslade at gmail dot com
14 years ago
On Linux, a forked process inherits a copy of the parent's cache, but after forking the two caches do not impact each other. The snippet below demonstrates this by creating a child and confirming outdated (cached) information, then clearing the cache, and getting new information.


function report($directory, $prefix = '') { printf('%sDoes %s exist? PHP says "%s"'. PHP_EOL, $prefix, $directory, is_dir($directory) ? 'yes' : 'no'); }
$target = './delete-me-before-running-statcache';

if (
is_dir($target)) {
"Delete $target before running.\n");

"Creating $target.\n";
mkdir($target) || die("Unable to create $target.\n");
report($target); // is_dir($target) is now cached as true

echo "Unlinking $target.\n";
rmdir($target) || die("Unable to unlink $target.\n");

// This will say "yes", which is old (inaccurate) information.

if ((
$pid = pcntl_fork()) === -1) { die("Failed to pcntl_fork.\n"); }
elseif (
$pid === 0) {
// child
report($target, '<<child>> ');
"<<child>> Clearing stat cache.\n";
report($target, '<<child>> ');
} else {
// parent
sleep(2); // move this to the child block to reverse the test.
report($target, '<<<parent>> ');
report($target, '<<<parent>> ');

To Top