WP_Filesystem_SSH2::dirlist() – Gets details for files in a directory or a specific file.

You appear to be a bot. Output may be restricted

Description

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

Usage

$array|false = WP_Filesystem_SSH2::dirlist( $path, $include_hidden, $recursive );

Parameters

$path
( string ) required – Path to directory or file.
$include_hidden
( bool ) optional default: 1 – Optional. Whether to include details of hidden ("." prefixed) files. Default true.
$recursive
( bool ) optional – Optional. Whether to recursively include file details in nested directories. Default false.
$name
( string ) optional – Name of the file or directory.
$perms
( string ) optional – *nix representation of permissions.
$permsn
( string ) optional – Octal representation of permissions.
$owner
( string ) optional – Owner name or ID.
$size
( int ) optional – Size of file in bytes.
$lastmodunix
( int ) optional – Last modified unix timestamp.
$lastmod
( mixed ) optional – Last modified month (3 letter) and day (without leading 0).
$time
( int ) optional – Last modified time.
$type
( string ) optional – Type of resource. 'f' for file, 'd' for directory.
$files
( mixed ) optional – If a directory and $recursive is true, contains another array of files. }

Returns

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

Source

File name: wordpress/wp-admin/includes/class-wp-filesystem-ssh2.php
Lines:

1 to 62 of 62
  public function dirlist( $path, $include_hidden = true, $recursive = false ) {
    if ( $this->WP_Filesystem_SSH2::is_file( $path ) ) {
      $limit_file = basename( $path );
      $path       = dirname( $path );
    } else {
      $limit_file = false;
    }

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

    $ret = array();
    $dir = dir( $this->WP_Filesystem_SSH2::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->WP_Filesystem_SSH2::owner( $path . '/' . $entry );
      $struc['group']       = $this->WP_Filesystem_SSH2::group( $path . '/' . $entry );
      $struc['size']        = $this->WP_Filesystem_SSH2::size( $path . '/' . $entry );
      $struc['lastmodunix'] = $this->WP_Filesystem_SSH2::mtime( $path . '/' . $entry );
      $struc['lastmod']     = gmdate( 'M j', $struc['lastmodunix'] );
      $struc['time']        = gmdate( 'h:i:s', $struc['lastmodunix'] );
      $struc['type']        = $this->WP_Filesystem_SSH2::is_dir( $path . '/' . $entry ) ? 'd' : 'f';

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

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

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

    return $ret;
  }
 

 View on GitHub View on Trac