Action Scheduler

https://github.com/woocommerce/action-scheduler
Admin
Action Scheduler is a scalable, traceable job queue for background processing large sets of actions...
Tokens:93,840
Snippets:727
Trust Score:8.9
License:GPL-3.0
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install WordPress and WP Unit Test lib with install.sh

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/tests/README.md

Installs WordPress and the WP Unit Test library. Arguments include database credentials and optional parameters for host, version, and skipping database creation. Quote strings with backslashes to prevent shell processing.

```bash
$ tests/bin/install.sh <db-name> <db-user> <db-password> [db-host] [wp-version] [skip-database-creation]
```

--------------------------------

### Install dependencies with composer install

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/tests/README.md

Installs PHPUnit and other dependencies required for running the unit tests.

```bash
$ composer install
```

--------------------------------

### Build the plugin with npm run build

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/AGENTS.md

Builds the plugin (output is a plugin zip file). Note that this reinstalls dependencies without dev packages (composer install --no-dev followed by npm install --only=prod), so PHPUnit, phpcs and phpcs-changed (which the three lint* scripts wrap) will be missing afterwards: run composer install again before testing or linting.

```bash
npm run build
```

--------------------------------

### Usage examples for Cron\CronExpression

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/lib/cron-expression/README.md

Shows how to use the CronExpression class: check if due, get next/previous run dates, handle complex expressions, skip iterations, and specify a reference time.

```php
<?php

require_once '/vendor/autoload.php';

// Works with predefined scheduling definitions
$cron = Cron\CronExpression::factory('@daily');
$cron->isDue();
echo $cron->getNextRunDate()->format('Y-m-d H:i:s');
echo $cron->getPreviousRunDate()->format('Y-m-d H:i:s');

// Works with complex expressions
$cron = Cron\CronExpression::factory('3-59/15 2,6-12 */15 1 2-5');
echo $cron->getNextRunDate()->format('Y-m-d H:i:s');

// Calculate a run date two iterations into the future
$cron = Cron\CronExpression::factory('@daily');
echo $cron->getNextRunDate(null, 2)->format('Y-m-d H:i:s');

// Calculate a run date relative to a specific time
$cron = Cron\CronExpression::factory('@monthly');
echo $cron->getNextRunDate('2010-01-12 00:00:00')->format('Y-m-d H:i:s');
```

--------------------------------

### Initiate Action Scheduler queue directly

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/faq.md

Use this method to start the queue manually without relying on WP-Cron.

```php
ActionScheduler::runner()->run();
```

--------------------------------

### Run unit tests with composer run test

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/tests/README.md

Runs the unit tests after dependencies and WordPress are installed.

```bash
$ composer run test
```

--------------------------------

### Use as_supports() to conditionally add action

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/api.md

Example usage of as_supports() to conditionally add an action to the 'action_scheduler_ensure_recurring_actions' hook. Only runs the add_action() call when the feature is supported, ensuring safe dependency on the hook.

```php
if ( as_supports( 'ensure_recurring_actions_hook' ) ) {
    // Safe to depend on the 'action_scheduler_ensure_recurring_actions' hook.
    add_action( 'action_scheduler_ensure_recurring_actions', 'my_plugin_schedule_my_recurring_action' );
}
```

--------------------------------

### Composer.json requirement for mtdowling/cron-expression

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/lib/cron-expression/README.md

Add this to your project's composer.json to install the cron-expression package version 1.0.*.

```json
{
    "require": {
        "mtdowling/cron-expression": "1.0.*"
    }
}
```

--------------------------------

### Trigger additional Action Scheduler runners via loopback requests

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/perf.md

Increases the number of queue runners by sending 5 loopback requests each time the 'action_scheduler_run_queue' action fires. The first function disables SSL verification and posts non-blocking requests to admin-ajax.php with a nonce; the second validates the nonce and starts a queue runner via ActionScheduler_QueueRunner::instance()->run(). Warning: this can easily take down a site and should only be used on high-powered servers after testing.

