хук-фильтр
since 5.1.0
pre_unschedule_event
Проверено на WordPress 6.9, обновлено Источник: WordPress Developer Resources.
Сигнатура
apply_filters( 'pre_unschedule_event', null|bool|WP_Error $pre, int $timestamp, string $hook, array $args, bool $wp_error )Описание
Возврат значения, отличного от null, прервёт обычный процесс отмены планирования, из-за чего функция вернёт отфильтрованное значение.
Для плагинов, заменяющих wp-cron, верните true, если событие было успешно снято с планирования, false или WP_Error, если нет.
Оригинал (английский)
Returning a non-null value will short-circuit the normal unscheduling process, causing the function to return the filtered value instead.
For plugins replacing wp-cron, return true if the event was successfully unscheduled, false or a WP_Error if not.
Фильтруемое значение
Значение, которое нужно вернуть вместо этого. По умолчанию null для продолжения отмены планирования события.
Параметры
$pre
null|bool|WP_Error
обязательный
Значение, которое нужно вернуть вместо этого. По умолчанию null для продолжения отмены планирования события.
$timestamp
int
обязательный
Unix-метка времени (UTC), когда нужно запустить событие.
$hook
string
обязательный
Хук-действие, выполнение которого будет отменено.
$args
array
обязательный
Аргументы, передаваемые функции обратного вызова хука.
$wp_error
bool
обязательный
Возвращать ли WP_Error в случае сбоя.
Исходный код
wp-includes/cron.php:520
$pre = apply_filters( 'pre_unschedule_event', null, $timestamp, $hook, $args, $wp_error );История изменений
| Версия | Описание |
|---|---|
| 5.7.0 | The $wp_error parameter was added, and a WP_Error object can now be returned. |
| 5.1.0 | Introduced. |
