list_files( string $folder = '', int $levels = 100, array $exclusions = array() )
Returns a listing of all files in the specified folder and all subdirectories up to 100 levels deep.
Description
The depth of the recursiveness can be controlled by the $levels param.
Parameters
- $folder
-
(Optional) Full path to folder.
Default value: ''
- $levels
-
(Optional) Levels of folders to follow, Default 100 (PHP Loop limit).
Default value: 100
- $exclusions
-
(Optional) List of folders and files to skip.
Default value: array()
Return
(bool|array) False on failure, Else array of files
Source
File: wp-admin/includes/file.php
function list_files( $folder = '', $levels = 100, $exclusions = array() ) {
if ( empty( $folder ) ) {
return false;
}
$folder = trailingslashit( $folder );
if ( ! $levels ) {
return false;
}
$files = array();
$dir = @opendir( $folder );
if ( $dir ) {
while ( ( $file = readdir( $dir ) ) !== false ) {
// Skip current and parent folder links.
if ( in_array( $file, array( '.', '..' ), true ) ) {
continue;
}
// Skip hidden and excluded files.
if ( '.' === $file[0] || in_array( $file, $exclusions, true ) ) {
continue;
}
if ( is_dir( $folder . $file ) ) {
$files2 = list_files( $folder . $file, $levels - 1 );
if ( $files2 ) {
$files = array_merge($files, $files2 );
} else {
$files[] = $folder . $file . '/';
}
} else {
$files[] = $folder . $file;
}
}
}
@closedir( $dir );
return $files;
}
Changelog
Version | Description |
---|---|
WP-4.9.0 | Added the $exclusions parameter. |
WP-2.6.0 | Introduced. |