WP_Filesystem_SSH2::dirlist( string $path, bool $include_hidden = true, bool $recursive = false )

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


Description Description


Parameters Parameters

$path

(string) (Required) Path to directory or file.

$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


Top ↑

Return 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'
    (int) 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 $recursive is true, contains another array of files.


Top ↑

Source Source

File: wp-admin/includes/class-wp-filesystem-ssh2.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;
		}

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

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

		if ( ! $dir ) {
			return false;
		}

		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']     = date( 'M j', $struc['lastmodunix'] );
			$struc['time']        = date( '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;
	}

Top ↑

Changelog Changelog

Changelog
Version Description
2.7.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.