WordPress at Your Fingertips
function is not described

WC_Action_Queue::cancel() public WC 1.0

Dequeue the next scheduled instance of an action with a matching hook (and optionally matching args and group).

Any recurring actions with a matching hook should also be cancelled, not just the next scheduled action.

While technically only the next instance of a recurring or cron action is unscheduled by this method, that will also prevent all future instances of that recurring or cron action from being run. Recurring and cron actions are scheduled in a sequence instead of all being scheduled at once. Each successive occurrence of a recurring action is scheduled only after the former action is run. As the next instance is never run, because it's unscheduled by this function, then the following instance will never be scheduled (or exist), which is effectively the same as being unscheduled by this method also.

{} It's a method of the class: WC_Action_Queue{}

No Hooks.

Return

null. Nothing.

Usage

$WC_Action_Queue = new WC_Action_Queue();
$WC_Action_Queue->cancel( $hook, $args, $group );
$hook(string) (required)
The hook that the job will trigger.
$args(array)
Args that would have been passed to the job.
Default: array()
$group(string)
The group the job is assigned to (if any).
Default: ''

Code of WC_Action_Queue::cancel() WC 5.9.0

public function cancel( $hook, $args = array(), $group = '' ) {
	as_unschedule_action( $hook, $args, $group );
}