WP_Filesystem_FTPext::dirlist( string $path = ‘.’, bool $include_hidden = true, bool $recursive = false ): array|false

In this article

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

Parameters

$pathstringoptional
Path to directory or file.

Default:'.'

$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 ) {
	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;
	}

	$path = trailingslashit( $path );
	$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

VersionDescription
2.5.0Introduced.

User Contributed Notes

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