WP_Filesystem_Base::dirlist() WordPress Method
The WP_Filesystem_Base::dirlist() method is used to list the contents of a directory. It takes two arguments: the directory to list and an optional array of options. The default options are 'recursive' => false, 'include_hidden' => true, and 'limit_depth' => 0.
WP_Filesystem_Base::dirlist( string $path, bool $include_hidden = true, bool $recursive = 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 value: true
- $recursive
(bool)(Optional) Whether to recursively include file details in nested directories.
Default value: false
Return
(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$recursiveis true, contains another array of files.
Source
File: wp-admin/includes/class-wp-filesystem-base.php
public function dirlist( $path, $include_hidden = true, $recursive = false ) {
return false;
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.5.0 | Introduced. |