wp_unschedule_event() │ WP 2.1.0

Удаляет из расписания указанное крон событие (задание). Для удаления нужно указать все данные: метку времени, имя хука и параметры.

Чтобы отменить событие, вы должны знать точное время в которое оно запланировано и аргументы, которые должны быть переданы функции.

Подробнее об удалении крон задач: WP Cron (планировщик) в WordPress

Крон задание добавляется через wp_schedule_event().

Основа для: wp_clear_scheduled_hook()

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

pre_unschedule_event

Возвращает

true|false|WP_Error. Возвращает false, если неправильно указан параметр $timestamp.

Использование

wp_unschedule_event( $timestamp, $hook, $args, $wp_error );

$timestamp(строка) (обязательный): Метка времени в формате UNIX (321546564) в которое должно наступить событие, которые мы хотим удалить.
$hook(строка) (обязательный): Название хука к которому "цепляется" функция выполняющее действие указанное в $timestamp время.
$args(массив): Массив аргументов, которые должны быть переданные функции.
По умолчанию: array()
$wp_error(true/false) (WP 5.7): true - вернет объект WP_Error при неудаче.
По умолчанию: false

Примеры

#1 Отменим крон-задачу

Предполагается, что функции прикрепленной к хуку никакие данные не передаются, поэтому $args указывать не обязательно.

$timestamp = wp_next_scheduled( 'my_schedule_hook' ); //> 1424106123

wp_unschedule_event( $timestamp, 'my_schedule_hook' );

1424106123 - время, когда задание должно быть выполнено.

#2 Отменим крон-задачу с параметрами

Если при регистрации крон-задачи ей были указаны параметр, то для удаления такой задачи обязательно нужно указать эти параметры, иначе событие не удалиться.

wp_unschedule_event( 1424106123, 'my_schedule_hook', [ 'id' => 654 ] );

Список изменений

С версии 2.1.0	Введена.
С версии 5.1.0	Return value modified to boolean indicating success or failure, pre_unschedule_event filter added to short-circuit the function.
С версии 5.7.0	The `$wp_error` parameter was added.

Код `wp_unschedule_event() wp unschedule event` ^{WP 6.5.2}

wp-includes/cron.php

function wp_unschedule_event( $timestamp, $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;
	}

	/**
	 * Filter to override unscheduling of events.
	 *
	 * 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.
	 *
	 * @since 5.1.0
	 * @since 5.7.0 The `$wp_error` parameter was added, and a `WP_Error` object can now be returned.
	 *
	 * @param null|bool|WP_Error $pre       Value to return instead. Default null to continue unscheduling the event.
	 * @param int                $timestamp Timestamp for when to run the event.
	 * @param string             $hook      Action hook, the execution of which will be unscheduled.
	 * @param array              $args      Arguments to pass to the hook's callback function.
	 * @param bool               $wp_error  Whether to return a WP_Error on failure.
	 */
	$pre = apply_filters( 'pre_unschedule_event', null, $timestamp, $hook, $args, $wp_error );

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

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

		return $pre;
	}

	$crons = _get_cron_array();
	$key   = md5( serialize( $args ) );

	unset( $crons[ $timestamp ][ $hook ][ $key ] );

	if ( empty( $crons[ $timestamp ][ $hook ] ) ) {
		unset( $crons[ $timestamp ][ $hook ] );
	}

	if ( empty( $crons[ $timestamp ] ) ) {
		unset( $crons[ $timestamp ] );
	}

	return _set_cron_array( $crons, $wp_error );
}