```php
/**
 * Trigger 5 additional loopback requests with unique URL params.
 */
function eg_request_additional_runners() {

	// allow self-signed SSL certificates
	add_filter( 'https_local_ssl_verify', '__return_false', 100 );

	for ( $i = 0; $i < 5; $i++ ) {
		$response = wp_remote_post( admin_url( 'admin-ajax.php' ), array(
			'method'      => 'POST',
			'timeout'     => 45,
			'redirection' => 5,
			'httpversion' => '1.0',
			'blocking'    => false,
			'headers'     => array(),
			'body'        => array(
				'action'     => 'eg_create_additional_runners',
				'instance'   => $i,
				'eg_nonce' => wp_create_nonce( 'eg_additional_runner_' . $i ),
			),
			'cookies'     => array(),
		) );
	}
}
add_action( 'action_scheduler_run_queue', 'eg_request_additional_runners', 0 );

/**
 * Handle requests initiated by eg_request_additional_runners() and start a queue runner if the request is valid.
 */
function eg_create_additional_runners() {

	if ( isset( $_POST['eg_nonce'] ) && isset( $_POST['instance'] ) && wp_verify_nonce( $_POST['eg_nonce'], 'eg_additional_runner_' . $_POST['instance'] ) ) {
		ActionScheduler_QueueRunner::instance()->run();
	}

	wp_die();
}
add_action( 'wp_ajax_nopriv_eg_create_additional_runners', 'eg_create_additional_runners', 0 );
```

--------------------------------

### Query custom table with $wpdb->prepare() and phpcs:ignore

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/AGENTS.md

Use this pattern when querying custom Action Scheduler tables. It interpolates the trusted $wpdb property directly and applies the existing phpcs:ignore convention for prepared SQL assembled in a variable. The example counts rows by status using prepare() and get_var().

```php
$sql = "SELECT COUNT(*) FROM {$wpdb->actionscheduler_actions} WHERE status = %s";
$sql = $wpdb->prepare( $sql, $status ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared

$count = (int) $wpdb->get_var( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
```

--------------------------------

### Customize Action Scheduler User-Agent with as_async_request_queue_runner_post_args filter

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/faq.md

Use this filter to modify the arguments sent to wp_remote_post, specifically to customize the User-Agent header. The example sets the User-Agent to include the latest Action Scheduler version.

```php
function eg_define_custom_user_agent( $args ) {
	$versions           = ActionScheduler_Versions::instance();
	$args['user-agent'] = 'Action Scheduler/' . $versions->latest_version();

	return $args;
}
add_filter( 'as_async_request_queue_runner_post_args', 'eg_define_custom_user_agent', 10, 1 );
```

--------------------------------

### Load Action Scheduler via action-scheduler.php

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/usage.md

Loads Action Scheduler by including its main file. No further initialization is required; the library registers its version and loads the most recent version on the site.

```php
<?php
require_once( plugin_dir_path( __FILE__ ) . '/libraries/action-scheduler/action-scheduler.php' );
```

--------------------------------

### Run tests with composer and PHPUnit

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/AGENTS.md

Run the test suite. The --filter option requires the -- separator; without it Composer errors out. The underlying PHPUnit command uses the tests path argument to scan that directory and ignore the <testsuites> declared in tests/phpunit.xml.dist; dropping it honors them instead. Both forms currently collect the same set, so keep them in step: a new test file outside the listed testsuites needs its own <file> entry or it will be silently skipped by the testsuite form.

```bash
composer run test
```

```bash
composer run test -- --filter Class_Name_to_Match
```

```bash
./vendor/bin/phpunit tests -c tests/phpunit.xml.dist
```

--------------------------------

### Enable migration from custom data store with action_scheduler_migrate_data_store filter

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/version3-0.md

Add this filter to allow migration from any custom data store. By default, migration only initiates from the internal WPPostStore data store.

```php
add_filter( 'action_scheduler_migrate_data_store', '__return_true' );
```

--------------------------------

### Open changelog block format

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/AGENTS.md

Format for the open changelog block in ./changelog.txt. x.y.z should be the next expected version and xxxx-xx-xx is literally written until overwritten with the actual release date during release prep.

```text
= x.y.z - xxxx-xx-xx =
* Individual changelog entry
```

--------------------------------

### Passing arguments to callbacks with as_schedule_single_action()

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/usage.md

Shows how to pass arguments to a callback: supply them as an array when scheduling, and the callback receives each item as an individual parameter. The number of arguments must be specified in add_action().

```php
// You must specify the number of arguments to be accepted (in this case, 2).
add_action( 'purchase_notification', 'send_purchase_notification', 10, 2 );

// When scheduling the action, provide the arguments as an array.
as_schedule_single_action( time(), 'purchase_notification', array(
    'bob@foo.bar',
    'Learning Action Scheduler (e-book)',
) );

// Your callback should accept the appropriate number of parameters (again, in this case, 2).
function send_purchase_notification( $customer_email, $purchased_item ) {
    wp_mail( 
        $customer_email,
        'Thank you!',
        "You purchased $purchased_item successfully."
    );
}
```

--------------------------------

### Run tests with WP_TESTS_DIR set

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/AGENTS.md

