Action command for Action Scheduler.
cancel(array $args, array $assoc_args) : void
Cancel the next occurrence or all occurrences of a scheduled action.
[<hook>] : Name of the action hook.
[--group=<group>] : The group the job is assigned to.
[--all] : Cancel all occurrences of a scheduled action.
| array | $args | Positional arguments. |
| array | $assoc_args | Keyed arguments. |
create(array $args, array $assoc_args) : void
Creates a new scheduled action.
<hook> : Name of the action hook.
<start> : A unix timestamp representing the date you want the action to start. Also 'async' or 'now' to enqueue an async action.
wp action-scheduler action create hook_async async
wp action-scheduler action create hook_single 1627147598
wp action-scheduler action create hook_recurring 1627148188 --interval=5
wp action-scheduler action create hook_cron 1627147655 --cron='5 4 * * *'| array | $args | Positional arguments. |
| array | $assoc_args | Keyed arguments. |
delete(array $args, array $assoc_args) : void
Delete existing scheduled action(s).
# Delete the action with id 100
$ wp action-scheduler action delete 100
# Delete the actions with ids 100 and 200
$ wp action-scheduler action delete 100 200
# Delete the first five pending actions in 'action-scheduler' group
$ wp action-scheduler action delete $( wp action-scheduler action list --status=pending --group=action-scheduler --format=ids )| array | $args | Positional arguments. |
| array | $assoc_args | Keyed arguments. |
generate(array $args, array $assoc_args) : void
Generates some scheduled actions.
<hook> : Name of the action hook.
<start> : The Unix timestamp representing the date you want the action to start.
wp action-scheduler action generate test_multiple 1627147598 --count=5 --interval=5| array | $args | Positional arguments. |
| array | $assoc_args | Keyed arguments. |
get(array $args, array $assoc_args) : void
Get details about a scheduled action.
[--field=<field>] : Instead of returning the whole action, returns the value of a single field.
[--fields=<fields>] : Limit the output to specific fields (comma-separated). Defaults to all fields.
default: table options:
| array | $args | Positional arguments. |
| array | $assoc_args | Keyed arguments. |
subcommand_list(array $args, array $assoc_args) : void
Get a list of scheduled actions.
Display actions based on all arguments supported by as_get_scheduled_actions().
[--<field>=<value>] : One or more arguments to pass to as_get_scheduled_actions().
[--field=<field>] : Prints the value of a single property for each action.
[--fields=<fields>] : Limit the output to specific object properties.
default: table options:
These fields will be displayed by default for each action:
These fields are optionally available:
| array | $args | Positional arguments. |
| array | $assoc_args | Keyed arguments. |
next(array $args, array $assoc_args) : void
Get the ID or timestamp of the next scheduled action.
<hook> : The hook of the next scheduled action.
[--raw] : Display the raw output of as_next_scheduled_action() (timestamp or boolean).
| array | $args | Positional arguments. |
| array | $assoc_args | Keyed arguments. |
run(array $args, array $assoc_args) : void
Run existing scheduled action(s).
# Run the action with id 100
$ wp action-scheduler action run 100
# Run the actions with ids 100 and 200
$ wp action-scheduler action run 100 200
# Run the first five pending actions in 'action-scheduler' group
$ wp action-scheduler action run $( wp action-scheduler action list --status=pending --group=action-scheduler --format=ids )| array | $args | Positional arguments. |
| array | $assoc_args | Keyed arguments. |