### Schedule Action with Arguments

Source: https://actionscheduler.org/usage

This example demonstrates how to schedule a single action with arguments and how the callback function should accept and use these arguments.

```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."
    );
}


```

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

### Clean Failed Actions Using WP-CLI

Source: https://actionscheduler.org/perf

This example demonstrates how to use the WP-CLI command to clean up failed actions, specifying the status, batch size, and a time before which actions should be purged.

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

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

### Ensure Recurring Action Remains Scheduled Using Hook

Source: https://actionscheduler.org/usage

This example demonstrates using the `action_scheduler_ensure_recurring_actions` hook to periodically check and reschedule a recurring action if it has been lost.

```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'
        );
    }
});

```

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

### Get Next Scheduled Action Timestamp

Source: https://actionscheduler.org/api

Returns the timestamp for the next occurrence of a pending scheduled action. Useful for checking when an action is next due to run.

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

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

### Enable Migration from Any Custom Datastore

Source: https://actionscheduler.org/version3-0

Add this filter to allow Action Scheduler to initiate migration from any custom datastore, not just the internal WPPostStore.

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

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

### Enqueue an action to run once, as soon as possible

Source: https://actionscheduler.org/api

Use `as_enqueue_async_action` to schedule a single action to run at the earliest opportunity. It accepts the hook name, arguments, an optional group, a boolean for uniqueness, and a priority.

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

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

### Run Action Scheduler Queue Directly

Source: https://actionscheduler.org/faq

Initiate the Action Scheduler queue directly by calling this method. This is an alternative to relying on WP-Cron.

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

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

### Initiate Additional Loopback Requests for Runners

Source: https://actionscheduler.org/perf

This snippet demonstrates how to create multiple loopback requests to initiate additional queue runners when the 'action_scheduler_run_queue' action is triggered. It's useful for handling larger queues on powerful servers but should be used with caution due to potential site performance impacts.

```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 );

```

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

### Check Feature Support

Source: https://actionscheduler.org/api

Use `as_supports()` to determine if a specific feature is available in the current Action Scheduler version. This is useful for conditionally adding actions or implementing fallback logic.

```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' );
}
```

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

### as_enqueue_async_action()

Source: https://actionscheduler.org/api

Enqueues an action to run once as soon as possible. This function is suitable for immediate background processing tasks.

```APIDOC
## Function Reference / `as_enqueue_async_action()`

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

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

```

### Parameters
  * **$hook** (string)(required) Name of the action hook.
  * **$args** (array) Arguments to pass to callbacks when the hook triggers. Default: _`array()`_.
  * **$group** (string) The group to assign this job to. Default: _'’_.
  * **$unique** (boolean) Whether the action should be unique. Default: _`false`_.
  * **$priority** (integer) 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`.
```

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

### Load Action Scheduler Library in WordPress

Source: https://actionscheduler.org/usage

This PHP code snippet demonstrates how to include the Action Scheduler library within your WordPress plugin or theme. It ensures the library is loaded before the 'plugins_loaded' hook with priority 0, which is crucial for its initialization.

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


```

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

### as_supports()

Source: https://actionscheduler.org/api

Checks if a specific feature is supported by the current version of Action Scheduler. Available since 3.9.3.

```APIDOC
## Function Reference / `as_supports()`

### Description
Check if a specific feature is supported by the current version of Action Scheduler.
_Available since 3.9.3._

### Usage
```
as_supports( $feature );

```

### Parameters
**$feature** (string) (required)  
The feature to check support for.  
Currently supported:
  * `'ensure_recurring_actions_hook'` — Indicates support for the `action_scheduler_ensure_recurring_actions` hook.


### Return value
(boolean)  
True if the feature is supported, false otherwise.

### Example
```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' );
}

```
```

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

### Schedule a single action for a future timestamp

Source: https://actionscheduler.org/api

Use `as_schedule_single_action` to schedule an action to run at a specific future Unix timestamp. You can specify the hook, arguments, group, uniqueness, and priority.

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

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

### Schedule a One-Time Action

Source: https://actionscheduler.org/api

Schedule a single action to run at a specific timestamp. This is useful for one-off tasks.

```php
as_schedule_action( $timestamp, $hook, $args, $group, $unique, $priority );
```

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

### Add Action Scheduler Repository as a Git Subtree

Source: https://actionscheduler.org/usage

This command adds the 'trunk' branch of the Action Scheduler repository as a subtree to your project's 'libraries/action-scheduler' directory. The --squash flag helps keep the history clean. You can specify a different prefix or a specific tag for version control.

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

```

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

