WC_API_Orders::get_orders() │ public │ WC 2.1

Get all orders

Method of the class: WC_API_Orders{}

No Hooks.

Return

Array.

Usage

$WC_API_Orders = new WC_API_Orders();
$WC_API_Orders->get_orders( $fields, $filter, $status, $page );

$fields(string)

-
Default: null

$filter(array)

-
Default: array()

$status(string)

-
Default: null

$page(int)

-
Default: 1

Changelog

WC_API_Orders::get_orders() WC API Orders::get orders code ^{WC 8.7.0}

public function get_orders( $fields = null, $filter = array(), $status = null, $page = 1 ) {

	if ( ! empty( $status ) ) {
		$filter['status'] = $status;
	}

	$filter['page'] = $page;

	$query = $this->query_orders( $filter );

	$orders = array();

	foreach ( $query->posts as $order_id ) {

		if ( ! $this->is_readable( $order_id ) ) {
			continue;
		}

		$orders[] = current( $this->get_order( $order_id, $fields, $filter ) );
	}

	$this->server->add_pagination_headers( $query );

	return array( 'orders' => $orders );
}