WordPress at Your Fingertips
function is not described

WC_REST_Product_Variations_Controller::prepare_objects_query() protected WC 3.0.0

Prepare objects query.

{} It's a method of the class: WC_REST_Product_Variations_Controller{}

No Hooks.

Return

Array.

Usage

// protected - for code of main (parent) or child class
$result = $this->prepare_objects_query( $request );
$request(WP_REST_Request) (required)
Full details about the request.

Changelog

Since 3.0.0 Introduced.

Code of WC_REST_Product_Variations_Controller::prepare_objects_query() WC 5.9.0

protected function prepare_objects_query( $request ) {
	$args = WC_REST_CRUD_Controller::prepare_objects_query( $request );

	// Set post_status.
	$args['post_status'] = $request['status'];

	// Filter by sku.
	if ( ! empty( $request['sku'] ) ) {
		$skus = explode( ',', $request['sku'] );
		// Include the current string as a SKU too.
		if ( 1 < count( $skus ) ) {
			$skus[] = $request['sku'];
		}

		$args['meta_query'] = $this->add_meta_query( // WPCS: slow query ok.
			$args,
			array(
				'key'     => '_sku',
				'value'   => $skus,
				'compare' => 'IN',
			)
		);
	}

	// Filter by tax class.
	if ( ! empty( $request['tax_class'] ) ) {
		$args['meta_query'] = $this->add_meta_query( // WPCS: slow query ok.
			$args,
			array(
				'key'   => '_tax_class',
				'value' => 'standard' !== $request['tax_class'] ? $request['tax_class'] : '',
			)
		);
	}

	// Price filter.
	if ( ! empty( $request['min_price'] ) || ! empty( $request['max_price'] ) ) {
		$args['meta_query'] = $this->add_meta_query( $args, wc_get_min_max_price_meta_query( $request ) );  // WPCS: slow query ok.
	}

	// Filter product based on stock_status.
	if ( ! empty( $request['stock_status'] ) ) {
		$args['meta_query'] = $this->add_meta_query( // WPCS: slow query ok.
			$args,
			array(
				'key'   => '_stock_status',
				'value' => $request['stock_status'],
			)
		);
	}

	// Filter by on sale products.
	if ( is_bool( $request['on_sale'] ) ) {
		$on_sale_key = $request['on_sale'] ? 'post__in' : 'post__not_in';
		$on_sale_ids = wc_get_product_ids_on_sale();

		// Use 0 when there's no on sale products to avoid return all products.
		$on_sale_ids = empty( $on_sale_ids ) ? array( 0 ) : $on_sale_ids;

		$args[ $on_sale_key ] += $on_sale_ids;
	}

	// Force the post_type argument, since it's not a user input variable.
	if ( ! empty( $request['sku'] ) ) {
		$args['post_type'] = array( 'product', 'product_variation' );
	} else {
		$args['post_type'] = $this->post_type;
	}

	$args['post_parent'] = $request['product_id'];

	return $args;
}