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

Parameters

$pathstringoptional

Path to directory or file.

Default:'.'

$include_hiddenbooloptional

Whether to include details of hidden ("." prefixed) files.

Default:true

$recursivebooloptional

Whether to recursively include file details in nested directories.

Default:false

Return

• ...$0 array
  Array of file information. Note that some elements may not be available on all filesystems.

  • name string
    Name of the file or directory.
  • perms string
    *nix representation of permissions.
  • permsn string
    Octal representation of permissions.
  • number int|string|false
    File number. May be a numeric string. False if not available.
  • owner string|false
    Owner name or ID, or false if not available.
  • group string|false
    File permissions group, or false if not available.
  • size int|string|false
    Size of file in bytes. May be a numeric string.
    False if not available.
  • lastmodunix int|string|false
    Last modified unix timestamp. May be a numeric string.
    False if not available.
  • lastmod string|false
    Last modified month (3 letters) and day (without leading 0), or false if not available.
  • time string|false
    Last modified time, or false if not available.
  • type string
    Type of resource. 'f' for file, 'd' for directory, 'l' for link.
  • files array|false
    If a directory and $recursive is true, contains another array of files. False if unable to list directory contents.
    

  Source

  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;
  	}
  
  	mbstring_binary_safe_encoding();
  
  	$list = $this->ftp->dirlist( $path );
  
  	if ( empty( $list ) && ! $this->exists( $path ) ) {
  
  		reset_mbstring_encoding();
  
  		return false;
  	}
  
  	$path = trailingslashit( $path );
  	$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->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 all references View on Trac View on GitHub

  Changelog

  Version	Description
  2.5.0	Introduced.

  User Contributed Notes

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