WP_Filesystem_FTPext::dirlist() WordPress Method
The WP_Filesystem_FTPext::dirlist() method is a utility function which parses the raw directory listing from an FTP server and returns an array of file objects. Each file object has the following properties: name: The name of the file type: The type of the file (e.g. "dir" or "file") size: The size of the file in bytes time: The last modified timestamp of the file This method is useful for getting a list of files from an FTP server without having to download or parse the directory listing yourself.
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'
(string) 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$recursiveis 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;
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.5.0 | Introduced. |