### as_schedule_action()

Source: https://actionscheduler.org/api

Schedules a single action to run at a specific time. This function is used for one-off tasks.

```APIDOC
## Function Reference / `as_schedule_action()`

### Description
Schedule a single action to run. This is useful for one-off actions.

### Usage
```
as_schedule_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) Arguments to pass to callbacks when the hook triggers. Default: _`array()`_.
  * **$group** (string) The group to assign this job to. Default: _'’_.
  * **$unique** (boolean) Whether the action should be unique. Default: _`false`_.
  * **$priority** (integer) 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`.
```

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

### Schedule a recurring action with a specified interval

Source: https://actionscheduler.org/api

Use `as_schedule_recurring_action` to schedule an action that will repeat at a defined interval in seconds. Parameters include the initial timestamp, interval, hook, arguments, group, uniqueness, and priority.

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

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

### Define a Custom Action Scheduler Logger

Source: https://actionscheduler.org/faq

Implement a custom logger by extending the abstract ActionScheduler_Logger class and filtering the logger class used by Action Scheduler.

```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_single_action()

Source: https://actionscheduler.org/api

Schedules a single action to run at a specific future timestamp. This is used for one-off tasks that need to be executed at a precise time.

```APIDOC
## Function Reference / `as_schedule_single_action()`

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

### Usage
```
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) Arguments to pass to callbacks when the hook triggers. Default: _`array()`_.
  * **$group** (string) The group to assign this job to. Default: _'’_.
  * **$unique** (boolean) Whether the action should be unique. Default: _`false`_.
  * **$priority** (integer) 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`.
```

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

### Retrieve Scheduled Actions

Source: https://actionscheduler.org/api

Find scheduled actions based on provided arguments. This function allows querying the queue for specific actions.

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

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

### as_schedule_cron_action()

Source: https://actionscheduler.org/api

Schedules an action that recurs on a cron-like schedule. Useful for recurring tasks.

```APIDOC
## Function Reference / `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
```
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) $schedule A cron-like schedule string, see http://en.wikipedia.org/wiki/Cron.
  * **$hook** (string)(required) Name of the action hook.
  * **$args** (array) Arguments to pass to callbacks when the hook triggers. Default: _`array()`_.
  * **$group** (string) The group to assign this job to. Default: _'’_.
  * **$unique** (boolean) Whether the action should be unique. Default: _`false`_.
  * **$priority** (integer) 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`.
```

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

### Update Action Scheduler Git Subtree

Source: https://actionscheduler.org/usage

These commands fetch the latest changes from the Action Scheduler trunk and then pull them into your project's subtree, ensuring you have the most recent version. Use this to update Action Scheduler to a new release.

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

```

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

### Backward Compatible Recurring Action Scheduling

Source: https://actionscheduler.org/usage

This snippet provides a backward-compatible way to ensure a recurring action remains scheduled, checking for Action Scheduler version support before applying hooks.

```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();
	}
} );

```

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

### Postpone Action Scheduler Migration

Source: https://actionscheduler.org/version3-0

Use this filter to prevent the migration process from initiating, allowing for postponed migration after testing.

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

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

### as_get_scheduled_actions()

Source: https://actionscheduler.org/api

Retrieves a list of scheduled actions based on specified arguments.

```APIDOC
## Function Reference / `as_get_scheduled_actions()`

### Description
Find scheduled actions.

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

```
```

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

### Implement Custom Action Scheduler Storage

Source: https://actionscheduler.org/faq

To use a custom storage mechanism for Action Scheduler, extend the abstract 'ActionScheduler_Store' class and register your custom class using the 'action_scheduler_store_class' filter.

```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 );
```

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

### Add Action Scheduler Repository as a Git Remote

Source: https://actionscheduler.org/usage

This command adds the Action Scheduler GitHub repository as a remote to your local Git repository, allowing you to manage it as a subtree. Use this when integrating Action Scheduler as a library.

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

```

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

### as_schedule_recurring_action()

Source: https://actionscheduler.org/api

Schedules an action to run repeatedly at a specified interval in seconds. Ideal for tasks that need to be performed on a regular schedule.

