woocommerce_rest_(post_type)_object_query │ filter-hook │ WC 1.0

Filter the query arguments for a request.

Enables adding extra arguments or setting defaults for a post collection request.

Usage

add_filter( 'woocommerce_rest_(post_type)_object_query', 'wp_kama_woocommerce_rest_post_type_object_query_filter', 10, 2 );

/**
 * Function for `woocommerce_rest_(post_type)_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_post_type_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.

Where the hook is called

$args = apply_filters( "woocommerce_rest_{$this->post_type}_object_query", $args, $request );

Where the hook is used in WooCommerce

add_filter( 'woocommerce_rest_product_object_query', array( $this, 'rest_api_filter_products_by_brand' ), 10, 2 );

add_filter( 'woocommerce_rest_orders_prepare_object_query', array( $this, 'network_orders_filter_args' ) );

remove_filter( 'woocommerce_rest_orders_prepare_object_query', array( $this, 'network_orders_filter_args' ) );