WP_Filesystem_ftpsockets::dirlist() │ public │ WP 2.5.0

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

Method of the class: WP_Filesystem_ftpsockets{}

No Hooks.

Return

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

Usage

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

$path(string)

Path to directory or file.
Default: '.'

$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_ftpsockets::dirlist() WP Filesystem ftpsockets::dirlist code ^{WP 6.5.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;
	}

	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;
}