WP_Filesystem_FTPext::dirlist( string $path = '.', bool $include_hidden = true, bool $recursive = false )

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

Parameters

$path

(string) (Optional) Path to directory or file.

Default value: '.'

$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'
    (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

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

public function dirlist( $path = '.', $include_hidden = true, $recursive = false ) {
		if ( $this->is_file( $path ) ) {
			$limit_file = basename( $path );
			$path       = dirname( $path ) . '/';
		} else {
			$limit_file = false;
		}

		$pwd = ftp_pwd( $this->link );

		if ( ! @ftp_chdir( $this->link, $path ) ) { // Can't change to folder = folder doesn't exist.
			return false;
		}

		$list = ftp_rawlist( $this->link, '-a', false );

		@ftp_chdir( $this->link, $pwd );

		if ( empty( $list ) ) { // Empty array = non-existent folder (real folder will show . at least).
			return false;
		}

		$dirlist = array();

		foreach ( $list as $k => $v ) {
			$entry = $this->parselisting( $v );

			if ( empty( $entry ) ) {
				continue;
			}

			if ( '.' === $entry['name'] || '..' === $entry['name'] ) {
				continue;
			}

			if ( ! $include_hidden && '.' === $entry['name'][0] ) {
				continue;
			}

			if ( $limit_file && $entry['name'] !== $limit_file ) {
				continue;
			}

			$dirlist[ $entry['name'] ] = $entry;
		}

		$ret = array();

		foreach ( (array) $dirlist as $struc ) {
			if ( 'd' === $struc['type'] ) {
				if ( $recursive ) {
					$struc['files'] = $this->dirlist( $path . '/' . $struc['name'], $include_hidden, $recursive );
				} else {
					$struc['files'] = array();
				}
			}

			$ret[ $struc['name'] ] = $struc;
		}

		return $ret;
	}

Changelog

Version Description
2.5.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_filesystem_ftpext/dirlist