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

Parameters

$filestring

Absolute path to the file to delete.

$directorystring

Absolute path to a directory.

Return

bool

True on success, false on failure.

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

View on Trac ↗View on GitHub ↗

7729function wp_delete_file_from_directory( $file, $directory ) {7730	if ( wp_is_stream( $file ) ) {7731		$real_file      = $file;7732		$real_directory = $directory;7733	} else {7734		$real_file      = realpath( wp_normalize_path( $file ) );7735		$real_directory = realpath( wp_normalize_path( $directory ) );7736	}7737 7738	if ( false !== $real_file ) {7739		$real_file = wp_normalize_path( $real_file );7740	}7741 7742	if ( false !== $real_directory ) {7743		$real_directory = wp_normalize_path( $real_directory );7744	}7745 7746	if ( false === $real_file || false === $real_directory || ! str_starts_with( $real_file, trailingslashit( $real_directory ) ) ) {7747		return false;7748	}7749 7750	return wp_delete_file( $file );7751}

History

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.8.8 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.