PHP Manual: Open directory handle

Description

resourcefalse opendir(string $directory, resourcenull $context = null)

Opens up a directory handle to be used in subsequent closedir, readdir, and rewinddir calls.

Parameters

directory: The directory path that is to be opened
context: For a description of the context parameter, refer to the streams section of the manual.

Return Values

Returns a directory handle resource on success, or false on failure

Errors/Exceptions

Upon failure, an E_WARNING is emitted.

This may happen if directory is not a valid directory, the directory can not be opened due to permission restrictions, or due to filesystem errors.

Changelog

Version	Description
8.0.0	`context` is now nullable.

Examples

Example #1 opendir example

<?php
$dir = "/etc/php5/";

// Open a known directory, and proceed to read its contents
if (is_dir($dir)) {
    if ($dh = opendir($dir)) {
        while (($file = readdir($dh)) !== false) {
            echo "filename: $file : filetype: " . filetype($dir . $file) . "\n";
        }
        closedir($dh);
    }
}
?>

The above example will output something similar to:

filename: . : filetype: dir
filename: .. : filetype: dir
filename: apache : filetype: dir
filename: cgi : filetype: dir
filename: cli : filetype: dir

opendir