array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'function.dir.php', 1 => 'dir', ), 'up' => array ( 0 => 'ref.dir.php', 1 => 'Directory Functions', ), 'prev' => array ( 0 => 'function.closedir.php', 1 => 'closedir', ), 'next' => array ( 0 => 'function.getcwd.php', 1 => 'getcwd', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/dir/functions/dir.xml', ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); ?>
(PHP 4, PHP 5, PHP 7, PHP 8)
dir — Return an instance of the Directory class
A pseudo-object-oriented mechanism for reading a directory. The
given directory
is opened.
directory
Directory to open
context
Version | Description |
---|---|
8.0.0 |
context is now nullable.
|
Example #1 dir() example
Please note the fashion in which Directory::read()'s
return value is checked in the example below. We are explicitly
testing whether the return value is identical to (equal to and of
the same type as - see
Comparison Operators for more information) false
since
otherwise, any directory entry whose name evaluates to false
will
stop the loop.
<?php
$d = dir("/etc/php5");
echo "Handle: " . $d->handle . "\n";
echo "Path: " . $d->path . "\n";
while (false !== ($entry = $d->read())) {
echo $entry."\n";
}
$d->close();
?>
The above example will output something similar to:
Handle: Resource id #2 Path: /etc/php5 . .. apache cgi cli
Note:
The order in which directory entries are returned by the read method is system-dependent.