Gets details for files in a directory or a specific file.
Parameters
$path
stringoptional- Path to directory or file.
Default:
'.'
$include_hidden
booloptional- Whether to include details of hidden ("." prefixed) files.
Default:
true
$recursive
booloptional- 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
arrayArray of file information. Note that some elements may not be available on all filesystems.name
stringName of the file or directory.perms
string*nix representation of permissions.permsn
stringOctal representation of permissions.number
int|string|falseFile number. May be a numeric string. False if not available.owner
string|falseOwner name or ID, or false if not available.group
string|falseFile permissions group, or false if not available.size
int|string|falseSize of file in bytes. May be a numeric string.
False if not available.lastmodunix
int|string|falseLast modified unix timestamp. May be a numeric string.
False if not available.lastmod
string|falseLast modified month (3 letters) and day (without leading 0), or false if not available.time
string|falseLast modified time, or false if not available.type
stringType of resource.'f'
for file,'d'
for directory,'l'
for link.files
array|falseIf 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; }
Related
Show 1 moreShow lessUses Description WP_Filesystem_FTPext::is_file() wp-admin/includes/class-wp-filesystem-ftpext.php
Checks if resource is a file.
WP_Filesystem_FTPext::parselisting() wp-admin/includes/class-wp-filesystem-ftpext.php
WP_Filesystem_FTPext::dirlist() wp-admin/includes/class-wp-filesystem-ftpext.php
Gets details for files in a directory or a specific file.
trailingslashit() wp-includes/formatting.php
Appends a trailing slash.
Show 1 moreShow lessUsed by Description WP_Filesystem_FTPext::dirlist() wp-admin/includes/class-wp-filesystem-ftpext.php
Gets details for files in a directory or a specific file.
WP_Filesystem_FTPext::chmod() wp-admin/includes/class-wp-filesystem-ftpext.php
Changes filesystem permissions.
WP_Filesystem_FTPext::owner() wp-admin/includes/class-wp-filesystem-ftpext.php
Gets the file owner.
WP_Filesystem_FTPext::getchmod() wp-admin/includes/class-wp-filesystem-ftpext.php
Gets the permissions of the specified file or filepath in their octal format.
WP_Filesystem_FTPext::group() wp-admin/includes/class-wp-filesystem-ftpext.php
Gets the file’s group.
WP_Filesystem_FTPext::delete() wp-admin/includes/class-wp-filesystem-ftpext.php
Deletes a file or directory.
Changelog
Version Description 2.5.0 Introduced.
User Contributed Notes
You must log in before being able to contribute a note or feedback.