Set the WP_TESTS_DIR environment variable to the WordPress test library path and run the test suite or a specific test class. The first command runs the full suite via Composer, the second runs PHPUnit directly with a filter. Both are valid because Composer passes the environment through to its scripts.

```bash
WP_TESTS_DIR=/path/to/wordpress-tests-lib composer run test
```

```bash
WP_TESTS_DIR=/path/to/wordpress-tests-lib ./vendor/bin/phpunit tests -c tests/phpunit.xml.dist --filter Class_Name_to_Match
```

--------------------------------

### Create wp_actionscheduler_actions table

Source: https://github.com/woocommerce/action-scheduler/wiki/Schema-Definitions

Creates the wp_actionscheduler_actions table used by the default DBStore. Includes indexes on hook, status, scheduled_date_gmt, args, group_id, last_attempt_gmt, and a composite index on claim_id, status, and scheduled_date_gmt.

```sql
CREATE TABLE wp_actionscheduler_actions (
    action_id bigint(20) unsigned NOT NULL auto_increment,
    hook varchar(191) NOT NULL,
    status varchar(20) NOT NULL,
    scheduled_date_gmt datetime NULL default '0000-00-00 00:00:00',
    scheduled_date_local datetime NULL default '0000-00-00 00:00:00',
    priority tinyint unsigned NOT NULL default '10',
    args varchar(191),
    schedule longtext,
    group_id bigint(20) unsigned NOT NULL default '0',
    attempts int(11) NOT NULL default '0',
    last_attempt_gmt datetime NULL default '0000-00-00 00:00:00',
    last_attempt_local datetime NULL default '0000-00-00 00:00:00',
    claim_id bigint(20) unsigned NOT NULL default '0',
    extended_args varchar(8000) DEFAULT NULL,
    PRIMARY KEY  (action_id),
    KEY hook (hook(191)),
    KEY status (status),
    KEY scheduled_date_gmt (scheduled_date_gmt),
    KEY args (args(191)),
    KEY group_id (group_id),
    KEY last_attempt_gmt (last_attempt_gmt),
    KEY `claim_id_status_scheduled_date_gmt` (`claim_id`, `status`, `scheduled_date_gmt`)
);
```

--------------------------------

### Run phpcbf to fix linting errors

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/AGENTS.md

Corrects linting errors where possible.

```bash
composer run phpcbf
```

--------------------------------

### Run phpcs linting

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/AGENTS.md

Run PHP CodeSniffer linting. Passing a file path lints a single file.

```bash
composer run phpcs
```

```bash
composer run phpcs path/to/file.php
```

--------------------------------

### Postpone migration with action_scheduler_migration_dependencies_met filter

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/version3-0.md

Use this filter to prevent migration from initiating until testing is complete. Recommended to migrate as soon as possible for performance reasons.

```php
add_filter( 'action_scheduler_migration_dependencies_met', '__return_false' );
```

--------------------------------

### as_enqueue_async_action()

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/api.md

Function to enqueue an asynchronous action to run as soon as possible.

```APIDOC
## as_enqueue_async_action()

### Description
Enqueue an action to run one time, as soon as possible.

### Usage
```php
as_enqueue_async_action( $hook, $args, $group, $unique, $priority );
```

### Parameters
- **$hook** (string) - Required - Name of the action hook.
- **$args** (array) - Optional - Arguments to pass to callbacks when the hook triggers. Default: `array()`.
- **$group** (string) - Optional - The group to assign this job to. Default: `''`.
- **$unique** (boolean) - Optional - Whether the action should be unique. Default: `false`.
- **$priority** (integer) - Optional - Lower values take precedence over higher values. Defaults to 10, with acceptable values falling in the range 0-255.

### Return Value
`(integer)` the action's ID. Zero if there was an error scheduling the action. The error will be sent to `error_log`.
```

--------------------------------

### Backward compatible recurring action scheduling with as_supports()

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/usage.md

Schedules a recurring action if not already scheduled, and adds hooks to ensure it remains scheduled. Uses as_supports() to check for the ensure hook, with a fallback for admin requests.

```php
/**
 * Schedules the plugin's recurring action if it is not already scheduled.
 */
function my_plugin_schedule_my_recurring_action() {
	if ( ! as_has_scheduled_action( 'my_plugin_recurring_action' ) ) {
		as_schedule_recurring_action(
			time(),
			HOUR_IN_SECONDS,
			'my_plugin_recurring_action'
		);
	}
}

/**
 * Add the hooks needed for my_plugin_schedule_my_recurring_action() so it can make sure our hook stays scheduled.
 */
add_action( 'init', function () {
	if ( function_exists( 'as_supports' ) && as_supports( 'ensure_recurring_actions_hook' ) ) {
		// Preferred: runs periodically in the background.
		add_action( 'action_scheduler_ensure_recurring_actions', 'my_plugin_schedule_my_recurring_action' );
	} elseif ( is_admin() ) {
		// Fallback: runs on every admin request.
		my_plugin_schedule_my_recurring_action();
	}
} );
```

