woocommerce/includes/class-wc-order-query.php

85 lines
2.5 KiB
PHP
Raw Normal View History

2017-04-24 23:28:13 +00:00
<?php
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Class for parameter-based Order querying.
2017-06-01 18:59:15 +00:00
* Args and usage: https://github.com/woocommerce/woocommerce/wiki/wc_get_orders-and-WC_Order_Query
2017-04-24 23:28:13 +00:00
*
* @version 3.1.0
* @since 3.1.0
* @package WooCommerce/Classes
* @category Class
*/
class WC_Order_Query extends WC_Object_Query {
2017-04-25 18:24:38 +00:00
/**
* Valid query vars for orders.
* @return array
*/
2017-04-24 23:28:13 +00:00
protected function get_default_query_vars() {
return array_merge(
parent::get_default_query_vars(),
array(
2017-04-27 21:09:10 +00:00
'status' => array_keys( wc_get_order_statuses() ),
'type' => wc_get_order_types( 'view-orders' ),
'currency' => '',
'version' => '',
'prices_include_tax' => '',
'date_created' => '',
'date_modified' => '',
'date_completed' => '',
'date_paid' => '',
'discount_total' => '',
'discount_tax' => '',
'shipping_total' => '',
'shipping_tax' => '',
'cart_tax' => '',
'total' => '',
'total_tax' => '',
2017-05-12 18:45:01 +00:00
'customer' => '',
2017-04-27 21:09:10 +00:00
'customer_id' => '',
'order_key' => '',
'billing_first_name' => '',
'billing_last_name' => '',
'billing_company' => '',
'billing_address_1' => '',
'billing_address_2' => '',
'billing_city' => '',
'billing_state' => '',
'billing_postcode' => '',
'billing_country' => '',
'billing_email' => '',
'billing_phone' => '',
'shipping_first_name' => '',
'shipping_last_name' => '',
'shipping_company' => '',
'shipping_address_1' => '',
'shipping_address_2' => '',
'shipping_city' => '',
'shipping_state' => '',
'shipping_postcode' => '',
'shipping_country' => '',
'payment_method' => '',
'payment_method_title' => '',
'transaction_id' => '',
'customer_ip_address' => '',
'customer_user_agent' => '',
'created_via' => '',
'customer_note' => '',
2017-04-24 23:28:13 +00:00
)
);
}
2017-04-25 18:24:38 +00:00
/**
* Get orders matching the current query vars.
2017-08-29 15:36:50 +00:00
* @return array|object of WC_Order objects
2017-04-25 18:24:38 +00:00
*/
2017-04-24 23:28:13 +00:00
public function get_orders() {
2017-04-27 21:09:10 +00:00
$args = apply_filters( 'woocommerce_order_query_args', $this->get_query_vars() );
$results = WC_Data_Store::load( 'order' )->query( $args );
2017-04-26 18:19:54 +00:00
return apply_filters( 'woocommerce_order_query', $results, $args );
2017-04-24 23:28:13 +00:00
}
}