wp_delete_file( string $file ): bool

Deletes a file.

Parameters

$filestringrequired
The path to the file to delete.

Return

bool True on success, false on failure.

Source

function wp_delete_file( $file ) {	/** * Filters the path of the file to delete. * * @since 2.1.0 * * @param string $file Path to the file to delete. */	$delete = apply_filters( 'wp_delete_file', $file );	if ( ! empty( $delete ) ) {	return @unlink( $delete );	}	return false; } 

Hooks

apply_filters( ‘wp_delete_file’, string $file )

Filters the path of the file to delete.

Changelog

VersionDescription
6.7.0A return value was added.
4.2.0Introduced.

User Contributed Notes

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