WC_Queue_Interface::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.

Method of the class: WC_Queue_Interface{}

No Hooks.

Returns

null. Nothing (null).

Usage

$WC_Queue_Interface = new WC_Queue_Interface();
$WC_Queue_Interface->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: ''

WC_Queue_Interface::cancel() WC Queue Interface::cancel code ^{WC 10.6.2}

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