wppaste
WordPress

WP_Filesystem_FTPext::exists( string $path ): bool

Since
2.5.0, 6.3.0
Source
wp-admin/includes/class-wp-filesystem-ftpext.php:427
Checks if a file or directory exists.

Compatibility

WordPress
since 6.3.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$pathstring
Path to file or directory.

Return value

bool
Whether $path exists or not.

Performance profile

How much work a call to WP_Filesystem_FTPext::exists() 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
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
4–19

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
2

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

What one call costs · 3 distinct outcomes

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

WhenInstructionsCalls it makes
$path === ""4none
$path !== "" && !empty($list)15ftp_nlist()
$path !== "" && empty($list)17–19ftp_nlist(), ->is_dir()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev214–193
8.5214–193
8.4214–193
8.3214–193
8.2214–1931 more instruction than PHP 8.1
8.1204–183
7.4204–183

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 1

Used by · 2

Source code

	public function exists( $path ) {		/*		 * Check for empty path. If ftp_nlist() receives an empty path,		 * it checks the current working directory and may return true.		 *		 * See https://core.trac.wordpress.org/ticket/33058.		 */		if ( '' === $path ) {			return false;		} 		$list = ftp_nlist( $this->link, $path ); 		if ( empty( $list ) && $this->is_dir( $path ) ) {			return true; // File is an empty directory.		} 		return ! empty( $list ); // Empty list = no file, so invert.	}

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.

6.3.0
Returns false for an empty path.from the docblock
2.5.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 7.0.4 tag, from src/wp-admin/includes/class-wp-filesystem-ftpext.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.