76 lines
1.7 KiB
PHP
76 lines
1.7 KiB
PHP
<?php
|
|
/**
|
|
* REST API Orders controller
|
|
*
|
|
* Handles requests to the /orders endpoint.
|
|
*
|
|
* @package WooCommerce/API
|
|
* @since 2.6.0
|
|
*/
|
|
|
|
defined( 'ABSPATH' ) || exit;
|
|
|
|
/**
|
|
* REST API Orders controller class.
|
|
*
|
|
* @package WooCommerce/API
|
|
* @extends WC_REST_Orders_V2_Controller
|
|
*/
|
|
class WC_REST_Orders_Controller extends WC_REST_Orders_V2_Controller {
|
|
|
|
/**
|
|
* Endpoint namespace.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $namespace = 'wc/v3';
|
|
|
|
/**
|
|
* Prepare objects query.
|
|
*
|
|
* @since 3.0.0
|
|
* @param WP_REST_Request $request Full details about the request.
|
|
* @return array
|
|
*/
|
|
protected function prepare_objects_query( $request ) {
|
|
// This is needed to get around an array to string notice in WC_REST_Orders_Controller::prepare_objects_query.
|
|
$statuses = $request['status'];
|
|
unset( $request['status'] );
|
|
$args = parent::prepare_objects_query( $request );
|
|
|
|
$args['post_status'] = array();
|
|
foreach ( $statuses as $status ) {
|
|
if ( 'any' === $status ) {
|
|
// Set status to "any" and short-circuit out.
|
|
$args['post_status'] = 'any';
|
|
break;
|
|
}
|
|
$args['post_status'][] = 'wc-' . $status;
|
|
}
|
|
|
|
return $args;
|
|
}
|
|
|
|
/**
|
|
* Get the query params for collections.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function get_collection_params() {
|
|
$params = parent::get_collection_params();
|
|
|
|
$params['status'] = array(
|
|
'default' => 'any',
|
|
'description' => __( 'Limit result set to orders assigned a specific status.', 'woocommerce' ),
|
|
'type' => 'array',
|
|
'items' => array(
|
|
'type' => 'string',
|
|
'enum' => array_merge( array( 'any' ), $this->get_order_statuses() ),
|
|
),
|
|
'validate_callback' => 'rest_validate_request_arg',
|
|
);
|
|
|
|
return $params;
|
|
}
|
|
}
|