WP_Filesystem_Base::dirlist( string $path, bool $include_hidden = true, bool $recursive = false ): array|false

Gets details for files in a directory or a specific file.

Parameters

$path string Required: Path to directory or file.
$include_hidden bool Optional: Whether to include details of hidden ("." prefixed) files.

Default: true
$recursive bool Optional: Whether to recursively include file details in nested directories.

Default: false

array|false Array of files. False if unable to list directory contents.

name string
Name of the file or directory.
perms string
*nix representation of permissions.
permsn string
Octal representation of permissions.
owner string
Owner name or ID.
size int
Size of file in bytes.
lastmodunix int
Last modified unix timestamp.
lastmod mixed
Last modified month (3 letter) and day (without leading 0).
time int
Last modified time.
type string
Type of resource. 'f' for file, 'd' for directory.
files mixed
If a directory and $recursive is true, contains another array of files.

File: wp-admin/includes/class-wp-filesystem-base.php. View all references

public function dirlist( $path, $include_hidden = true, $recursive = false ) {
	return false;
}

Used By
Used By	Description
WP_Filesystem_Base::search_for_folder() wp-admin/includes/class-wp-filesystem-base.php	Locates a folder on the remote filesystem.

Changelog
Version	Description
2.5.0	Introduced.

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