WP_Filesystem_ftpsockets::dirlist( string $path = '.', bool $include_hidden = true, bool $recursive = false ): array|false

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$pathstringoptional

Path to directory or file.Default: '.'

$include_hiddenbooloptional

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

$recursivebooloptional

Whether to recursively include file details in nested directories.
Default false.Default: false

Return value

array|false

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

• ...$0array

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

  • $namestring

    Name of the file or directory.

  • $permsstring

    *nix representation of permissions.

  • $permsnstring

    Octal representation of permissions.

  • $numberint|string|false

    File number. May be a numeric string. False if not available.

  • $ownerstring|false

    Owner name or ID, or false if not available.

  • $groupstring|false

    File permissions group, or false if not available.

  • $sizeint|string|false

    Size of file in bytes. May be a numeric string. False if not available.

  • $lastmodunixint|string|false

    Last modified unix timestamp. May be a numeric string. False if not available.

  • $lastmodstring|false

    Last modified month (3 letters) and day (without leading 0), or false if not available.

  • $timestring|false

    Last modified time, or false if not available.

  • $typestring

    Type of resource. 'f' for file, 'd' for directory, 'l' for link.

  • $filesarray|false

    If a directory and $recursive is true, contains another array of files. False if unable to list directory contents.

Performance profile

How much work a call to WP_Filesystem_ftpsockets::dirlist() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

24–39

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 92.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

5

5 places in core call this, so the cost is paid more often than your own code shows.

What one call costs · 6 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Filesystem_ftpsockets::dirlist() can have, taken from its control-flow graph on PHP 8.5.

Uses · 7

• mbstring_binary_safe_encoding()Sets the mbstring internal encoding to a binary safe encoding when func_overload is enabled.
• reset_mbstring_encoding()Resets the mbstring internal encoding to a users previously set encoding.
• trailingslashit()Appends a trailing slash.
• WP_Filesystem_ftpsockets::is_file()Checks if resource is a file.
• WP_Filesystem_ftpsockets::exists()Checks if a file or directory exists.
• WP_Filesystem_ftpsockets::dirlist()Gets details for files in a directory or a specific file.
• WP_Filesystem_ftpsockets::getnumchmodfromh()

Used by · 5

• WP_Filesystem_ftpsockets::chmod()Changes filesystem permissions.
• WP_Filesystem_ftpsockets::dirlist()Gets details for files in a directory or a specific file.
• WP_Filesystem_ftpsockets::getchmod()Gets the permissions of the specified file or filepath in their octal format.
• WP_Filesystem_ftpsockets::group()Gets the file's group.
• WP_Filesystem_ftpsockets::owner()Gets the file owner.

Source code

View on Trac ↗View on GitHub ↗

650	public function dirlist( $path = '.', $include_hidden = true, $recursive = false ) {651		if ( $this->is_file( $path ) ) {652			$limit_file = basename( $path );653			$path       = dirname( $path ) . '/';654		} else {655			$limit_file = false;656		}657 658		mbstring_binary_safe_encoding();659 660		$list = $this->ftp->dirlist( $path );661 662		if ( empty( $list ) && ! $this->exists( $path ) ) {663 664			reset_mbstring_encoding();665 666			return false;667		}668 669		$path = trailingslashit( $path );670		$ret  = array();671 672		foreach ( $list as $struc ) {673 674			if ( '.' === $struc['name'] || '..' === $struc['name'] ) {675				continue;676			}677 678			if ( ! $include_hidden && '.' === $struc['name'][0] ) {679				continue;680			}681 682			if ( $limit_file && $struc['name'] !== $limit_file ) {683				continue;684			}685 686			if ( 'd' === $struc['type'] ) {687				if ( $recursive ) {688					$struc['files'] = $this->dirlist( $path . $struc['name'], $include_hidden, $recursive );689				} else {690					$struc['files'] = array();691				}692			}693 694			// Replace symlinks formatted as "source -> target" with just the source name.695			if ( $struc['islink'] ) {696				$struc['name'] = preg_replace( '/(\s*->\s*.*)$/', '', $struc['name'] );697			}698 699			// Add the octal representation of the file permissions.700			$struc['permsn'] = $this->getnumchmodfromh( $struc['perms'] );701 702			$ret[ $struc['name'] ] = $struc;703		}704 705		reset_mbstring_encoding();706 707		return $ret;708	}

Changelog

Introduced in 2.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-admin/includes/class-wp-filesystem-ftpsockets.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.