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
Return
array|false Array of arrays containing file information. False if unable to list directory contents.
0...
arrayArray of file information. Note that some elements may not be available on all filesystems.name
stringName of the file or directory.perms
string*nix representation of permissions.permsn
stringOctal representation of permissions.number
int|string|falseFile number. May be a numeric string. False if not available.owner
string|falseOwner name or ID, or false if not available.group
string|falseFile permissions group, or false if not available.size
int|string|falseSize of file in bytes. May be a numeric string.
False if not available.lastmodunix
int|string|falseLast modified unix timestamp. May be a numeric string.
False if not available.lastmod
string|falseLast modified month (3 letters) and day (without leading 0), or false if not available.time
string|falseLast modified time, or false if not available.type
stringType of resource.'f'
for file,'d'
for directory,'l'
for link.files
array|falseIf a directory and$recursive
is true, contains another array of files. False if unable to list directory contents.
Source
File:
wp-admin/includes/class-wp-filesystem-base.php
. View all referencespublic function dirlist( $path, $include_hidden = true, $recursive = false ) { return false; }
Changelog
Changelog Version Description 2.5.0 Introduced.
User Contributed Notes