What is the lstat() Function?

The lstat() function is a built-in PHP function that returns information about a symbolic link. This function takes a filename parameter that represents the symbolic link and returns information about it.

Here's the basic syntax of the lstat() function:


Where filename is the name of the symbolic link you want to get information about.

How to Use the lstat() Function?

Using the lstat() function is straightforward. Here are the steps to follow:

  1. Specify the name of the symbolic link you want to get information about.
  2. Call the lstat() function, passing in the symbolic link name as a parameter.

Here's an example code snippet that demonstrates how to use the lstat() function:


$link = '/path/to/symbolic/link';
$info = lstat($link);
echo "The link $link has a size of $info[7] bytes";

In this example, we use the lstat() function to get information about the symbolic link /path/to/symbolic/link. We then access the size of the link by referencing the seventh element of the array returned by the lstat() function.


The lstat() function is a useful tool in PHP for getting information about symbolic links on a file system. By following the steps outlined in this guide, you can easily use the lstat() function in your PHP projects to get information about symbolic links. We hope this guide has been helpful.

Practice Your Knowledge

What is the function of lstat() in PHP?

Quiz Time: Test Your Skills!

Ready to challenge what you've learned? Dive into our interactive quizzes for a deeper understanding and a fun way to reinforce your knowledge.

Do you find this helpful?