WP_Filesystem_Base::dirlist

Advertisement

Summery Summery

Gets details for files in a directory or a specific file.

Syntax Syntax

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

Parameters 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 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'
    (int) 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 $recursive is true, contains another array of files.

Source Source

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

	 * @param bool   $recursive      Optional. Whether to recursively include file details in nested directories.
	 *                               Default false.
	 * @return array|false {

Advertisement

Changelog Changelog

Changelog
Version Description
2.5.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.