描述
$timestamp和$hook参数是必需的，以便可以识别事件。
参数
- $timestamp
-
(int)(必填) 事件的Unix时间戳（UTC）。
- $hook
-
(string)(必填) 事件的动作钩子。
- $args
-
(array)(可选) 数组，该数组包含要传递给钩子回调函数的每个单独参数。虽然没有传递给回调，但这些参数用于唯一标识事件，因此它们应该与最初调度事件时使用的参数相同。
默认值: array()
- $wp_error
-
(bool)(可选) 失败时是否返回WP_Error。
默认值: false
返回
(bool|WP_Error) 如果取消计划事件成功，则为true，失败时为false或WP_Error。
更多信息
请注意，为了取消计划任务，您需要知道下一次发生的确切时间，即调度挂钩被设置为运行的时间，以及它应该具有的函数参数。通过调用此函数，取消所有未来的计划任务事件。
源码
更新日志
| 版本 | 描述 |
|---|---|
| 5.7.0 | 添加了$wp_error参数。 |
| 5.1.0 | 返回值修改为布尔值，指示成功或失败，添加了‘pre_unschedule_event’过滤器以使函数短路。 |
| 2.1.0 | 开始引入 |
使用示例
实例
// Get the timestamp for the next event. $timestamp = wp_next_scheduled( 'my_schedule_hook' ); // If this event was created with any special arguments, you need to get those too. $original_args = array(); wp_unschedule_event( $timestamp, 'my_schedule_hook', $original_args );
您还可以使用
wp_clear_scheduled_hook()，它调用wp_unschedule_event()。同样，它将清除所有未来事件，并避免您自己调用wp_next_scheduled()。