wp_delete_file_from_directory() │ WP 4.9.7

Deletes a file if its path is within the given directory.

Uses: wp_delete_file()
Used By: wp_delete_attachment_files()

No Hooks.

Return

true|false. True on success, false on failure.

Usage

wp_delete_file_from_directory( $file, $directory );
$file(string) (required)
Absolute path to the file to delete.
$directory(string) (required)
Absolute path to a directory.

Examples

0

#1 Delete the file test.html from the uploads directory 

$upldir_info = wp_get_upload_dir();
$uploads_dir = $upldir_info['basedir']; // uploads path

wp_delete_file_from_directory( "$uploads_dir/test.html", $uploads_dir ); // true or false

Changelog

Since 4.9.7 Introduced.

wp_delete_file_from_directory() code WP 6.5.2

wp-includes/functions.php 
function wp_delete_file_from_directory( $file, $directory ) {
	if ( wp_is_stream( $file ) ) {
		$real_file      = $file;
		$real_directory = $directory;
	} else {
		$real_file      = realpath( wp_normalize_path( $file ) );
		$real_directory = realpath( wp_normalize_path( $directory ) );
	}

	if ( false !== $real_file ) {
		$real_file = wp_normalize_path( $real_file );
	}

	if ( false !== $real_directory ) {
		$real_directory = wp_normalize_path( $real_directory );
	}

	if ( false === $real_file || false === $real_directory || ! str_starts_with( $real_file, trailingslashit( $real_directory ) ) ) {
		return false;
	}

	wp_delete_file( $file );

	return true;
}

File system (create delete files folders)

File system (WP_Filesystem)