wp-cli/cron-command

Tests, runs, and deletes WP-Cron events; manages WP-Cron schedules.

wp-cli/cron-command

Tests, runs, and deletes WP-Cron events; manages WP-Cron schedules., _(*1)

, _(*2)

Quick links: Using | Installing | Contributing | Support, _(*3)

Using

This package implements the following commands:, _(*4)

wp cron

Tests, runs, and deletes WP-Cron events; manages WP-Cron schedules., _(*5)

wp cron

EXAMPLES, _(*6)

# Test WP Cron spawning system
$ wp cron test
Success: WP-Cron spawning is working as expected.

wp cron test

Tests the WP Cron spawning system and reports back its status., _(*7)

wp cron test 

This command tests the spawning system by performing the following steps:, _(*8)

• Checks to see if the DISABLE_WP_CRON constant is set; errors if true because WP-Cron is disabled.
• Checks to see if the ALTERNATE_WP_CRON constant is set; warns if true.
• Attempts to spawn WP-Cron over HTTP; warns if non 200 response code is returned.

EXAMPLES, _(*9)

# Cron test runs successfully.
$ wp cron test
Success: WP-Cron spawning is working as expected.

wp cron event

Schedules, runs, and deletes WP-Cron events., _(*10)

wp cron event

EXAMPLES, _(*11)

# Schedule a new cron event
$ wp cron event schedule cron_test
Success: Scheduled event with hook 'cron_test' for 2016-05-31 10:19:16 GMT.

# Run all cron events due right now
$ wp cron event run --due-now
Executed the cron event 'cron_test_1' in 0.01s.
Executed the cron event 'cron_test_2' in 0.006s.
Success: Executed a total of 2 cron events.

# Delete all scheduled cron events for the given hook
$ wp cron event delete cron_test
Success: Deleted a total of 2 cron events.

# List scheduled cron events in JSON
$ wp cron event list --fields=hook,next_run --format=json
[{"hook":"wp_version_check","next_run":"2016-05-31 10:15:13"},{"hook":"wp_update_plugins","next_run":"2016-05-31 10:15:13"},{"hook":"wp_update_themes","next_run":"2016-05-31 10:15:14"}]

wp cron event delete

Deletes all scheduled cron events for the given hook., _(*12)

wp cron event delete [<hook>...] [--due-now] [--exclude=<hooks>] [--all]

OPTIONS, _(*13)

[<hook>...]
    One or more hooks to delete.

[--due-now]
    Delete all hooks due right now.

[--exclude=<hooks>]
    Comma-separated list of hooks to exclude.

[--all]
    Delete all hooks.

EXAMPLES, _(*14)

# Delete all scheduled cron events for the given hook
$ wp cron event delete cron_test
Success: Deleted a total of 2 cron events.

wp cron event list

Lists scheduled cron events., _(*15)

wp cron event list [--fields=<fields>] [--<field>=<value>] [--field=<field>] [--format=<format>]

OPTIONS, _(*16)

[--fields=<fields>]
    Limit the output to specific object fields.

[--<field>=<value>]
    Filter by one or more fields.

[--field=<field>]
    Prints the value of a single field for each event.

[--format=<format>]
    Render output in a particular format.
    ---
    default: table
    options:
      - table
      - csv
      - ids
      - json
      - count
      - yaml
    ---

AVAILABLE FIELDS, _(*17)

These fields will be displayed by default for each cron event: * hook * next_run_gmt * next_run_relative * recurrence, _(*18)

These fields are optionally available: * time * sig * args * schedule * interval * next_run, _(*19)

EXAMPLES, _(*20)

# List scheduled cron events
$ wp cron event list
+-------------------+---------------------+---------------------+------------+
| hook              | next_run_gmt        | next_run_relative   | recurrence |
+-------------------+---------------------+---------------------+------------+
| wp_version_check  | 2016-05-31 22:15:13 | 11 hours 57 minutes | 12 hours   |
| wp_update_plugins | 2016-05-31 22:15:13 | 11 hours 57 minutes | 12 hours   |
| wp_update_themes  | 2016-05-31 22:15:14 | 11 hours 57 minutes | 12 hours   |
+-------------------+---------------------+---------------------+------------+

# List scheduled cron events in JSON
$ wp cron event list --fields=hook,next_run --format=json
[{"hook":"wp_version_check","next_run":"2016-05-31 10:15:13"},{"hook":"wp_update_plugins","next_run":"2016-05-31 10:15:13"},{"hook":"wp_update_themes","next_run":"2016-05-31 10:15:14"}]

wp cron event run

Runs the next scheduled cron event for the given hook., _(*21)

wp cron event run [<hook>...] [--due-now] [--exclude=<hooks>] [--all]

OPTIONS, _(*22)

[<hook>...]
    One or more hooks to run.

[--due-now]
    Run all hooks due right now.

