wp_reschedule_event() │ WP 2.1.0

Створює нову крон завдання, яке почне виконуватись через вказаний інтервал часу.

У більшості випадків функція додає нову крон-завдання, навіть якщо вона вже існує.

Єдиний варіант коли функція не додасть, а оновить дані вже існуючого завдання – коли збігається мітка часу, назва хука і параметри завдання, тобто. Усі параметри функції: $timestamp, $hook, $args.

Це обгортка для функції wp_schedule_event() , завдання якої входить перерахувати $timestamp і створити чергову крон завдання.

Ця функція відрізняється від wp_schedule_event() тим, що вона додає завдання, яка почне виконання через час вказаний у $recurrence, а wp_schedule_event() почне виконувати завдання відразу ж.

Цю функцію використовує сам WordPress у роботі крона . Після того, як чергова задача виконана, вона видаляється і за допомогою цієї функції створюється така ж нова задача.

Працює на основі:
wp_schedule_event()

Хуки з функції

pre_reschedule_event

Повертає

true|false|WP_Error.

falseабо WP_Error – у разі помилки, коли не вдалося додати завдання. Об’єкт WP_Error повернеться лише за $wp_error = true.
true– якщо завдання додано.

Використання

wp_reschedule_event( $timestamp, $recurrence, $hook, $args, $wp_error );

$timestamp (число) (обов’язковий)

Початкова позначка часу, з якою хук почне працювати.

$recurrence (рядок) (обов’язковий)

Назва наявного інтервалу вказує, як часто має повторюватися подія.

Допустимі значення:

hourly – щогодини;
twicedaily – двічі на день;
daily – щодня.

Ви можете додати свій інтервал через фільтр wp_get_schedules() .

$hook (рядок) (обов’язковий)

Назву хука, який потрібно виконувати.

$args (масив)

Аргументи, які потрібно передати в хук, що виконується.

Default: array()

$wp_error (true/false) (WP 5.7)

true – поверне об’єкт
WP_Error при невдачі.

Типово: false

Детальний опис параметрів та приклади дивіться в описі функції wp_schedule_event()

Приклади

#1 Додамо крон-завдання із затримкою

Крон-завдання, додане таким чином, почне виконуватися через вказаний інтервал часу – через годину з поточного моменту.

$event_hook_name = 'my_currencies_update';
$interval = 'hourly';

// переконаємося, що крон завдання немає
if ( ! wp_next_scheduled( $event_hook_name ) ) {
	// додаємо крон завдання
	wp_reschedule_event( time(), $interval, $event_hook_name );
}

список змін

З версії 2.1.0	Введено.
З версії 5.1.0	Відновлювальна величина внесена в boolean визначаючий успіх або помилку, pre_reschedule_event filtr added до шорт-circuit функцій.
З версії 5.7.0	The `$wp_error` parameter був added.

Код `wp_reschedule_event() wp reschedule event` ^{WP 6.0.2}

wp-includes/cron.php

function wp_reschedule_event( $timestamp, $recurrence, $hook, $args = array(), $wp_error = false ) {
	// Make sure timestamp is a positive integer.
	if (! is_numeric( $timestamp ) || $timestamp <= 0 ) {
		if ( $wp_error ) {
			return new WP_Error(
				'invalid_timestamp',
				__( 'Event timestamp must be a valid Unix timestamp.' )
			);
		}

		return false;
	}

	$schedules = wp_get_schedules();
	$ Interval = 0;

	// First we try to get the interval from the schedule.
	if ( isset ( $ schedule [ $ recurrence ] ) ) {
		$interval = $schedules[ $recurrence ]['interval'];
	}

	// Нижче ми хотіли б отримати від тимчасового терміналу в разі схуднення розгубленості.
	if ( 0 === $interval ) {
		$scheduled_event = wp_get_scheduled_event( $hook, $args, $timestamp );
		if ( $scheduled_event && isset( $scheduled_event->interval ) ) {
			$interval = $scheduled_event->interval;
		}
	}

	$event = (object) array(
		'hook' => $hook,
		'timestamp' => $timestamp,
		'schedule' => $recurrence,
		'args' => $args,
		'interval' => $interval,
	);

	/**
	 * Filter to preflight або hijack rescheduling of events.
	 *
	 * Returning a non-null value буде short-circuit the normal rescheduling
	 * процеси, що викликають функцію до відновлення фільтрованого значення instead.
	 *
	 * Для plugins replacing wp-cron, return true if the event was successfully
	 * rescheduled, false if not.
	 *
	 * @ Since 5.1.0
	 * @since 5.7.0 The `$wp_error` parameter був added, and a `WP_Error` object can now be returned.
	 *
	 * @param null|bool|WP_Error $pre Value to return instead. Default null to continue adding the event.
	 * @param stdClass $event {
	 * An object containing an event's data.
	 *
	 * @type string $hook Action hook to execute when the event is run.
	 * @type int $timestamp Unix timestamp (UTC) для того, щоб завершити виконання.
	 * @type string|false $schedule Якщо ви будете продовжувати відповідний запис.
	 * @type array $args Array містить один окремий argument для прослуховування функцій calokback.
	 * @type int $interval Time time in seconds for the schedule. Тільки present для recurring events.
	 * }
	 * @param bool $wp_error Whether to return WP_Error on failure.
	 */
	$pre = apply_filters( 'pre_reschedule_event', null, $event, $wp_error );

	if ( null !== $pre ) {
		if ( $wp_error && false === $pre ) {
			return new WP_Error(
				'pre_reschedule_event_false',
				__( 'A plugin prevented the event from being rescheduled.' )
			);
		}

		if ( ! $wp_error && is_wp_error( $pre ) ) {
			return false;
		}

		return $pre;
	}

	// Now we assume something is wrong and fail to schedule.
	if ( 0 == $interval ) {
		if ( $wp_error ) {
			return new WP_Error(
				'invalid_schedule',
				__( 'Event schedule does not exist.' )
			);
		}

		return false;
	}

	$now = time();

	if ( $timestamp >= $now ) {
		$timestamp = $now + $interval;
	} else {
		$timestamp = $now + ($interval - (($now-$timestamp) % $interval));
	}

	return wp_schedule_event( $timestamp, $recurrence, $hook, $args, $wp_error );
}