WP_Filesystem_Base::dirlist( string $path, bool $include_hidden = true, bool $recursive = false ): array|false

Parameters

$pathstring

Path to directory or file.

$include_hiddenbooloptional

Whether to include details of hidden ("." prefixed) files. Default true.Default: true

$recursivebooloptional

Whether to recursively include file details in nested directories. Default false.Default: false

Return

array|false

Array of arrays containing file information. False if unable to list directory contents.

• ...$0array

  Array of file information. Note that some elements may not be available on all filesystems.

  • $namestring

    Name of the file or directory.

  • $permsstring

    *nix representation of permissions.

  • $permsnstring

    Octal representation of permissions.

  • $numberint|string|false

    File number. May be a numeric string. False if not available.

  • $ownerstring|false

    Owner name or ID, or false if not available.

  • $groupstring|false

    File permissions group, or false if not available.

  • $sizeint|string|false

    Size of file in bytes. May be a numeric string. False if not available.

  • $lastmodunixint|string|false

    Last modified unix timestamp. May be a numeric string. False if not available.

  • $lastmodstring|false

    Last modified month (3 letters) and day (without leading 0), or false if not available.

  • $timestring|false

    Last modified time, or false if not available.

  • $typestring

    Type of resource. 'f' for file, 'd' for directory, 'l' for link.

  • $filesarray|false

    If a directory and $recursive is true, contains another array of files. False if unable to list directory contents.

Used by · 1

• WP_Filesystem_Base::search_for_folder()Locates a folder on the remote filesystem.

Source

View on Trac ↗View on GitHub ↗

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

History

Introduced in 2.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-admin/includes/class-wp-filesystem-base.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.