Home/ Manual/ dir / functions/ scandir

scandir

PHP function Edit on GitHub ✎

(PHP 5, PHP 7, PHP 8)

List files and directories inside the specified path

Description

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.

Changelog

Version	Description
8.0.0	`context` is now nullable.

Examples

A simple scandir() example

php

<?php
$dir    = '/tmp';
$files1 = scandir($dir);
$files2 = scandir($dir, SCANDIR_SORT_DESCENDING);

print_r($files1);
print_r($files2);
?>

The above example will output something similar to:

output

Array
(
    [0] => .
    [1] => ..
    [2] => bar.php
    [3] => foo.txt
    [4] => somedir
)
Array
(
    [0] => somedir
    [1] => foo.txt
    [2] => bar.php
    [3] => ..
    [4] => .
)