PHP Filesystem fstat() Function

---

---

The PHP Filesystem fstat() function is used to return information about an open file. This function can get statistics of the file opened by file pointer handle. This function is just like the stat() function except that it can operate on an open file pointer instead of a filename.

Syntax

Below is the syntax of the PHP Filesystem fstat() function −

array fstat ( resource $handle )

Parameters

The parameters are needed to use the fstat() function are mentioned below −

Return Value

It returns an array with the statistics from the file, or FALSE on failure.

PHP Version

The fstat() function was first introduced as part of core PHP 4 and work well with the PHP 5, PHP 7, PHP 8.

Example

In this PHP code we will first open a file, retrieves the information about it using the PHP Filesystem fstat() function and then prints that information.

<?php
   $file = fopen("/PhpProject/sample.txt", "r");  
   
   //Use fstat() function
   print_r(fstat($file));
   fclose($file);
?>

Output

Here is the output of the above PHP code −

Array
(
    [0] => 1245376677
    [1] => 12666373952223775
    [2] => 33206
    [3] => 1
    [4] => 0
    [5] => 0
    [6] => 0
    [7] => 49
    [8] => 1590217956
    [9] => 1590994836
    [10] => 1590217956
    [11] => -1
    [12] => -1
    [dev] => 1245376677
    [ino] => 12666373952223775
    [mode] => 33206
    [nlink] => 1
    [uid] => 0
    [gid] => 0
    [rdev] => 0
    [size] => 49
    [atime] => 1590217956
    [mtime] => 1590994836
    [ctime] => 1590217956
    [blksize] => -1
    [blocks] => -1
)

Example

This example shows you how to get a file's size with the help of fstat() function.

<?php
    $file = fopen("/PhpProject/sample.txt", "r");
    $file_info = fstat($file);
    $file_size = $file_info['size'];
    echo "File size: $file_size bytes";
    fclose($file);
?> 

Output

This will produce the following result −

File size: 104 bytes

Example

This example shows you how to check a file's permissions using fstat() function.

<?php
    $file = fopen("/PhpProject/sample.txt", "r");
    $file_info = fstat($file);
    $permissions = $file_info['mode'] & 0777; // Get permissions
    echo "File permissions: $permissions";
    fclose($file);
?> 

Output

This will generate the below result −

File permissions: 644

Example

This example shows you how to use fstat() function to find a file's last access time.

<?php
    $file = fopen("/PhpProject/sample.txt", "r");
    $file_info = fstat($file);
    $last_access_time = $file_info['atime'];
    $last_access_readable = date("Y-m-d H:i:s", $last_access_time);
    echo "Last access time: $last_access_readable";
    fclose($file);
?> 

Output

This will lead to the following output −

Last access time: 2024-06-06 03:56:09

Summary

The PHP fstat() function gives information about a file, like its size and permissions. A file pointer resource, which is sometime obtained by using fopen() to open a file, is its parameter.