list_files( string $folder = '', int $levels = 100, string[] $exclusions = array() )

Returns a listing of all files in the specified folder and all subdirectories up to 100 levels deep.


Description Description

The depth of the recursiveness can be controlled by the $levels param.


Parameters Parameters

$folder

(string) (Optional) Full path to folder.

Default value: ''

$levels

(int) (Optional) Levels of folders to follow, Default 100 (PHP Loop limit).

Default value: 100

$exclusions

(string[]) (Optional) List of folders and files to skip.

Default value: array()


Top ↑

Return Return

(bool|string[]) False on failure, else array of files.


Top ↑

Source 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;
}

Top ↑

Changelog Changelog

Changelog
Version Description
4.9.0 Added the $exclusions parameter.
2.6.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.