scandir

PHP 5, PHP 7, PHP 8
scandir - List files and directories inside the specified path
Manual
Code Examples

scandir(
     string$directory,
     [int$sorting_order = SCANDIR_SORT_ASCENDING],
     [resource|null$context = null]
): array|false

Returns an array of files and directories from the directory.

Parameters

directory

The directory that will be scanned.

sorting_order

By default, the sorted order is alphabetical in ascending order. If the optional sorting_order is set to SCANDIR_SORT_DESCENDING, then the sort order is alphabetical in descending order. If it is set to SCANDIR_SORT_NONE then the result is unsorted.

context

For a description of the context parameter, refer to the streams section of the manual.

Return Values

Returns an array of filenames on success, or false on failure. If directory is not a directory, then boolean false is returned, and an error of level E_WARNING is generated.

Notes

A URL can be used as a filename with this function if the fopen wrappers have been enabled. See fopen for more details on how to specify the filename. See the for links to information about what abilities the various wrappers have, notes on their usage, and information on any predefined variables they may provide.

Changelog

Version Description
8.0.0 context is now nullable.

Related Functions

Example of scandir

Show all examples for scandir

PHP Version:


Function scandir:

Directories Functions

Most used PHP functions