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

Сигнатура

apply_filters( 'pre_schedule_event', null|bool|WP_Error $result, object $event, bool $wp_error )

Описание

Возврат значения, отличного от null, прервёт добавление события в массив cron, из-за чего функция вернёт отфильтрованное значение.
Через этот фильтр проходят как одиночные, так и повторяющиеся события; у одиночных событий $event->schedule равно false, тогда как у повторяющихся оно установлено в периодичность из wp_get_schedules() . У повторяющихся событий также задан целочисленный интервал повторения в $event->interval.
Для плагинов, заменяющих wp-cron, рекомендуется проверять наличие идентичного события в пределах десяти минут и применять фильтр 'schedule_event', чтобы убедиться, что другой плагин не запретил событие, прежде чем планировать его.
Верните true, если событие было запланировано, false или WP_Error, если нет.

Оригинал (английский)

Returning a non-null value will short-circuit adding the event to the cron array, causing the function to return the filtered value instead.

Both single events and recurring events are passed through this filter; single events have $event->schedule as false, whereas recurring events have this set to a recurrence from wp_get_schedules() . Recurring events also have the integer recurrence interval set as $event->interval.

For plugins replacing wp-cron, it is recommended you check for an identical event within ten minutes and apply the ‘schedule_event’ filter to check if another plugin has disallowed the event before scheduling.

Return true if the event was scheduled, false or a WP_Error if not.

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

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

Параметры

$result null|bool|WP_Error обязательный

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

$event object обязательный

Объект, содержащий данные события. hook stringХук-действие, выполняемый при запуске события. timestamp intUnix-метка времени (UTC) следующего запуска события. schedule string|falseКак часто событие должно затем повторяться. args arrayМассив, содержащий каждый отдельный аргумент, передаваемый функции обратного вызова хука. interval intНеобязательно. Интервал в секундах для расписания. Присутствует только для повторяющихся событий.

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

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

Исходный код

wp-includes/cron.php:100

$pre = apply_filters( 'pre_schedule_event', null, $event, $wp_error );

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

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