as_schedule_single_action() │ WC 1.0

Schedule an action to run one time

Return

Int. The action ID. Zero if there was an error scheduling the action.

Usage

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

$timestamp(int) (required)

When the job will run.

$hook(string) (required)

The hook to trigger.

$args(array)

Arguments to pass when the hook triggers.
Default: array()

$group(string)

The group to assign this job to.
Default: ''

$unique(true|false)

Whether the action should be unique. It will not be scheduled if another pending or running action has the same hook and group parameters.
Default: false

$priority(int)

Lower values take precedence over higher values.
Default: 10, with acceptable values falling in the range 0-255

as_schedule_single_action() as schedule single action code ^{WC 9.8.2}

function as_schedule_single_action( $timestamp, $hook, $args = array(), $group = '', $unique = false, $priority = 10 ) {
	if ( ! ActionScheduler::is_initialized( __FUNCTION__ ) ) {
		return 0;
	}

	/**
	 * Provides an opportunity to short-circuit the default process for enqueuing single
	 * actions.
	 *
	 * Returning a value other than null from the filter will short-circuit the normal
	 * process. The expectation in such a scenario is that callbacks will return an integer
	 * representing the scheduled action ID (scheduled using some alternative process) or else
	 * zero.
	 *
	 * @param int|null $pre_option The value to return instead of the option value.
	 * @param int      $timestamp  When the action will run.
	 * @param string   $hook       Action hook.
	 * @param array    $args       Action arguments.
	 * @param string   $group      Action group.
	 * @param int      $priorities Action priority.
	 */
	$pre = apply_filters( 'pre_as_schedule_single_action', null, $timestamp, $hook, $args, $group, $priority );
	if ( null !== $pre ) {
		return is_int( $pre ) ? $pre : 0;
	}

	return ActionScheduler::factory()->create(
		array(
			'type'      => 'single',
			'hook'      => $hook,
			'arguments' => $args,
			'when'      => $timestamp,
			'group'     => $group,
			'unique'    => $unique,
			'priority'  => $priority,
		)
	);
}