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

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

Contents

Description

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

Top ↑

Parameters

$folder string Optional
Full path to folder.

Default: ''

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

Default: 100

$exclusions string[] Optional
List of folders and files to skip.

Default: array()

Top ↑

Return

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

Top ↑

Source

File: wp-admin/includes/file.php. View all references 

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

View on Trac View on GitHub

Top ↑

Top ↑

Uses

Uses
Uses Description
list_files() wp-admin/includes/file.php

Returns a listing of all files in the specified folder and all subdirectories up to 100 levels deep.
trailingslashit() wp-includes/formatting.php

Appends a trailing slash.

Top ↑

Changelog

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

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
    Contributed by sarankumar —

    Example for listing all files in the upload directory

    $upload_dir = wp_upload_dir();
$folder = $upload_dir['basedir']
$files = list_files( $folder, 2 );
foreach ( $files as $file ) {
	if ( is_file( $file ) ) {
		$filesize = size_format( filesize( $file ) );
		$filename = basename( $file ); 
	}
	echo esc_html( $filename . "-" . $filesize );
}
  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Philipp Stracker —

    This function returns a list of absolute paths (not file names!)

    print_r( list_files( __DIR__ ) );

/*
Output:

Array (
    [0] => /Users/philipp/Sites/public/dev-site/wp-content/plugins/test/test.php
    [1] => /Users/philipp/Sites/public/dev-site/wp-content/plugins/test/readme.txt
    [2] => /Users/philipp/Sites/public/dev-site/wp-content/plugins/test/license.txt
)
*/

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