scandir
(PHP 5, PHP 7)
scandir — List files and directories inside the specified path
Description
$directory
[, int $sorting_order
= SCANDIR_SORT_ASCENDING
[, resource $context
]] ) : array
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 toSCANDIR_SORT_DESCENDING
, then the sort order is alphabetical in descending order. If it is set toSCANDIR_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 |
---|---|
5.4.0 |
sorting_order constants
were added. Any nonzero value caused descending order in previous versions. So
for all PHP versions, use 0 for ascending order, and 1
for descending order. An option for SCANDIR_SORT_NONE behavior did not
exist prior to PHP 5.4.0.
|
Examples
Example #1 A simple scandir() example
<?php
$dir = '/tmp';
$files1 = scandir($dir);
$files2 = scandir($dir, 1);
print_r($files1);
print_r($files2);
?>
The above example will output something similar to:
Array ( [0] => . [1] => .. [2] => bar.php [3] => foo.txt [4] => somedir ) Array ( [0] => somedir [1] => foo.txt [2] => bar.php [3] => .. [4] => . )
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 Supported Protocols and Wrappers for links to information about what abilities the various wrappers have, notes on their usage, and information on any predefined variables they may provide.
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-scandir.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.