--------------------------------

### Run lint on unstaged changes

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/AGENTS.md

Run phpcs against PHP files with unstaged changes.

```bash
composer run lint
```

--------------------------------

### Run lint-branch on branch changes

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/AGENTS.md

Run phpcs against PHP files changed on the current branch compared to its base branch (defaults to origin/trunk; pass an alternative base as an argument).

```bash
composer run lint-branch
```

--------------------------------

### Run lint-staged on staged changes

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/AGENTS.md

Run phpcs against PHP files with staged changes.

```bash
composer run lint-staged
```

--------------------------------

### 'action_scheduler_init' action hook

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/api.md

Action hook fired after Action Scheduler initialization, indicating it is safe to use API functions.

```APIDOC
## 'action_scheduler_init' action hook

### Description
An action hook that fires after the Action Scheduler data stores have been initialized. It is safe to call API functions during or after this event has fired.

### Method
Action Hook

### Endpoint
`do_action( 'action_scheduler_init' )`

### Parameters
None

### Usage
```php
add_action( 'action_scheduler_init', function() {
    // Safe to call API functions
} );
```
```

--------------------------------

### Register a custom Action Scheduler store

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/faq.md

Use the action_scheduler_store_class filter to specify a custom class for managing data storage.

```php
function eg_define_custom_store( $existing_storage_class ) {
	return 'My_Radical_Action_Scheduler_Store';
}
add_filter( 'action_scheduler_store_class', 'eg_define_custom_store', 10, 1 );
```

--------------------------------

### Create wp_actionscheduler_log table

Source: https://github.com/woocommerce/action-scheduler/wiki/Schema-Definitions

Creates the wp_actionscheduler_log table used by the default DBStore. Stores log messages for actions with indexes on action_id and log_date_gmt.

```sql
CREATE TABLE wp_actionscheduler_log (
    log_id bigint(20) unsigned NOT NULL auto_increment,
    action_id bigint(20) unsigned NOT NULL,
    message text NOT NULL,
    log_date_gmt datetime NULL default '0000-00-00 00:00:00',
    log_date_local datetime NULL default '0000-00-00 00:00:00',
    PRIMARY KEY  (log_id),
    KEY action_id (action_id),
    KEY log_date_gmt (log_date_gmt)
);
```

--------------------------------

### Create wp_actionscheduler_claims table

Source: https://github.com/woocommerce/action-scheduler/wiki/Schema-Definitions

Creates the wp_actionscheduler_claims table used by the default DBStore. Stores claim IDs and their creation timestamps in GMT.

```sql
CREATE TABLE wp_actionscheduler_claims (
    claim_id bigint(20) unsigned NOT NULL auto_increment,
    date_created_gmt datetime NULL default '0000-00-00 00:00:00',
    PRIMARY KEY  (claim_id),
    KEY date_created_gmt (date_created_gmt)
);
```

--------------------------------

### Update Action Scheduler Subtree

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/usage.md

Updates the Action Scheduler subtree to the latest trunk version by fetching the remote and pulling the changes with --squash.

```bash
git fetch subtree-action-scheduler trunk
git subtree pull --prefix libraries/action-scheduler subtree-action-scheduler trunk --squash
```

--------------------------------

### Trigger Action Scheduler queue via hook

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/faq.md

Trigger the queue execution by firing the action_scheduler_run_queue hook.

```php
do_action( 'action_scheduler_run_queue', $context_identifier );
```

--------------------------------

### Add Action Scheduler as a Git Subtree

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/usage.md

Adds the trunk branch of Action Scheduler to the 'libraries/action-scheduler' folder. Change the --prefix to alter the destination or replace 'trunk' with a tag like '2.1.0' for a stable version.

```bash
git subtree add --prefix libraries/action-scheduler subtree-action-scheduler trunk --squash
```

--------------------------------

### as_schedule_single_action()

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/api.md

Schedules a single action to run once at a specified future time.

