WordPress Developer Resources

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

$pathstringrequired: Path to directory or file.
$include_hiddenbooloptional: Whether to include details of hidden ("." prefixed) files.

Default:true
$recursivebooloptional: 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 array
Array of file information. Note that some elements may not be available on all filesystems.
- name string
  Name of the file or directory.
- perms string
  *nix representation of permissions.
- permsn string
  Octal representation of permissions.
- number int|string|false
  File number. May be a numeric string. False if not available.
- owner string|false
  Owner name or ID, or false if not available.
- group string|false
  File permissions group, or false if not available.
- size int|string|false
  Size of file in bytes. May be a numeric string.
  False if not available.
- lastmodunix int|string|false
  Last modified unix timestamp. May be a numeric string.
  False if not available.
- lastmod string|false
  Last modified month (3 letters) and day (without leading 0), or false if not available.
- time string|false
  Last modified time, or false if not available.
- type string
  Type of resource. 'f' for file, 'd' for directory, 'l' for link.
- files array|false
  If a directory and $recursive is true, contains another array of files. False if unable to list directory contents.

Source

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

View all references View on Trac View on GitHub

Changelog

Version	Description
2.5.0	Introduced.

User Contributed Notes

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