Описание функции wp_get_scheduled_event()
Функция wp_get_scheduled_event() позволяет получить информацию о запланированном событии по его хуку и времени. Эта функция используется для проверки, существует ли событие в очереди на выполнение, что полезно при работе с cron-задачами в WordPress.
Она возвращает массив, содержащий детали события, если оно запланировано, или null, если событие не найдено.
Параметры
$hook
Тип: string
Обязательный: Да
Описание: Имя хуку, по которому запланировано событие
Возможные значения:
$timestamp
Тип: int
Обязательный: Нет
По умолчанию: null
Описание: Время, к которому привязано событие (в секундах с начала эпохи Unix)
Возможные значения:
Возвращаемое значение
Тип: array|null
Описание: Массив, содержащий данные запланированного события или null, если событие не найдено
Возможные значения:
• Массив с данными события, включая ‘hook’, ‘args’, ‘schedule’, ‘timestamp’
• null, если событие не найдено
Примеры использования
Базовый пример получения запланированного события
$event = wp_get_scheduled_event('my_custom_cron_event');
if ($event) {
echo 'Событие запланировано на: ' . date('Y-m-d H:i:s', $event->timestamp);
} else {
echo 'Событие не найдено';
}
Выводит дату и время, если событие найдено
Получение события, запланированного на час вперед
$timestamp = time() + 3600; // Время через 1 час
$event = wp_get_scheduled_event('my_custom_cron_event', $timestamp);
Ищет событие, которое будет выполнено через 1 час
Безопасность
Валидация входных данных: Функция проверяет, что имя хука является строкой
Санитизация: Нет необходимости в санитизации, так как параметры должны быть валидными
Рекомендации: Используйте проверенные хуки для предотвращения ошибок
— Связанные функции
Запланировать новое событие по заданному хуку
Отменить запланированное событие
— Примечания
– Ограничения
Функция возвращает только одно событие, соответствующее указанному хуку
– Частые проблемы
- Возвращает null, если событие не было запланировано
- Проблемы могут возникнуть, если хук неправильно указан
