WC_Queue_Interface::search()
Find scheduled actions.
Method of the class: WC_Queue_Interface{}
No Hooks.
Return
Array
.
Usage
$WC_Queue_Interface = new WC_Queue_Interface(); $WC_Queue_Interface->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_Queue_Interface::search() WC Queue Interface::search code WC 9.4.2
public function search( $args = array(), $return_format = OBJECT );