WooCommerce Code Reference

WC_Order_Query extends WC_Object_Query
in package

Order query class.

Extended by classes to provide a query abstraction layer for safe object searching.

Table of Contents

$query_vars  : array
Stores query data.
__construct()  : mixed
Create a new query.
get()  : mixed
Get the value of a query variable.
get_orders()  : array|object
Get orders matching the current query vars.
get_query_vars()  : array
Get the current query vars.
set()  : mixed
Set a query variable.
get_default_query_vars()  : array
Valid query vars for orders.

Properties

Methods

__construct()

Create a new query.

public __construct([array $args = array() ]) : mixed
Parameters
$args : array = array()

Criteria to query on in a format similar to WP_Query.

Return values
mixed

get()

Get the value of a query variable.

public get(string $query_var[, mixed $default = '' ]) : mixed
Parameters
$query_var : string

Query variable to get value for.

$default : mixed = ''

Default value if query variable is not set.

Return values
mixedQuery variable value if set, otherwise default.

get_orders()

Get orders matching the current query vars.

public get_orders() : array|object
Tags
throws
Exception

When WC_Data_Store validation fails.

Return values
array|objectof WC_Order objects

set()

Set a query variable.

public set(string $query_var, mixed $value) : mixed
Parameters
$query_var : string

Query variable to set.

$value : mixed

Value to set for query variable.

Return values
mixed