WP_Filesystem_ftpsockets::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_ftpsockets::dirlist( $path, $include_hidden, $recursive );

Parameters

$path
( string ) optional default: . – 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-ftpsockets.php
Lines:

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

    mbstring_binary_safe_encoding();

    $list = $this->ftp->WP_Filesystem_ftpsockets::dirlist( $path );

    if ( empty( $list ) && ! $this->WP_Filesystem_ftpsockets::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->WP_Filesystem_ftpsockets::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;
  }
 

 View on GitHub View on Trac