wp_clear_scheduled_hook

Отменяет все запланированные ранее cron задания по указанному имени хука.

Хуков нет.

Возвращает

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

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

<?php 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' ) );

Код из


wp-includes/cron.php

WP 4.7.2

<?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 );
	}

	// 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;

	$key = md5( serialize( $args ) );
	foreach ( $crons as $timestamp => $cron ) {
		if ( isset( $cron[ $hook ][ $key ] ) ) {
			wp_unschedule_event( $timestamp, $hook, $args );
		}
	}
}