(hook_prefix)collection_query_args │ filter-hook │ WC 10.4.0

Filter collection query args before executing the query.

Usage

add_filter( '(hook_prefix)collection_query_args', 'wp_kama_hook_prefixcollection_query_args_filter', 10, 3 );

/**
 * Function for `(hook_prefix)collection_query_args` filter-hook.
 * 
 * @param array           $query_args Query arguments for WC_Order_Query.
 * @param WP_REST_Request $request    The REST request object.
 * @param Controller      $controller The controller instance.
 *
 * @return array
 */
function wp_kama_hook_prefixcollection_query_args_filter( $query_args, $request, $controller ){

	// filter...
	return $query_args;
}

$query_args(array)

Query arguments for WC_Order_Query.

$request(WP_REST_Request)

The REST request object.

$controller(Controller)

The controller instance.

Changelog

Where the hook is called

$query_args = (array) apply_filters(
	$this->get_hook_prefix() . 'collection_query_args',
	$this->collection_query->get_query_args( $request ),
	$request,
	$this
);

Where the hook is used in WooCommerce