WC_Action_Queue::cancel( string $hook, array $args = array(), string $group = '' )
Dequeue the next scheduled instance of an action with a matching hook (and optionally matching args and group).
Description Description
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.
Parameters Parameters
- $hook
-
(Required) The hook that the job will trigger.
- $args
-
(Optional) Args that would have been passed to the job.
Default value: array()
- $group
-
(Optional) The group the job is assigned to (if any).
Default value: ''
Source Source
File: includes/queue/class-wc-action-queue.php
public function cancel( $hook, $args = array(), $group = '' ) {
as_unschedule_action( $hook, $args, $group );
}