取消预先安排先前安排的活动。

原型

wp_unschedule_event( int $timestamp, string $hook, array $args = array() )

描述

$ timestamp和$ hook参数是必需的,以便可以识别事件。

参数

$timestamp (int) (Required) 用于何时运行事件的Unix时间戳(UTC)。

$hook (string) (Required) 动作钩子,其执行将被取消预定。

$args (array) (Optional) 传递给hook的回调函数的参数。虽然未传递给回调函数,但这些参数用于唯一标识已调度的事件,因此它们应与最初调度事件时使用的参数相同。

返回值

(false|void)  如果事件没有计划,则返回false。

源文件

路径:wp-includes/cron.php

<?php
...
function wp_unschedule_event( $timestamp, $hook, $args = array() ) {
	// Make sure timestamp is a positive integer
	if ( ! is_numeric( $timestamp ) || $timestamp <= 0 ) {
		return false;
	}
	$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] );
	_set_cron_array( $crons );
}
...
?>

其他

英文文档:https://developer.wordpress.org/reference/functions/wp_unschedule_event/