pre_unschedule_hook — filter WordPress: параметры и применение

Сигнатура

apply_filters( 'pre_unschedule_hook', null|int|false|WP_Error $pre, string $hook, bool $wp_error )

Описание

Возврат значения, отличного от null, прервёт обычный процесс отмены планирования, из-за чего функция вернёт отфильтрованное значение.
Для плагинов, заменяющих wp-cron, верните количество успешно снятых с планирования событий (ноль, если с хуком не было зарегистрировано ни одного события). Если отмена планирования одного или нескольких событий завершилась неудачей, верните объект WP_Error или 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 the number of events successfully unscheduled (zero if no events were registered with the hook). If unscheduling one or more events fails then return either a WP_Error object or false depending on the value of the $wp_error parameter.

Фильтруемое значение

Значение, которое нужно вернуть вместо этого. По умолчанию null для продолжения отмены планирования хука.

Параметры

$pre null|int|false|WP_Error обязательный

Значение, которое нужно вернуть вместо этого. По умолчанию null для продолжения отмены планирования хука.

$hook string обязательный

Хук-действие, выполнение которого будет отменено.

$wp_error bool обязательный

Возвращать ли WP_Error в случае сбоя.

Исходный код

wp-includes/cron.php:700

$pre = apply_filters( 'pre_unschedule_hook', null, $hook, $wp_error );

История изменений

Версия	Описание
5.7.0	The $wp_error parameter was added, and a WP_Error object can now be returned.
5.1.0	Introduced.