Automattic\WooCommerce\Blocks\BlockTypes

ProductQuery::extend_rest_query_allowed_params │ public │ WC 1.0

Extends allowed collection_params for the REST API

By itself, the REST API doesn't accept custom orderby values, even if they are supported by a custom post type.

Method of the class: ProductQuery{}

No Hooks.

Returns

Array.

Usage

$ProductQuery = new ProductQuery();
$ProductQuery->extend_rest_query_allowed_params( $params );

$params(array) (required)

A list of allowed orderby values.

ProductQuery::extend_rest_query_allowed_params() ProductQuery::extend rest query allowed params code ^{WC 9.8.5}

public function extend_rest_query_allowed_params( $params ) {
	$original_enum = isset( $params['orderby']['enum'] ) ? $params['orderby']['enum'] : array();

	$params['orderby']['enum'] = array_merge( $original_enum, $this->custom_order_opts );
	return $params;
}