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:
- The given directory is opened.
- The two properties handle and path of dir() are available.
- 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.
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:
- A NULL value is returned if the dir() is passed with wrong parameters.
- The order in which directory entries are returned by the read method is system-dependent.
Below programs illustrate the dir() function:
File Name: gfg.jpg File Name: .. File Name: gfg.pdf File Name: . File Name: gfg.txt
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