WordPress как на ладони
Недорогой хостинг для сайтов на WordPress: wordpress.jino.ru Черная пятница на сайте Template Monster

wp_clear_scheduled_hook() WP 2.1

Удаляет все крон-задачи прикрепленные к указанному хуку и имеющие указанные параметры. Работает на основе wp_unschedule_event().

Отличается от wp_unschedule_hook(), тем что работает на основе wp_unschedule_event(). Т.е. задания удаляются не просто по хуку, а еще и по передаваемым функции параметрам. Например, если при регистрации события были указаны параметры которые нужно передать функции, то в этой функции нужно указать те же самые параметры, чтобы указанная крон задача была отменена (удалена).

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

Работает на основе: wp_unschedule_event()
Хуки из функции
Возвращает

Ничего не возвращает.

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

wp_clear_scheduled_hook( $hook, $args );
$hook(строка) (обязательный)
Название хука.
По умолчанию: нет
$args(массив)
Аргументы, которые передаются функции прикрепленной к хуку.
По умолчанию: array()

Примеры

#1. Отменим ранее запланированные события

// если мы до этого добавляли событие, например:
// wp_schedule_single_event( time() + 3600, 'my_new_event' );

wp_clear_scheduled_hook( 'my_new_event' );

// или так, с указанием аргументов:
// wp_schedule_single_event( time() + 3600, 'my_new_event', array( 'some_arg' ) );

wp_clear_scheduled_hook( 'my_new_event', array( 'some_arg' ) );

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

С версии 2.1.0 Введена.
С версии 5.1.0 Return value modified to indicate success or failure, {@see 'pre_clear_scheduled_hook'} filter added to short-circuit the function.

Код wp clear scheduled hook: wp-includes/cron.php WP 5.3

<?php
function wp_clear_scheduled_hook( $hook, $args = array() ) {
	// Backward compatibility
	// Previously this function took the arguments as discrete vars rather than an array like the rest of the API
	if ( ! is_array( $args ) ) {
		_deprecated_argument( __FUNCTION__, '3.0.0', __( 'This argument has changed to an array to match the behavior of the other cron functions.' ) );
		$args = array_slice( func_get_args(), 1 );
	}

	/**
	 * Filter to preflight or hijack clearing a scheduled hook.
	 *
	 * 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) or false
	 * if unscheduling one or more events fails.
	 *
	 * @since 5.1.0
	 *
	 * @param null|int|false $pre  Value to return instead. Default null to continue unscheduling 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.
	 */
	$pre = apply_filters( 'pre_clear_scheduled_hook', null, $hook, $args );
	if ( null !== $pre ) {
		return $pre;
	}

	// This logic duplicates wp_next_scheduled()
	// It's required due to a scenario where wp_unschedule_event() fails due to update_option() failing,
	// and, wp_next_scheduled() returns the same schedule in an infinite loop.
	$crons = _get_cron_array();
	if ( empty( $crons ) ) {
		return 0;
	}

	$results = array();
	$key     = md5( serialize( $args ) );
	foreach ( $crons as $timestamp => $cron ) {
		if ( isset( $cron[ $hook ][ $key ] ) ) {
			$results[] = wp_unschedule_event( $timestamp, $hook, $args );
		}
	}
	if ( in_array( false, $results, true ) ) {
		return false;
	}
	return count( $results );
}

Cвязанные функции

Из метки: cron (расписание schedule)

Комментариев нет
    Здравствуйте, !     Войти . Зарегистрироваться