```APIDOC
## Function Reference / `as_schedule_recurring_action()`

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

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

```
```

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

### Schedule Recurring Action on Plugin Activation

Source: https://actionscheduler.org/usage

This snippet shows how to schedule a recurring action when a plugin is activated. It checks if the action is already scheduled before creating it.

```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' );

```

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

### Trigger Action Scheduler Queue via Hook

Source: https://actionscheduler.org/faq

Trigger the Action Scheduler queue by using the 'action_scheduler_run_queue' hook. This allows Action Scheduler to manage the queue execution.

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

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

### Increase Action Scheduler Concurrent Batches

Source: https://actionscheduler.org/perf

Increases the number of concurrent batches allowed to 10. This can speed up processing of large numbers of actions simultaneously if your server can handle the increased load. Use with caution.

```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' );

```

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

### Check if Action is Scheduled

Source: https://actionscheduler.org/api

Efficiently check if a specific action is currently scheduled or in progress. Recommended for checking existence before performing other operations.

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

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

### Increase Action Scheduler Batch Size

Source: https://actionscheduler.org/perf

Increases the number of actions claimed in a single batch to 100. This can improve performance by reducing the overhead of claiming batches, especially if actions process very quickly.

```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' );

```

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

### as_next_scheduled_action()

Source: https://actionscheduler.org/api

Retrieves the timestamp for the next scheduled occurrence of an action.

```APIDOC
## Function Reference / `as_next_scheduled_action()`

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

### Usage
```
as_next_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
`(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.
```

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

### Schedule a Recurring Action

Source: https://actionscheduler.org/api

Schedule an action that recurs on a cron-like schedule. If execution is delayed, the next attempt will still be scheduled according to the cron expression.

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

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

### Increase Async Request Delay During Migration

Source: https://actionscheduler.org/version3-0

Increase the delay in seconds between async requests to reduce load during migration. The default is 1 in 3.0.X and 5 in 3.1.X.

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

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

### Customize Action Scheduler User-Agent

Source: https://actionscheduler.org/faq

Modify the User-Agent string for Action Scheduler's asynchronous requests by filtering the arguments passed to wp_remote_post.

```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 );
```

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

### Increase Action Scheduler Time Limit

Source: https://actionscheduler.org/perf

Increases the maximum processing time for each request to 120 seconds (2 minutes). Use this if your host supports longer web request timeouts to speed up action processing.

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

```

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

### Disable Async Request Runner During Migration

Source: https://actionscheduler.org/version3-0

Disable the async queue runner entirely while the migration is in process. Remember to remove this filter once the migration is complete.

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

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

### Include Failed Status in Default Cleaner Purge

Source: https://actionscheduler.org/perf

This code snippet adds the 'failed' status to the list of statuses purged by the default Action Scheduler cleaner. This was the default behavior prior to version 3.9.4.

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

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

### as_unschedule_action()

Source: https://actionscheduler.org/api

Cancels the next occurrence of a specific scheduled action.

```APIDOC
## Function Reference / `as_unschedule_action()`

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

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

```

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


### Return value
`(null)`
```

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

### Customize Failed Actions Retention Period

Source: https://actionscheduler.org/perf

This snippet shows how to change the default three-month retention period for failed actions. You can set a specific duration or retain them indefinitely by returning zero.

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

```php
// or if you prefer to retain failed actions indefinitely
add_filter( 'action_scheduler_retention_period_for_failed', '__return_zero' );
```

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

### as_has_scheduled_action()

Source: https://actionscheduler.org/api

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

```APIDOC
## Function Reference / `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
```
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://actionscheduler.org/api

Cancels all occurrences of a scheduled action.

```APIDOC
## Function Reference / `as_unschedule_all_actions()`

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

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

```

### Parameters
  * **$hook** (string)(required) Name of the action hook.
  * **$args** (array) Arguments passed to callbacks when the hook triggers. Default: _`array()`_.
  * **$group** (string) 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.
```

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

### Cancel All Scheduled Actions

Source: https://actionscheduler.org/api

Cancel all occurrences of a scheduled action. Use this when you want to completely remove a recurring action from the schedule.

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

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

### Cancel Next Scheduled Action

Source: https://actionscheduler.org/api

Cancel only the next occurrence of a scheduled action. This is useful for preventing a single future run without affecting subsequent scheduled runs.

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

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.