PHP | dir() Function

The dir() function in PHP is an inbuilt function which is used to return an instance of the Directory class. The dir() function is used to read a directory, which includes the following:

  1. The given directory is opened.
  2. The two properties handle and path of dir() are available.
  3. Both handle and path properties have three methods: read(), rewind(), and close().

The path of the directory is sent as a parameter to the opendir() function and it returns an instance of the Directory class on success, or FALSE on failure.

Syntax:

dir($directory, $context)

Parameters Used: The dir() function in PHP accepts two parameters as described below.

  • $directory: It is a mandatory parameter which specifies the path of the directory.
  • $context: It is an optional parameter which specifies the behavior of the stream.

Return Value: It returns an instance of the Directory class on success, or FALSE on failure.

Errors And Exceptions:

  1. A NULL value is returned if the dir() is passed with wrong parameters.
  2. The order in which directory entries are returned by the read method is system-dependent.

Below programs illustrate the dir() function:

Program 1:

filter_none

edit
close

play_arrow

link
brightness_4
code

<?php
  
$dir_handle = dir("user/gfg");
  
while(($file_name = $dirhandle->read()) !== false) 
    echo("File Name : " . $file_name);
    echo "<br>"
}
  
?>

chevron_right


Output:

File Name: gfg.jpg
File Name: ..
File Name: gfg.pdf
File Name: .
File Name: gfg.txt

Program 2:

filter_none

edit
close

play_arrow

link
brightness_4
code

<?php
  
$dir_handle = dir("user/gfg");
  
echo("Directory Path: " . $dir_handle->path . "<br>");
  
echo("Directory Handler ID: " . $dir_handle->handle . "<br>");
  
while(($file_name = $dir_handle->read()) !== false) 
   echo("File Name: " . $file_name);
   echo "<br>"
  
$dir_handle->close();
  
?>

chevron_right


Output:

Directory Path: user/gfg
Directory Handler ID: Resource id #2

File Name: gfg.jpg
File Name: ..
File Name: gfg.pdf
File Name: .
File Name: gfg.txt

Reference: http://php.net/manual/en/function.dir.php



My Personal Notes arrow_drop_up

I am a technology enthusiast who has a keen interest in programming I am pursuing Engineering in Computer Science from GEU, Dehradun I like to unwind by watching movies and English sitcomsI have a keen interest in music

If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.

Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.




Article Tags :
Practice Tags :


Be the First to upvote.


Please write to us at contribute@geeksforgeeks.org to report any issue with the above content.