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

(Required) Path to directory or file.

$include_hidden

(Optional) Whether to include details of hidden ("." prefixed) files.<br>

Default value: true

$recursive

(Optional) Whether to recursively include file details in nested directories.<br>

Default value: false

Return

(array|false) Array of files. False if unable to list directory contents.<br>

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

Source

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

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

Expand Source Code View on GitHub

Changelog

Changelog
Version Description
2.5.0 Introduced.