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

$path string Optional

Path to directory or file.

Default: '.'

$include_hidden bool Optional

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

Default: true

$recursive bool Optional

Whether to recursively include file details in nested directories.

Default: false

array|false Array of files. False if unable to list directory contents.

• namestring
  Name of the file or directory.
• permsstring
  *nix representation of permissions.
• permsnstring
  Octal representation of permissions.
• ownerstring
  Owner name or ID.
• sizeint
  Size of file in bytes.
• lastmodunixint
  Last modified unix timestamp.
• lastmodmixed
  Last modified month (3 letter) and day (without leading 0).
• timeint
  Last modified time.
• typestring
  Type of resource. 'f' for file, 'd' for directory.
• filesmixed
  If a directory and $recursive is true, contains another array of files.

File: wp-admin/includes/class-wp-filesystem-ftpsockets.php. View all references

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;
	}

	mbstring_binary_safe_encoding();

	$list = $this->ftp->dirlist( $path );

	if ( empty( $list ) && ! $this->exists( $path ) ) {

		reset_mbstring_encoding();

		return false;
	}

	$ret = array();

	foreach ( $list as $struc ) {

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

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

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

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

		// Replace symlinks formatted as "source -> target" with just the source name.
		if ( $struc['islink'] ) {
			$struc['name'] = preg_replace( '/(\s*->\s*.*)$/', '', $struc['name'] );
		}

		// Add the octal representation of the file permissions.
		$struc['permsn'] = $this->getnumchmodfromh( $struc['perms'] );

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

	reset_mbstring_encoding();

	return $ret;
}