readdir

Read entry from directory handle (PHP 4, PHP 5)
string readdir ( resource dir_handle )

Returns the filename of the next file from the directory. The filenames are returned in the order in which they are stored by the filesystem.

Parameters

dir_handle: The directory handle resource previously opened with opendir().

Return Values

Returns the filename on success, or FALSE on failure.

Warning:

This function may return Boolean FALSE, but may also return a non-Boolean value which evaluates to FALSE, such as 0 or "". Please read the section on Booleans for more information. Use the === operator for testing the return value of this function.

Examples

Example 508. List all files in a directory

Please note the fashion in which readdir()'s return value is checked in the examples 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 (e.g. a directory named "0").

copy to clipboard

<?php
// Note that !== did not exist until 4.0.0-RC2

if ($handle = opendir('/path/to/files')) {

    echo "Directory handle: $handle\n";

    echo "Files:\n";


    /* This is the correct way to loop over the directory. */

    while (false !== ($file = readdir($handle))) {

        echo "$file\n";

    }


    /* This is the WRONG way to loop over the directory. */

    while ($file = readdir($handle)) {

        echo "$file\n";

    }


    closedir($handle);

}
?>

Example 509. List all files in the current directory and strip out . and ..

copy to clipboard

<?php
if ($handle = opendir('.')) {

    while (false !== ($file = readdir($handle))) {

        if ($file != "." && $file != "..") {

            echo "$file\n";

        }

    }

    closedir($handle);

}
?>

See Also

is_dir()

glob()

Related Examples ( Source code ) » readdir

Code Examples / Notes » readdir

The following code is a bit nasty, it can be used to remove all files generated by apache. You're not a root user on a system, but you sometimes need to remove all files generated by apache in a certain directory. You may use this after replacing 'bbs' at the bottom with 'directory' you want. It tries to remove all files in a directory, but it can't unless it has an ownership. it doesn't check the ownership or permission. <?php function remove($dirname = '.') { if (is_dir($dirname)) { echo "$dirname is a directory.<br />"; if ($handle = @opendir($dirname)) { while (($file = readdir($handle)) !== false) { if ($file != "." && $file != "..") { echo "$file<br />"; $fullpath = $dirname . '/' . $file; if (is_dir($fullpath)) { remove($fullpath); @rmdir($fullpath); } else { @unlink($fullpath); } } } closedir($handle); } } } remove('bbs'); ?>

Responding to: johan dot mickelin at gmail dot com 31-May-2007 07:52 ------------------------------------------------------- If you want to list only a certain filetype, this case only jpg and gif files in an image directory $dir = opendir ("../images"); while (false !== ($file = readdir($dir))) { if (strpos($file, '.gif',1)||strpos($file, '.jpg',1) ) { echo "$file <br />"; } } ----------------------------------------------------------------- This function would also echo files that have .gif or .jpg in their names such as myFile.gif.php (I don't know why I'd name a file like that, but I am just making a point, that's all folks!) Perhaps a more exact way is to do the following: ... while (false !== ($file = readdir($dir))) { $lenOfFileName = strlen($file); $extOffsetPos = $lenOfFileName - 5; if (strpos($file, '.gif', $extOffsetPos) || strpos($file, '.jpg',$extOffsetPos) ) { echo "$file <br />"; } ... If your extensions are more than three letters, then increase the 5 to 6 (e.g. aspx) to 7 (e.g. php51) or whatever.

Passing $arFiles by reference, the getFiles function will return all jpeg, gif, and png images in a given directory and its subdirectories in a two dimensional array. <?php $startPath='.'; getFiles($startPath, &$arFiles); sort($arFiles); //produces desired result in PHP v4.4.4; other versions may not. //$arFiles[INDEX][0] the full directory in which the file is found //$arFiles[INDEX][1] the filename. //path and filename = $arFiles[INDEX][0].'/'.$arFiles[INDEX][1] foreach($arFiles as $val) //the line below will display the picture. echo '<img src="'.str_replace('.', '', $val[0]).'/'.urlencode($val[1]).'"> '; //the commented line below will show the path to the picture. //echo $val[0].'/'.urlencode($val[1]).' '; //I use another PHP script to resize pictures to a common size on the fly, //then use a more complicated version of this script to place resized images into an HTML table //echo '<img src=resize.php?pic="'.str_replace('.', '', $val[0]).'/'.urlencode($val[1]).'"> '; function getFiles($dir, $arFiles) { $imgFiles=opendir($dir); while($aFile=readdir($imgFiles) ) if(is_dir($dir.'/'.$aFile) && ereg('[^\.]', $aFile)) getFiles($dir.'/'.$aFile, &$arFiles); else if(eregi('.*\.jpg|.*\.jpeg|.*\.gif|.*\.png', $aFile)) $arFiles[]=array($dir, $aFile); } ?>

Here is an updated version of preg_find() [which has been linked from the glob() man page for years] - this function should provide most of what you want back from reading files, directories, different sorting methods, recursion, and perhaps most powerful of all the ability to pattern match with a PCRE regex. You can get preg_find here: http://www.pgregg.com/projects/php/preg_find/preg_find.php.txt or if you prefer colourful .phps format: http://www.pgregg.com/projects/php/preg_find/preg_find.phps or scoll down to the end of this note. I wrote several examples on how to use it on my blog at: http://www.pgregg.com/forums/viewtopic.php?tid=73 simple glob() type replacement: $files = preg_find('/./', $dir); recursive? $files = preg_find('/./', $dir, PREG_FIND_RECURSIVE); pattern match? find all .php files: $files = preg_find('/\.php$/D', $dir, PREG_FIND_RECURSIVE); sorted alphabetically? $files = preg_find('/\.php$/D', $dir, PREG_FIND_RECURSIVE|PREG_FIND_SORTKEYS); sorted in by filesize, in descending order? $files = preg_find('/./', $dir, PREG_FIND_RECURSIVE|PREG_FIND_RETURNASSOC |PREG_FIND_SORTFILESIZE|PREG_FIND_SORTDESC); $files=array_keys($files); sorted by date modified? $files = preg_find('/./', $dir, PREG_FIND_RECURSIVE|PREG_FIND_RETURNASSOC |PREG_FIND_SORTMODIFIED); $files=array_keys($files); Ok, the PHP note says my note is too long, so please click on one of the above links to get it.

<?php // Sample function to recursively return all files within a directory. // http://www.pgregg.com/projects/php/code/recursive_readdir.phps Function listdir($start_dir='.') { $files = array(); if (is_dir($start_dir)) { $fh = opendir($start_dir); while (($file = readdir($fh)) !== false) { # loop through the files, skipping . and .., and recursing if necessary if (strcmp($file, '.')==0 || strcmp($file, '..')==0) continue; $filepath = $start_dir . '/' . $file; if ( is_dir($filepath) ) $files = array_merge($files, listdir($filepath)); else array_push($files, $filepath); } closedir($fh); } else { # false if the function was called with an invalid non-directory argument $files = false; } return $files; } $files = listdir('.'); print_r($files); ?>

readdir

Read entry from directory handle (PHP 4, PHP 5) string readdir ( resource dir_handle )

Parameters

Return Values

Examples

Example 508. List all files in a directory

Example 509. List all files in the current directory and strip out . and ..

Related Examples ( Source code ) » readdir

Code Examples / Notes » readdir

Change Language

Read entry from directory handle (PHP 4, PHP 5)
string readdir ( resource dir_handle )