W3cubDocs

/WordPress

list_files( string $folder = , int $levels = 100, string[] $exclusions = array(), bool $include_hidden = false ): string[]|false

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

$folderstringoptional
Full path to folder.

Default:''

$levelsintoptional
Levels of folders to follow, Default 100 (PHP Loop limit).

Default:100

$exclusionsstring[]optional
List of folders and files to skip.

Default:array()

$include_hiddenbooloptional
Whether to include details of hidden ("." prefixed) files.

Default:false

Return

string[]|false Array of files on success, false on failure.

Source

function list_files( $folder = '', $levels = 100, $exclusions = array(), $include_hidden = false ) {
	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 ( ( ! $include_hidden && '.' === $file[0] ) || in_array( $file, $exclusions, true ) ) {
				continue;
			}

			if ( is_dir( $folder . $file ) ) {
				$files2 = list_files( $folder . $file, $levels - 1, array(), $include_hidden );
				if ( $files2 ) {
					$files = array_merge( $files, $files2 );
				} else {
					$files[] = $folder . $file . '/';
				}
			} else {
				$files[] = $folder . $file;
			}
		}

		closedir( $dir );
	}

	return $files;
}

Changelog

Version Description
6.3.0 Added the $include_hidden parameter.
4.9.0 Added the $exclusions parameter.
2.6.0 Introduced.

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/list_files