WC_Action_Queue::search │ public │ WC 1.0

Find scheduled actions

Method of the class: WC_Action_Queue{}

No Hooks.

Returns

Array.

Usage

$WC_Action_Queue = new WC_Action_Queue();
$WC_Action_Queue->search( $args, $return_format );

$args(array)

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(). Used in UTC timezone. '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(). Used in UTC timezone. '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'.
Default: array()

$return_format(string)

OBJECT, ARRAY_A, or ids.
Default: OBJECT

WC_Action_Queue::search() WC Action Queue::search code ^{WC 10.6.2}

public function search( $args = array(), $return_format = OBJECT ) {
	return as_get_scheduled_actions( $args, $return_format );
}