```APIDOC
## as_schedule_single_action()

### Description
Schedules an action to run one time at a specified time in the future. This function mirrors the WP-Cron `wp_schedule_single_event()` function but returns the ID of the scheduled action instead of a boolean.

### Method
Function

### Endpoint
`as_schedule_single_action( $timestamp, $hook, $args = array(), $group = '' )`

### Parameters
- **$timestamp** (int) - Required - The Unix timestamp when the action should run.
- **$hook** (string) - Required - The hook name to trigger.
- **$args** (array) - Optional - Arguments to pass to the hook callback.
- **$group** (string) - Optional - A group to assign the action to, allowing grouping of actions for a plugin.

### Return Value
- (int) - The ID of the scheduled action.

### Example
```php
$action_id = as_schedule_single_action( strtotime( 'tomorrow' ), 'my_custom_hook', array( 'foo' => 'bar' ), 'my_group' );
```
```

--------------------------------

### as_schedule_cron_action()

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/api.md

Schedules an action that recurs on a cron-like schedule. Returns the action ID or zero on error.

```APIDOC
## as_schedule_cron_action()

### Description
Schedule an action that recurs on a cron-like schedule.

If execution of a cron-like action is delayed, the next attempt will still be scheduled according to the provided cron expression.

### Usage
```php
as_schedule_cron_action( $timestamp, $schedule, $hook, $args, $group, $unique, $priority );
```

### Parameters
- **$timestamp** (integer) - Required - The Unix timestamp representing the date you want the action to run.
- **$schedule** (string) - Required - A cron-like schedule string, see http://en.wikipedia.org/wiki/Cron.
- **$hook** (string) - Required - Name of the action hook.
- **$args** (array) - Optional - Arguments to pass to callbacks when the hook triggers. Default: `array()`.
- **$group** (string) - Optional - The group to assign this job to. Default: ''.
- **$unique** (boolean) - Optional - Whether the action should be unique. Default: `false`.
- **$priority** (integer) - Optional - Lower values take precedence over higher values. Defaults to 10, with acceptable values falling in the range 0-255.

### Return Value
`(integer)` the action's ID. Zero if there was an error scheduling the action. The error will be sent to `error_log`.
```

--------------------------------

### as_schedule_single_action()

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/api.md

Function to schedule a single action to run at a specific future time.

```APIDOC
## as_schedule_single_action()

### Description
Schedule an action to run one time at some defined point in the future.

### Usage
```php
as_schedule_single_action( $timestamp, $hook, $args, $group, $unique, $priority );
```

### Parameters
- **$timestamp** (integer) - Required - The Unix timestamp representing the date you want the action to run.
- **$hook** (string) - Required - Name of the action hook.
- **$args** (array) - Optional - Arguments to pass to callbacks when the hook triggers. Default: `array()`.
- **$group** (string) - Optional - The group to assign this job to. Default: `''`.
- **$unique** (boolean) - Optional - Whether the action should be unique. Default: `false`.
- **$priority** (integer) - Optional - Lower values take precedence over higher values. Defaults to 10, with acceptable values falling in the range 0-255.

### Return Value
`(integer)` the action's ID. Zero if there was an error scheduling the action. The error will be sent to `error_log`.
```

--------------------------------

### Action_Scheduler::is_initialized()

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/api.md

Checks if the Action Scheduler data stores are initialized.

```APIDOC
## Action_Scheduler::is_initialized()

### Description
Checks whether the Action Scheduler data stores have been initialized. This is useful in hooks to confirm that it is safe to call API functions.

### Method
Static Method

### Endpoint
`Action_Scheduler::is_initialized()`

### Parameters
None

### Return Value
- (bool) - True if the data stores have been initialized, false otherwise.

### Example
```php
if ( Action_Scheduler::is_initialized() ) {
    // Safe to call API functions
}
```
```

--------------------------------

### Create wp_actionscheduler_groups table

Source: https://github.com/woocommerce/action-scheduler/wiki/Schema-Definitions

Creates the wp_actionscheduler_groups table used by the default DBStore. Stores group slugs with an index on the first 191 characters.

```sql
CREATE TABLE wp_actionscheduler_groups (
    group_id bigint(20) unsigned NOT NULL auto_increment,
    slug varchar(255) NOT NULL,
    PRIMARY KEY  (group_id),
    KEY slug (slug(191))
);
```

--------------------------------

### as_next_scheduled_action()

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/api.md

Returns the next timestamp for a scheduled action. Accepts the hook name, optional arguments, and optional group.

```APIDOC
## as_next_scheduled_action()

### Description
Returns the next timestamp for a scheduled action.

### Usage
```php
as_next_scheduled_action( $hook, $args, $group );
```

### Parameters
- **$hook** (string) - Required - Name of the action hook.
- **$args** (array) - Optional - Arguments passed to callbacks when the hook triggers. Default: `array()`.
- **$group** (string) - Optional - The group the job is assigned to. Default: `''`.

### Return Value
`(integer|boolean)` The timestamp for the next occurrence of a pending scheduled action, true for an async or in-progress action or false if there is no matching action.
```

