fstat()

fstat() — Gets information about a file using an open file pointer.

Built-in function of PHP 8.5. The manual lists it as available in PHP 4, PHP 5, PHP 7, PHP 8. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.

What it does

Gathers the statistics of the file opened by the file pointer stream. This function is similar to the stat() function except that it operates on an open file pointer instead of a filename.

Signature

fstat(resource $stream): array|false

Parameters

ParameterTypeWhat it takes
$streamresourceA file system pointer resource that is typically created using fopen().

Return value

Returns an array with the statistics of the file; the format of the array is described in detail on the stat() manual page. Returns false on failure.

Example

A runnable snippet:

// open a file $fp = fopen("/etc/passwd", "r"); // gather statistics $fstat = fstat($fp); // close the file fclose($fp); // print only the associative part print_r(array_slice($fstat, 13));

Output:

Array ( [dev] => 771 [ino] => 488704 [mode] => 33188 [nlink] => 1 [uid] => 0 [gid] => 0 [rdev] => 0 [size] => 1114 [atime] => 1061067181 [mtime] => 1056136526 [ctime] => 1056136526 [blksize] => 4096 [blocks] => 8 )

All PHP 8.5 built-in functions

Reference card built from the PHP manual page fstat() (PHP documentation, CC BY 3.0). The page is generated from the manual, so the wording of the parameter and return value text follows php.net.