wp_delete_file_from_directory( string $file, string $directory ): bool

Compatibility

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

Parameters

$filestring

Absolute path to the file to delete.

$directorystring

Absolute path to a directory.

Return value

bool

True on success, false on failure.

Performance profile

How much work a call to wp_delete_file_from_directory() 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

16–45

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

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

What it touches

• hookthird-party callbacksapply_filters()one call below wp_delete_file_from_directory()

What one call costs · 18 distinct outcomes

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

Uses · 5

• wp_is_stream()Tests if a given path is a stream URL
• wp_normalize_path()Normalizes a filesystem path.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• trailingslashit()Appends a trailing slash.
• wp_delete_file()Deletes a file.

Used by · 1

• wp_delete_attachment_files()Deletes all files that belong to the given attachment.

Source code

View on Trac ↗View on GitHub ↗

7748function wp_delete_file_from_directory( $file, $directory ) {7749	if ( wp_is_stream( $file ) ) {7750		$real_file      = $file;7751		$real_directory = $directory;7752	} else {7753		$real_file      = realpath( wp_normalize_path( $file ) );7754		$real_directory = realpath( wp_normalize_path( $directory ) );7755	}7756 7757	if ( false !== $real_file ) {7758		$real_file = wp_normalize_path( $real_file );7759	}7760 7761	if ( false !== $real_directory ) {7762		$real_directory = wp_normalize_path( $real_directory );7763	}7764 7765	if ( false === $real_file || false === $real_directory || ! str_starts_with( $real_file, trailingslashit( $real_directory ) ) ) {7766		return false;7767	}7768 7769	return wp_delete_file( $file );7770}

Changelog

Introduced in 4.9.7. 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.9.7 tag, from src/wp-includes/functions.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.