--------------------------------

### Add Action Scheduler Repository as a Git Remote

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/usage.md

Adds the Action Scheduler repository as a remote named 'subtree-action-scheduler' to allow short references in subsequent subtree commands.

```bash
git remote add -f subtree-action-scheduler https://github.com/woocommerce/action-scheduler.git
```

--------------------------------

### Check feature support with as_supports()

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/api.md

Checks if a specific feature is supported by the current version of Action Scheduler. Available since 3.9.3. The $feature parameter is a string; currently supported values are 'ensure_recurring_actions_hook' and 'uninstall_bootstrap'. Returns a boolean: true if the feature is supported, false otherwise.

```php
as_supports( $feature );
```

--------------------------------

### Increase batch size with action_scheduler_queue_runner_batch_size filter

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/perf.md

Increases the number of actions claimed per batch from the default of 25 to 100. Use this when actions process quickly or you have more than 30 seconds available per batch, as claiming batches has overhead.

```php
function eg_increase_action_scheduler_batch_size( $batch_size ) {
	return 100;
}
add_filter( 'action_scheduler_queue_runner_batch_size', 'eg_increase_action_scheduler_batch_size' );
```

--------------------------------

### Increase concurrent batches with action_scheduler_queue_runner_concurrent_batches filter

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/perf.md

Increases the number of concurrent batches from the default of 1 to 10. Use when your server allows many connections (e.g., high MaxClients or pm.max_children). Warning: with the async queue runner (Action Scheduler 3.0+), this can substantially increase server load and take down a site; WP CLI is a better method for higher throughput.

```php
function eg_increase_action_scheduler_concurrent_batches( $concurrent_batches ) {
	return 10;
}
add_filter( 'action_scheduler_queue_runner_concurrent_batches', 'eg_increase_action_scheduler_concurrent_batches' );
```

--------------------------------

### Clean failed actions via WP CLI

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/perf.md

WP CLI command to clean failed actions with a batch size of 50, before 90 days ago, and a pause of 2 seconds.

```shell
// Example
wp action-scheduler clean --status=failed --batch-size=50 --before='90 days ago' --pause=2
```

--------------------------------

### as_schedule_recurring_action()

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/api.md

Schedules a recurring action to run at a specified interval.

```APIDOC
## as_schedule_recurring_action()

### Description
Schedules an action to run repeatedly at a specified interval. This function mirrors the WP-Cron `wp_schedule_event()` function but returns the ID of the scheduled action and accepts an interval in seconds.

### Method
Function

### Endpoint
`as_schedule_recurring_action( $timestamp, $interval_in_seconds, $hook, $args = array(), $group = '' )`

### Parameters
- **$timestamp** (int) - Required - The Unix timestamp when the first instance of the action should run.
- **$interval_in_seconds** (int) - Required - The number of seconds between each recurrence.
- **$hook** (string) - Required - The hook name to trigger.
- **$args** (array) - Optional - Arguments to pass to the hook callback.
- **$group** (string) - Optional - A group to assign the action to.

### Return Value
- (int) - The ID of the scheduled action.

### Example
```php
$action_id = as_schedule_recurring_action( strtotime( 'tomorrow' ), 3600, 'my_custom_hook', array(), 'my_group' );
```
```

--------------------------------

### Customize Action Scheduler logger class with action_scheduler_logger_class filter

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/faq.md

Use this filter to replace the default logger class with a custom one. The callback receives the existing storage class and must return the class name of your custom logger, which should extend the abstract ActionScheduler_Logger class.

```php
function eg_define_custom_logger( $existing_storage_class ) {
	return 'My_Radical_Action_Scheduler_Logger';
}
add_filter( 'action_scheduler_logger_class', 'eg_define_custom_logger', 10, 1 );
```

--------------------------------

### as_schedule_recurring_action()

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/api.md

Schedules an action to run repeatedly with a specified interval in seconds. Returns the action ID or zero on error.

```APIDOC
## as_schedule_recurring_action()

### Description
Schedule an action to run repeatedly with a specified interval in seconds.

### Usage
```php
as_schedule_recurring_action( $timestamp, $interval_in_seconds, $hook, $args, $group, $unique, $priority );
```

### Parameters
- **$timestamp** (integer) - Required - The Unix timestamp representing the date you want the action to run.
- **$interval_in_seconds** (integer) - Required - How long to wait between runs.
- **$hook** (string) - Required - Name of the action hook.
- **$args** (array) - Optional - Arguments to pass to callbacks when the hook triggers. Default: `array()`.
- **$group** (string) - Optional - The group to assign this job to. Default: ''.
- **$unique** (boolean) - Optional - Whether the action should be unique. Default: `false`.
- **$priority** (integer) - Optional - Lower values take precedence over higher values. Defaults to 10, with acceptable values falling in the range 0-255.

### Return Value
`(integer)` the action's ID. Zero if there was an error scheduling the action. The error will be sent to `error_log`.
```

