WordPress at a glance
function is not described

WC_REST_Legacy_Products_Controller::query_args() public WC 1.0

Deprecated from version 3.0.0. It is no longer supported and can be removed in future releases. It is recommended to replace this function with the same one.

Query args.

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

No Hooks.

Return

Array.

Usage

$WC_REST_Legacy_Products_Controller = new WC_REST_Legacy_Products_Controller();
$WC_REST_Legacy_Products_Controller->query_args( $args, $request );
$args(array) (required)
Request args.
$request(WP_REST_Request) (required)
Request data.

Changelog

Deprecated 3.0.0

Code of WC_REST_Legacy_Products_Controller::query_args() WC 5.0.0

<?php
public function query_args( $args, $request ) {
	// Set post_status.
	$args['post_status'] = $request['status'];

	// Taxonomy query to filter products by type, category,
	// tag, shipping class, and attribute.
	$tax_query = array();

	// Map between taxonomy name and arg's key.
	$taxonomies = array(
		'product_cat'            => 'category',
		'product_tag'            => 'tag',
		'product_shipping_class' => 'shipping_class',
	);

	// Set tax_query for each passed arg.
	foreach ( $taxonomies as $taxonomy => $key ) {
		if ( ! empty( $request[ $key ] ) ) {
			$tax_query[] = array(
				'taxonomy' => $taxonomy,
				'field'    => 'term_id',
				'terms'    => $request[ $key ],
			);
		}
	}

	// Filter product type by slug.
	if ( ! empty( $request['type'] ) ) {
		$tax_query[] = array(
			'taxonomy' => 'product_type',
			'field'    => 'slug',
			'terms'    => $request['type'],
		);
	}

	// Filter by attribute and term.
	if ( ! empty( $request['attribute'] ) && ! empty( $request['attribute_term'] ) ) {
		if ( in_array( $request['attribute'], wc_get_attribute_taxonomy_names(), true ) ) {
			$tax_query[] = array(
				'taxonomy' => $request['attribute'],
				'field'    => 'term_id',
				'terms'    => $request['attribute_term'],
			);
		}
	}

	if ( ! empty( $tax_query ) ) {
		$args['tax_query'] = $tax_query;
	}

	// Filter featured.
	if ( is_bool( $request['featured'] ) ) {
		$args['tax_query'][] = array(
			'taxonomy' => 'product_visibility',
			'field'    => 'name',
			'terms'    => 'featured',
			'operator' => true === $request['featured'] ? 'IN' : 'NOT IN',
		);
	}

	// 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( $args, array(
			'key'     => '_sku',
			'value'   => $skus,
			'compare' => 'IN',
		) );
	}

	// Filter by tax class.
	if ( ! empty( $request['tax_class'] ) ) {
		$args['meta_query'] = $this->add_meta_query( $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 ) );
	}

	// Filter product in stock or out of stock.
	if ( is_bool( $request['in_stock'] ) ) {
		$args['meta_query'] = $this->add_meta_query( $args, array(
			'key'   => '_stock_status',
			'value' => true === $request['in_stock'] ? 'instock' : 'outofstock',
		) );
	}

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

	// 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;
	}

	return $args;
}