On this page
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
$pathstring Required-
Path to directory or file.
$include_hiddenbool Optional-
Whether to include details of hidden ("." prefixed) files.
Default:
true $recursivebool Optional-
Whether to recursively include file details in nested directories.
Default:
false
Return
array|false Array of files. False if unable to list directory contents.
namestringName of the file or directory.permsstring*nix representation of permissions.permsnstringOctal representation of permissions.ownerstringOwner name or ID.sizeintSize of file in bytes.lastmodunixintLast modified unix timestamp.lastmodmixedLast modified month (3 letter) and day (without leading 0).timeintLast modified time.typestringType of resource.'f'for file,'d'for directory.filesmixedIf a directory and$recursiveis true, contains another array of files.
Source
File: wp-admin/includes/class-wp-filesystem-base.php. View all references
public function dirlist( $path, $include_hidden = true, $recursive = false ) {
return false;
}
Related
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. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_filesystem_base/dirlist