--------------------------------

### as_get_scheduled_actions()

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/api.md

Find scheduled actions based on various filter arguments.

```APIDOC
## as_get_scheduled_actions()

### Description
Find scheduled actions.

### Usage
```php
as_get_scheduled_actions( $args, $return_format );
```

### Parameters
- **$args** (array) - Arguments to search and filter results by. Possible arguments, with their default values:
  - `'hook' => ''` - the name of the action that will be triggered
  - `'args' => NULL` - the args array that will be passed with the action
  - `'date' => NULL` - the scheduled date of the action. Expects a DateTime object, a unix timestamp, or a string that can parsed with strtotime().
  - `'date_compare' => '<='` - operator for testing "date". accepted values are '!=', '>', '>=', '<', '<=', '='
  - `'modified' => NULL` - the date the action was last updated. Expects a DateTime object, a unix timestamp, or a string that can parsed with strtotime().
  - `'modified_compare' => '<='` - operator for testing "modified". accepted values are '!=', '>', '>=', '<', '<=', '='
  - `'group' => ''` - the group the action belongs to
  - `'status' => ''` - ActionScheduler_Store::STATUS_COMPLETE or ActionScheduler_Store::STATUS_PENDING
  - `'claimed' => NULL` - TRUE to find claimed actions, FALSE to find unclaimed actions, a string to find a specific claim ID
  - `'per_page' => 5` - Number of results to return
  - `'offset' => 0`
  - `'orderby' => 'date'` - accepted values are 'hook', 'group', 'modified', or 'date'
  - `'order' => 'ASC'`
- **$return_format** (string) - The format in which to return the scheduled actions: 'OBJECT', 'ARRAY_A', or 'ids'. Default: 'OBJECT'.

### Return Value
- (array) - Array of action rows matching the criteria specified with `$args`.
```

--------------------------------

### Uninstall Action Scheduler in uninstall.php

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/usage.md

Use this snippet in your plugin's uninstall.php to load Action Scheduler and cancel your own scheduled actions. It checks if Action Scheduler is already loaded, requires the library, and unschedules all actions for your plugin. For versions before 4.2.0, it also unhooks the async request dispatcher if the default runner is used.

```php
<?php
// Another still-active plugin may already have loaded Action Scheduler for this request,
// or it may have been bootstrapped by an inactive plugin that was also being uninstalled.
$as_already_loaded = class_exists( 'ActionScheduler', false );

require_once plugin_dir_path( __FILE__ ) . '/libraries/action-scheduler/action-scheduler.php';

as_unschedule_all_actions( 'my_plugin_recurring_action' );

// Versions before 4.2.0 set up the runtime here too, and their async request dispatcher runs on
// 'shutdown' - by which point WordPress has deleted this plugin's files, so the request fatals.
if ( ! $as_already_loaded && ! ( function_exists( 'as_supports' ) && as_supports( 'uninstall_bootstrap' ) ) ) {
	$runner = ActionScheduler::runner();

	// A site can swap the runner via 'action_scheduler_queue_runner_class'; only the default one has this method.
	if ( method_exists( $runner, 'unhook_dispatch_async_request' ) ) {
		$runner->unhook_dispatch_async_request();
	}
}
```

--------------------------------

### Increase async request delay with action_scheduler_async_request_sleep_seconds filter

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/version3-0.md

Increases the delay between admin-ajax.php?action=as_async_request_queue requests. The default is 1 second in 3.0.X and 5 seconds in 3.1.X. Remove this filter after migration completes.

```php
add_filter( 'action_scheduler_async_request_sleep_seconds', function( $sleep ) {
	return 10;
} );
```

--------------------------------

### Customize failed action retention period

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/perf.md

Customizes the retention period for failed actions. The filter returns the retention period in seconds; zero purges on the next cleanup pass and negative values are treated as zero.

```php
add_filter( 'action_scheduler_retention_period_for_failed', function( $retention_period ) {
    return 12 * MONTH_IN_SECONDS;
} );
```

--------------------------------

### Schedule recurring action on plugin activation

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/usage.md

Schedules a recurring action if it is not already scheduled, using as_has_scheduled_action() and as_schedule_recurring_action(). Registered with register_activation_hook().

