PHP lstat() Function

❮ PHP Filesystem Reference

Example

Get information about a file:

<?php
print_r(lstat("test.txt"));
?>
Run Example »

Definition and Usage

The lstat() function returns information about a file or symbolic link.

Note: The results from this function will differ from server to server. The array may contain the number index, the name index, or both.

Note: The result of this function is cached. Use clearstatcache() to clear the cache.

Tip: This function is similar to stat(), except that if the filename parameter is a symbolic link, the status of the symbolic link is returned.

Syntax

lstat(filename)

Parameter Values

Parameter Description
filename Required. Specifies the path to the file or a symbolic link to check


Technical Details

Return Value:

An array with the following elements:

  • [0] or [dev] - Device number
  • [1] or [ino] - Inode number
  • [2] or [mode] - Inode protection mode
  • [3] or [nlink] - Number of links
  • [4] or [uid] - User ID of owner
  • [5] or [gid] - Group ID of owner
  • [6] or [rdev] - Inode device type
  • [7] or [size] - Size in bytes
  • [8] or [atime] - Last access (as Unix timestamp)
  • [9] or [mtime] - Last modified (as Unix timestamp)
  • [10] or [ctime] - Last inode change (as Unix timestamp)
  • [11] or [blksize] - Blocksize of filesystem IO (if supported)
  • [12] or [blocks] - Number of blocks allocated

It returns an E_WARNING on failure

PHP Version: 4.0+

❮ PHP Filesystem Reference
Copyright 1999-2023 by Refsnes Data. All Rights Reserved.