PHP dir() Function Returns a Directory Class Instance

The dir() function provides an object‑oriented way to access a directory in PHP. It opens the directory specified by the directory argument and optionally accepts a context resource (available since PHP 5.0.0).

Parameters

directory : The path of the directory to be opened.

context : (optional) A context resource for stream operations.

Return value

On success, returns an instance of the Directory class.

On parameter error, returns NULL.

On other errors, returns FALSE.

Example

<?php
$d = dir("/etc/php5");

echo "Handle: " . $d->handle . "
";
echo "Path: " . $d->path . "
";

while (false !== ($entry = $d->read())) {
    echo $entry . "
";
}

$d->close();
?>

Output

Handle: Resource id #2
Path: /etc/php5
.
..
apache
cgi
cli

This example demonstrates creating a Directory object for /etc/php5, printing its handle and path, iterating over all entries, and finally closing the directory handle.