```php
/**
 * Schedule recurring action on plugin activation.
 */
function my_plugin_activate() {
    if ( ! as_has_scheduled_action( 'my_plugin_recurring_action' ) ) {
        as_schedule_recurring_action(
            time(),
            HOUR_IN_SECONDS,
            'my_plugin_recurring_action'
        );
    }
}
register_activation_hook( __FILE__, 'my_plugin_activate' );
```

--------------------------------

### Disable async request runner with action_scheduler_allow_async_request_runner filter

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/version3-0.md

Disables the async queue runner during migration to reduce load. Remove this filter after migration completes.

```php
add_filter( 'action_scheduler_allow_async_request_runner', '__return_false' );
```

--------------------------------

### Ensure recurring action remains scheduled using action_scheduler_ensure_recurring_actions

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/usage.md

Adds an action to the action_scheduler_ensure_recurring_actions hook to check and reschedule the recurring action if it is missing.

```php
/**
 * Ensure recurring action remains scheduled.
 */
add_action( 'action_scheduler_ensure_recurring_actions', function() {
    if ( ! as_has_scheduled_action( 'my_plugin_recurring_action' ) ) {
        as_schedule_recurring_action(
            time(),
            HOUR_IN_SECONDS,
            'my_plugin_recurring_action'
        );
    }
});
```

--------------------------------

### Include failed status in purge statuses

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/perf.md

Adds the failed status to the list of statuses to purge, enabling automatic deletion of failed actions prior to version 4.0.0.

```php
add_filter( 'action_scheduler_default_cleaner_statuses', function( $statuses ) {
    $statuses[] = ActionScheduler_Store::STATUS_FAILED;
    return $statuses;
} );
```

--------------------------------

### Disable failed action cleanup

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/perf.md

Disables failed action cleanup entirely, retaining failed actions indefinitely (the pre-4.0.0 behavior).

```php
add_filter( 'action_scheduler_enable_failed_action_cleanup', '__return_false' );
```

--------------------------------

### Increase Action Scheduler Time Limit to 120 Seconds

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/perf.md

Increases the Action Scheduler queue runner time limit to 120 seconds by filtering the 'action_scheduler_queue_runner_time_limit' hook. Use when your host supports longer web request timeouts, such as Pantheon or SiteGround (120 seconds) or WP Engine (60 seconds).

```php
function eg_increase_time_limit( $time_limit ) {
	return 120;
}
add_filter( 'action_scheduler_queue_runner_time_limit', 'eg_increase_time_limit' );
```

--------------------------------

### as_unschedule_action()

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/api.md

Cancels the next occurrence of a scheduled action. Accepts the hook name, optional arguments, and optional group.

```APIDOC
## as_unschedule_action()

### Description
Cancel the next occurrence of a scheduled action.

### Usage
```php
as_unschedule_action( $hook, $args, $group );
```

### Parameters
- **$hook** (string) - Required - Name of the action hook.
- **$args** (array) - Optional - Arguments passed to callbacks when the hook triggers. Default: `array()`.
- **$group** (string) - Optional - The group the job is assigned to. Default: `''`.

### Return Value
`(null)`
```

--------------------------------

### as_has_scheduled_action()

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/api.md

Check if a specific action is currently scheduled in the queue.

```APIDOC
## as_has_scheduled_action()

### Description
Check if there is a scheduled action in the queue, but more efficiently than as_next_scheduled_action(). It's recommended to use this function when you need to know whether a specific action is currently scheduled. Available since 3.3.0.

### Usage
```php
as_has_scheduled_action( $hook, $args, $group );
```

### Parameters
- **$hook** (string) (required) - Name of the action hook. Default: none.
- **$args** (array) - Arguments passed to callbacks when the hook triggers. Default: `array()`.
- **$group** (string) - The group the job is assigned to. Default: ''.

### Return Value
- (boolean) - True if a matching action is pending or in-progress, false otherwise.
```

--------------------------------

### as_unschedule_all_actions()

Source: https://github.com/woocommerce/action-scheduler/blob/trunk/docs/api.md

Cancels all occurrences of a scheduled action. Accepts the hook name, optional arguments, and optional group.

```APIDOC
## as_unschedule_all_actions()

### Description
Cancel all occurrences of a scheduled action.

### Usage
```php
as_unschedule_all_actions( $hook, $args, $group )
```

### Parameters
- **$hook** (string) - Required - Name of the action hook.
- **$args** (array) - Optional - Arguments passed to callbacks when the hook triggers. Default: `array()`.
- **$group** (string) - Optional - The group the job is assigned to. Default: `''`.

### Return Value
`(string|null)` The scheduled action ID if a scheduled action was found, or null if no matching action found.
```
Tokens:
Raw