woocommerce_rest_orders_prepare_object_query filter-hookWC 4.5.0.

Filter the query arguments for a request.

Enables adding extra arguments or setting defaults for an order collection request.

Usage

add_filter( 'woocommerce_rest_orders_prepare_object_query', 'wp_kama_woocommerce_rest_orders_prepare_object_query_filter', 10, 2 );

/**
 * Function for `woocommerce_rest_orders_prepare_object_query` filter-hook.
 * 
 * @param array           $args    Key value array of query var to query value.
 * @param WP_REST_Request $request The request used.
 *
 * @return array
 */
function wp_kama_woocommerce_rest_orders_prepare_object_query_filter( $args, $request ){

	// filter...
	return $args;
}
$args(array)
Key value array of query var to query value.
$request(WP_REST_Request)
The request used.

Changelog

Since 4.5.0. Introduced.

Where the hook is called

WC_REST_Orders_V2_Controller::prepare_objects_query()
woocommerce_rest_orders_prepare_object_query
woocommerce/includes/rest-api/Controllers/Version2/class-wc-rest-orders-v2-controller.php 648
$args = apply_filters( 'woocommerce_rest_orders_prepare_object_query', $args, $request );

Where the hook is used in WooCommerce

woocommerce/includes/rest-api/Controllers/Version2/class-wc-rest-network-orders-v2-controller.php 139
add_filter( 'woocommerce_rest_orders_prepare_object_query', array( $this, 'network_orders_filter_args' ) );
woocommerce/includes/rest-api/Controllers/Version2/class-wc-rest-network-orders-v2-controller.php 141
remove_filter( 'woocommerce_rest_orders_prepare_object_query', array( $this, 'network_orders_filter_args' ) );