WP_Filesystem_ftpsockets::dirlist() WordPress Method
The WP_Filesystem_ftpsockets::dirlist() method is used to list the contents of a directory on an FTP server. It takes two parameters: the path to the directory to list, and an optional array of options. The options array can include the following keys: 'recursive' => false, // Whether to recursively list the contents of subdirectories 'include_hidden' => false, // Whether to include hidden files in the list 'limit_dirs' => 0, // How many directories to recursively list (0 for no limit) The method returns an array of filenames, or false on error.
WP_Filesystem_ftpsockets::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-ftpsockets.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;
}
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;
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.5.0 | Introduced. |