wpseek.com
A WordPress-centric search engine for devs and theme authors



list_files › WordPress Function

Since2.6.0
Deprecatedn/a
› list_files ( $folder = '', $levels = 100, $exclusions = array(), $include_hidden = false )
Parameters: (4)
  • (string) $folder Optional. Full path to folder. Default empty.
    Required: No
    Default: (empty)
  • (int) $levels Optional. Levels of folders to follow, Default 100 (PHP Loop limit).
    Required: No
    Default: 100
  • (string[]) $exclusions Optional. List of folders and files to skip.
    Required: No
    Default: array()
  • (bool) $include_hidden Optional. Whether to include details of hidden ("." prefixed) files. Default false.
    Required: No
    Default: false
Returns:
  • (string[]|false) Array of files on success, false on failure.
Defined at:
Codex:
Change Log:
  • 4.9.0
  • 6.3.0

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

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


Related Functions: wp_list_filter, validate_file, wp_list_widgets, list_meta, list_cats

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