WordPress开发者和主题制作者的搜索引擎



wp_clear_scheduled_hook ›

Since2.1.0
已弃用n/a
wp_clear_scheduled_hook ( $hook, $args = array() )
参数: (2)
  • (string) $hook Action hook, the execution of which will be unscheduled.
    Required: Yes
  • (array) $args Optional. Arguments that were to be passed to the hook's callback function.
    Required: No
    默认: array()
定义在:
文档:

Unschedules all events attached to the hook with the specified arguments.



源码

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