wp_delete_file() │ WP 4.2.0

Удаляет файл. Обертка для PHP функции unlink(), в которой срабатывает одноименный хук wp_delete_file.

Функция запускает PHP функцию unlink(), но перед этим применяет фильтр wp_delete_file. В фильтр передается путь удаляемого файла, если фильтр что нибудь вернет (вернет не пустое значение), то сработает unlink().

Основа для: wp_delete_file_from_directory()
Хуки из функции

Возвращает

true|false. Ничего (null).

Использование

wp_delete_file( $file );
$file(строка) (обязательный)
Путь к файлу, который необходимо удалить.

Примеры

0

#1 Удалим файл test.txt из каталога загрузок uploads 

$upload_info = wp_get_upload_dir();
$file        = $upload_info['basedir'] . '/test.txt';

wp_delete_file( $file );
-1

#2 Запретим удаление файлов с именем test.txt с помощью фильтра

Теперь пример выше не удалит файл test.txt.

add_filter( 'wp_delete_file', function ( $file ) {
	if ( 'test.txt' === basename( $file ) ) 
		return '';

	return $file;
} );

Список изменений

С версии 4.2.0 Введена.
С версии 6.7.0 A return value was added.

Код wp_delete_file() WP 6.9

wp-includes/functions.php 
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;
}

Файловая система (files dirs folders создание удаление директорий файлов)

Файловая система (WP_Filesystem)