WordPress at Your Fingertips
function is not described

WP_Filesystem_FTPext::dirlist() public WP 2.5.0

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

{} It's a method of the class: WP_Filesystem_FTPext{}

No Hooks.

Return

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

Usage

$WP_Filesystem_FTPext = new WP_Filesystem_FTPext();
$WP_Filesystem_FTPext->dirlist( $path, $include_hidden, $recursive );
$path(string)
Path to directory or file.
Default: '.'
$include_hidden(true|false)
Whether to include details of hidden ("." prefixed) files.
Default: true
$recursive(true|false)
Whether to recursively include file details in nested directories.
Default: false

Changelog

Since 2.5.0 Introduced.

Code of WP_Filesystem_FTPext::dirlist() WP 5.8.2

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