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

In this article

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

Parameters

$filestringrequired
Absolute path to the file to delete.
$directorystringrequired
Absolute path to a directory.

Return

bool True on success, false on failure.

Source

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;
}

Changelog

VersionDescription
4.9.7Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.