WP_Filesystem_SSH2::dirlist() │ public │ WP 2.7.0

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

Method of the class: WP_Filesystem_SSH2{}

No Hooks.

Return

Array|false. Array of arrays containing file information. False if unable to list directory contents.

Usage

$WP_Filesystem_SSH2 = new WP_Filesystem_SSH2();
$WP_Filesystem_SSH2->dirlist( $path, $include_hidden, $recursive );

$path(string) (required)

Path to directory or file.

$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

WP_Filesystem_SSH2::dirlist() WP Filesystem SSH2::dirlist code ^{WP 6.6.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;
	}

	if ( ! $this->is_dir( $path ) || ! $this->is_readable( $path ) ) {
		return false;
	}

	$ret = array();
	$dir = dir( $this->sftp_path( $path ) );

	if ( ! $dir ) {
		return false;
	}

	$path = trailingslashit( $path );

	while ( false !== ( $entry = $dir->read() ) ) {
		$struc         = array();
		$struc['name'] = $entry;

		if ( '.' === $struc['name'] || '..' === $struc['name'] ) {
			continue; // Do not care about these folders.
		}

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

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

		$struc['perms']       = $this->gethchmod( $path . $entry );
		$struc['permsn']      = $this->getnumchmodfromh( $struc['perms'] );
		$struc['number']      = false;
		$struc['owner']       = $this->owner( $path . $entry );
		$struc['group']       = $this->group( $path . $entry );
		$struc['size']        = $this->size( $path . $entry );
		$struc['lastmodunix'] = $this->mtime( $path . $entry );
		$struc['lastmod']     = gmdate( 'M j', $struc['lastmodunix'] );
		$struc['time']        = gmdate( 'h:i:s', $struc['lastmodunix'] );
		$struc['type']        = $this->is_dir( $path . $entry ) ? 'd' : 'f';

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

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

	$dir->close();
	unset( $dir );

	return $ret;
}