[--exclude=<hooks>]
    Comma-separated list of hooks to exclude.

[--all]
    Run all hooks.

EXAMPLES, _(*23)

# Run all cron events due right now
$ wp cron event run --due-now
Executed the cron event 'cron_test_1' in 0.01s.
Executed the cron event 'cron_test_2' in 0.006s.
Success: Executed a total of 2 cron events.

wp cron event schedule

Schedules a new cron event., _(*24)

wp cron event schedule <hook> [<next-run>] [<recurrence>] [--<field>=<value>]

OPTIONS, _(*25)

<hook>
    The hook name.

[<next-run>]
    A Unix timestamp or an English textual datetime description compatible with `strtotime()`. Defaults to now.

[<recurrence>]
    How often the event should recur. See `wp cron schedule list` for available schedule names. Defaults to no recurrence.

[--<field>=<value>]
    Arguments to pass to the hook for the event. <field> should be a numeric key, not a string.

EXAMPLES, _(*26)

# Schedule a new cron event
$ wp cron event schedule cron_test
Success: Scheduled event with hook 'cron_test' for 2016-05-31 10:19:16 GMT.

# Schedule new cron event with hourly recurrence
$ wp cron event schedule cron_test now hourly
Success: Scheduled event with hook 'cron_test' for 2016-05-31 10:20:32 GMT.

# Schedule new cron event and pass arguments
$ wp cron event schedule cron_test '+1 hour' --0=first-argument --1=second-argument
Success: Scheduled event with hook 'cron_test' for 2016-05-31 11:21:35 GMT.

wp cron schedule

Gets WP-Cron schedules., _(*27)

wp cron schedule

EXAMPLES, _(*28)

# List available cron schedules
$ wp cron schedule list
+------------+-------------+----------+
| name       | display     | interval |
+------------+-------------+----------+
| hourly     | Once Hourly | 3600     |
| twicedaily | Twice Daily | 43200    |
| daily      | Once Daily  | 86400    |
+------------+-------------+----------+

wp cron schedule list

List available cron schedules., _(*29)

wp cron schedule list [--fields=<fields>] [--field=<field>] [--format=<format>]

OPTIONS, _(*30)

[--fields=<fields>]
    Limit the output to specific object fields.

[--field=<field>]
    Prints the value of a single field for each schedule.

[--format=<format>]
    Render output in a particular format.
    ---
    default: table
    options:
      - table
      - csv
      - ids
      - json
      - yaml
    ---

AVAILABLE FIELDS, _(*31)

These fields will be displayed by default for each cron schedule:, _(*32)

• name
• display
• interval

There are no additional fields., _(*33)

EXAMPLES, _(*34)

# List available cron schedules
$ wp cron schedule list
+------------+-------------+----------+
| name       | display     | interval |
+------------+-------------+----------+
| hourly     | Once Hourly | 3600     |
| twicedaily | Twice Daily | 43200    |
| daily      | Once Daily  | 86400    |
+------------+-------------+----------+

# List id of available cron schedule
$ wp cron schedule list --fields=name --format=ids
hourly twicedaily daily

wp cron event unschedule

Unschedules all cron events for a given hook., _(*35)

wp cron event unschedule <hook>

OPTIONS, _(*36)

<hook>
    Name of the hook for which all events should be unscheduled.

EXAMPLES, _(*37)

# Unschedule a cron event on given hook.
$ wp cron event unschedule cron_test
Success: Unscheduled 2 events for hook 'cron_test'.

Installing

This package is included with WP-CLI itself, no additional installation necessary., _(*38)

To install the latest version of this package over what's included in WP-CLI, run:, _(*39)

wp package install git@github.com:wp-cli/cron-command.git

Contributing

We appreciate you taking the initiative to contribute to this project., _(*40)

Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation., _(*41)

For a more thorough introduction, check out WP-CLI's guide to contributing. This package follows those policy and guidelines., _(*42)

Reporting a bug

Think you’ve found a bug? We’d love for you to help us get it fixed., _(*43)

Before you create a new issue, you should search existing issues to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version., _(*44)

Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please create a new issue. Include as much detail as you can, and clear steps to reproduce if possible. For more guidance, review our bug report documentation., _(*45)

Creating a pull request

Want to contribute a new feature? Please first open a new issue to discuss whether the feature is a good fit for the project., _(*46)

Once you've decided to commit the time to seeing your pull request through, please follow our guidelines for creating a pull request to make sure it's a pleasant experience. See "Setting up" for details specific to working on this package locally., _(*47)

Support

GitHub issues aren't for general support questions, but there are other venues you can try: https://wp-cli.org/#support, _(*48)

This README.md is generated dynamically from the project's codebase using wp scaffold package-readme (doc). To suggest changes, please submit a pull request against the corresponding part of the codebase., _(*49)