<?php

[0] Fix | Delete

declare(strict_types=1);

[1] Fix | Delete

[2] Fix | Delete

namespace Automattic\WooCommerce\StoreApi\Utilities;

[3] Fix | Delete

[4] Fix | Delete

use Automattic\WooCommerce\Enums\ProductStatus;

[5] Fix | Delete

use Automattic\WooCommerce\Enums\ProductType;

[6] Fix | Delete

use Automattic\WooCommerce\Enums\CatalogVisibility;

[7] Fix | Delete

use Automattic\WooCommerce\Internal\ProductFilters\Interfaces\QueryClausesGenerator;

[8] Fix | Delete

use WC_Tax;

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Product Query class.

[12] Fix | Delete

*

[13] Fix | Delete

* Helper class to handle product queries for the API.

[14] Fix | Delete

*/

[15] Fix | Delete

class ProductQuery implements QueryClausesGenerator {

[16] Fix | Delete

/**

[17] Fix | Delete

* Prepare query args to pass to WP_Query for a REST API request.

[18] Fix | Delete

*

[19] Fix | Delete

* @param \WP_REST_Request $request Request data.

[20] Fix | Delete

* @return array

[21] Fix | Delete

*/

[22] Fix | Delete

public function prepare_objects_query( $request ) {

[23] Fix | Delete

$args = array(

[24] Fix | Delete

'offset' => $request['offset'],

[25] Fix | Delete

'order' => $request['order'],

[26] Fix | Delete

'orderby' => $request['orderby'],

[27] Fix | Delete

'paged' => $request['page'],

[28] Fix | Delete

'post__in' => $request['include'],

[29] Fix | Delete

'post__not_in' => $request['exclude'],

[30] Fix | Delete

'posts_per_page' => $request['per_page'] ? $request['per_page'] : -1,

[31] Fix | Delete

'post_parent__in' => $request['parent'],

[32] Fix | Delete

'post_parent__not_in' => $request['parent_exclude'],

[33] Fix | Delete

'search' => $request['search'], // This uses search rather than s intentionally to handle searches internally.

[34] Fix | Delete

'slug' => $request['slug'],

[35] Fix | Delete

'fields' => 'ids',

[36] Fix | Delete

'ignore_sticky_posts' => true,

[37] Fix | Delete

'post_status' => ProductStatus::PUBLISH,

[38] Fix | Delete

'date_query' => array(),

[39] Fix | Delete

'post_type' => 'product',

[40] Fix | Delete

);

[41] Fix | Delete

[42] Fix | Delete

// If searching for a specific SKU or slug, allow any post type.

[43] Fix | Delete

if ( ! empty( $request['sku'] ) || ! empty( $request['slug'] ) ) {

[44] Fix | Delete

$args['post_type'] = array( 'product', 'product_variation' );

[45] Fix | Delete

}

[46] Fix | Delete

[47] Fix | Delete

// Taxonomy query to filter products by type, category, tag, shipping class, and attribute.

[48] Fix | Delete

$tax_query = array();

[49] Fix | Delete

[50] Fix | Delete

// Filter product type by slug.

[51] Fix | Delete

if ( ! empty( $request['type'] ) ) {

[52] Fix | Delete

if ( ProductType::VARIATION === $request['type'] ) {

[53] Fix | Delete

$args['post_type'] = 'product_variation';

[54] Fix | Delete

} else {

[55] Fix | Delete

$args['post_type'] = 'product';

[56] Fix | Delete

$tax_query[] = array(

[57] Fix | Delete

'taxonomy' => 'product_type',

[58] Fix | Delete

'field' => 'slug',

[59] Fix | Delete

'terms' => $request['type'],

[60] Fix | Delete

);

[61] Fix | Delete

}

[62] Fix | Delete

}

[63] Fix | Delete

[64] Fix | Delete

if ( 'date' === $args['orderby'] ) {

[65] Fix | Delete

$args['orderby'] = 'date ID';

[66] Fix | Delete

}

[67] Fix | Delete

[68] Fix | Delete

// Set before into date query. Date query must be specified as an array of an array.

[69] Fix | Delete

if ( isset( $request['before'] ) ) {

[70] Fix | Delete

$args['date_query'][0]['before'] = $request['before'];

[71] Fix | Delete

}

[72] Fix | Delete

[73] Fix | Delete

// Set after into date query. Date query must be specified as an array of an array.

[74] Fix | Delete

if ( isset( $request['after'] ) ) {

[75] Fix | Delete

$args['date_query'][0]['after'] = $request['after'];

[76] Fix | Delete

}

[77] Fix | Delete

[78] Fix | Delete

// Set date query column. Defaults to post_date.

[79] Fix | Delete

if ( isset( $request['date_column'] ) && ! empty( $args['date_query'][0] ) ) {

[80] Fix | Delete

$args['date_query'][0]['column'] = 'post_' . $request['date_column'];

[81] Fix | Delete

}

[82] Fix | Delete

[83] Fix | Delete

// Set custom args to handle later during clauses.

[84] Fix | Delete

$custom_keys = array(

[85] Fix | Delete

'sku',

[86] Fix | Delete

'min_price',

[87] Fix | Delete

'max_price',

[88] Fix | Delete

'stock_status',

[89] Fix | Delete

);

[90] Fix | Delete

[91] Fix | Delete

foreach ( $custom_keys as $key ) {

[92] Fix | Delete

if ( ! empty( $request[ $key ] ) ) {

[93] Fix | Delete

$args[ $key ] = $request[ $key ];

[94] Fix | Delete

}

[95] Fix | Delete

}

[96] Fix | Delete

[97] Fix | Delete

$operator_mapping = array(

[98] Fix | Delete

'in' => 'IN',

[99] Fix | Delete

'not_in' => 'NOT IN',

[100] Fix | Delete

'and' => 'AND',

[101] Fix | Delete

);

[102] Fix | Delete

[103] Fix | Delete

// Gets all registered product taxonomies and prefixes them with `tax_`.

[104] Fix | Delete

// This is needed to avoid situations where a user registers a new product taxonomy with the same name as default field.

[105] Fix | Delete

// eg an `sku` taxonomy will be mapped to `tax_sku`.

[106] Fix | Delete

$all_product_taxonomies = array_map(

[107] Fix | Delete

function ( $value ) {

[108] Fix | Delete

return '_unstable_tax_' . $value;

[109] Fix | Delete

},

[110] Fix | Delete

get_taxonomies( array( 'object_type' => array( 'product' ) ), 'names' )

[111] Fix | Delete

);

[112] Fix | Delete

[113] Fix | Delete

// Map between taxonomy name and arg key.

[114] Fix | Delete

$default_taxonomies = array(

[115] Fix | Delete

'product_cat' => 'category',

[116] Fix | Delete

'product_tag' => 'tag',

[117] Fix | Delete

'product_brand' => 'brand',

[118] Fix | Delete

);

[119] Fix | Delete

[120] Fix | Delete

$taxonomies = array_merge( $all_product_taxonomies, $default_taxonomies );

[121] Fix | Delete

[122] Fix | Delete

// Set tax_query for each passed arg.

[123] Fix | Delete

foreach ( $taxonomies as $taxonomy => $key ) {

[124] Fix | Delete

if ( ! empty( $request[ $key ] ) ) {

[125] Fix | Delete

$type = is_numeric( $request[ $key ][0] ) ? 'term_id' : 'slug';

[126] Fix | Delete

$operator = $request->get_param( $key . '_operator' ) && isset( $operator_mapping[ $request->get_param( $key . '_operator' ) ] ) ? $operator_mapping[ $request->get_param( $key . '_operator' ) ] : 'IN';

[127] Fix | Delete

$tax_query[] = array(

[128] Fix | Delete

'taxonomy' => $taxonomy,

[129] Fix | Delete

'field' => $type,

[130] Fix | Delete

'terms' => $request[ $key ],

[131] Fix | Delete

'operator' => $operator,

[132] Fix | Delete

);

[133] Fix | Delete

}

[134] Fix | Delete

}

[135] Fix | Delete

[136] Fix | Delete

// Filter by attributes.

[137] Fix | Delete

if ( ! empty( $request['attributes'] ) ) {

[138] Fix | Delete

$att_queries = array();

[139] Fix | Delete

[140] Fix | Delete

foreach ( $request['attributes'] as $attribute ) {

[141] Fix | Delete

if ( empty( $attribute['term_id'] ) && empty( $attribute['slug'] ) ) {

[142] Fix | Delete

continue;

[143] Fix | Delete

}

[144] Fix | Delete

if ( in_array( $attribute['attribute'], wc_get_attribute_taxonomy_names(), true ) ) {

[145] Fix | Delete

$operator = isset( $attribute['operator'], $operator_mapping[ $attribute['operator'] ] ) ? $operator_mapping[ $attribute['operator'] ] : 'IN';

[146] Fix | Delete

$att_queries[] = array(

[147] Fix | Delete

'taxonomy' => $attribute['attribute'],

[148] Fix | Delete

'field' => ! empty( $attribute['term_id'] ) ? 'term_id' : 'slug',

[149] Fix | Delete

'terms' => ! empty( $attribute['term_id'] ) ? $attribute['term_id'] : $attribute['slug'],

[150] Fix | Delete

'operator' => $operator,

[151] Fix | Delete

);

[152] Fix | Delete

}

[153] Fix | Delete

}

[154] Fix | Delete

[155] Fix | Delete

if ( 1 < count( $att_queries ) ) {

[156] Fix | Delete

// Add relation arg when using multiple attributes.

[157] Fix | Delete

$relation = $request->get_param( 'attribute_relation' ) && isset( $operator_mapping[ $request->get_param( 'attribute_relation' ) ] ) ? $operator_mapping[ $request->get_param( 'attribute_relation' ) ] : 'IN';

[158] Fix | Delete

$tax_query[] = array(

[159] Fix | Delete

'relation' => $relation,

[160] Fix | Delete

$att_queries,

[161] Fix | Delete

);

[162] Fix | Delete

} else {

[163] Fix | Delete

$tax_query = array_merge( $tax_query, $att_queries );

[164] Fix | Delete

}

[165] Fix | Delete

}

[166] Fix | Delete

[167] Fix | Delete

// Build tax_query if taxonomies are set.

[168] Fix | Delete

if ( ! empty( $tax_query ) && 'product_variation' !== $args['post_type'] ) {

[169] Fix | Delete

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

[170] Fix | Delete

$args['tax_query'] = array_merge( $tax_query, $args['tax_query'] ); // phpcs:ignore

[171] Fix | Delete

} else {

[172] Fix | Delete

$args['tax_query'] = $tax_query; // phpcs:ignore

[173] Fix | Delete

}

[174] Fix | Delete

} else {

[175] Fix | Delete

// For product_variantions we need to convert the tax_query to a meta_query.

[176] Fix | Delete

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

[177] Fix | Delete

$args['meta_query'] = $this->convert_tax_query_to_meta_query( array_merge( $tax_query, $args['tax_query'] ) ); // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query

[178] Fix | Delete

} else {

[179] Fix | Delete

$args['meta_query'] = $this->convert_tax_query_to_meta_query( $tax_query ); // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query

[180] Fix | Delete

}

[181] Fix | Delete

}

[182] Fix | Delete

[183] Fix | Delete

// Filter featured.

[184] Fix | Delete

if ( is_bool( $request['featured'] ) ) {

[185] Fix | Delete

$args['tax_query'][] = array(

[186] Fix | Delete

'taxonomy' => 'product_visibility',

[187] Fix | Delete

'field' => 'name',

[188] Fix | Delete

'terms' => 'featured',

[189] Fix | Delete

'operator' => true === $request['featured'] ? 'IN' : 'NOT IN',

[190] Fix | Delete

);

[191] Fix | Delete

}

[192] Fix | Delete

[193] Fix | Delete

// Filter by on sale products.

[194] Fix | Delete

if ( is_bool( $request['on_sale'] ) ) {

[195] Fix | Delete

$on_sale_key = $request['on_sale'] ? 'post__in' : 'post__not_in';

[196] Fix | Delete

$on_sale_ids = wc_get_product_ids_on_sale();

[197] Fix | Delete

[198] Fix | Delete

// Use 0 when there's no on sale products to avoid return all products.

[199] Fix | Delete

$on_sale_ids = empty( $on_sale_ids ) ? array( 0 ) : $on_sale_ids;

[200] Fix | Delete

[201] Fix | Delete

$args[ $on_sale_key ] += $on_sale_ids;

[202] Fix | Delete

}

[203] Fix | Delete

[204] Fix | Delete

$catalog_visibility = $request->get_param( 'catalog_visibility' );

[205] Fix | Delete

$rating = $request->get_param( 'rating' );

[206] Fix | Delete

$visibility_options = wc_get_product_visibility_options();

[207] Fix | Delete

[208] Fix | Delete

if ( in_array( $catalog_visibility, array_keys( $visibility_options ), true ) ) {

[209] Fix | Delete

$exclude_from_catalog = CatalogVisibility::SEARCH === $catalog_visibility ? '' : 'exclude-from-catalog';

[210] Fix | Delete

$exclude_from_search = CatalogVisibility::CATALOG === $catalog_visibility ? '' : 'exclude-from-search';

[211] Fix | Delete

[212] Fix | Delete

$args['tax_query'][] = array(

[213] Fix | Delete

'taxonomy' => 'product_visibility',

[214] Fix | Delete

'field' => 'name',

[215] Fix | Delete

'terms' => array( $exclude_from_catalog, $exclude_from_search ),

[216] Fix | Delete

'operator' => CatalogVisibility::HIDDEN === $catalog_visibility ? 'AND' : 'NOT IN',

[217] Fix | Delete

'rating_filter' => true,

[218] Fix | Delete

);

[219] Fix | Delete

}

[220] Fix | Delete

[221] Fix | Delete

if ( $rating ) {

[222] Fix | Delete

$rating_terms = array();

[223] Fix | Delete

foreach ( $rating as $value ) {

[224] Fix | Delete

$rating_terms[] = 'rated-' . $value;

[225] Fix | Delete

}

[226] Fix | Delete

$args['tax_query'][] = array(

[227] Fix | Delete

'taxonomy' => 'product_visibility',

[228] Fix | Delete

'field' => 'name',

[229] Fix | Delete

'terms' => $rating_terms,

[230] Fix | Delete

);

[231] Fix | Delete

}

[232] Fix | Delete

[233] Fix | Delete

$orderby = $request->get_param( 'orderby' );

[234] Fix | Delete

$order = $request->get_param( 'order' );

[235] Fix | Delete

[236] Fix | Delete

$ordering_args = wc()->query->get_catalog_ordering_args( $orderby, $order );

[237] Fix | Delete

$args['orderby'] = $ordering_args['orderby'];

[238] Fix | Delete

$args['order'] = $ordering_args['order'];

[239] Fix | Delete

[240] Fix | Delete

if ( 'include' === $orderby ) {

[241] Fix | Delete

$args['orderby'] = 'post__in';

[242] Fix | Delete

} elseif ( 'id' === $orderby ) {

[243] Fix | Delete

$args['orderby'] = 'ID'; // ID must be capitalized.

[244] Fix | Delete

} elseif ( 'slug' === $orderby ) {

[245] Fix | Delete

$args['orderby'] = 'name';

[246] Fix | Delete

}

[247] Fix | Delete

[248] Fix | Delete

if ( $ordering_args['meta_key'] ) {

[249] Fix | Delete

$args['meta_key'] = $ordering_args['meta_key']; // phpcs:ignore

[250] Fix | Delete

}

[251] Fix | Delete

[252] Fix | Delete

return $args;

[253] Fix | Delete

}

[254] Fix | Delete

[255] Fix | Delete

/**

[256] Fix | Delete

* Convert the tax_query to a meta_query which is needed to support filtering by attributes for variations.

[257] Fix | Delete

*

[258] Fix | Delete

* @param array $tax_query The tax_query to convert.

[259] Fix | Delete

* @return array

[260] Fix | Delete

*/

[261] Fix | Delete

public function convert_tax_query_to_meta_query( $tax_query ) {

[262] Fix | Delete

$meta_query = array();

[263] Fix | Delete

[264] Fix | Delete

foreach ( $tax_query as $tax_query_item ) {

[265] Fix | Delete

$taxonomy = $tax_query_item['taxonomy'];

[266] Fix | Delete

$terms = $tax_query_item['terms'];

[267] Fix | Delete

[268] Fix | Delete

$meta_key = 'attribute_' . $taxonomy;

[269] Fix | Delete

[270] Fix | Delete

$meta_query[] = array(

[271] Fix | Delete

'key' => $meta_key,

[272] Fix | Delete

'value' => $terms,

[273] Fix | Delete

);

[274] Fix | Delete

[275] Fix | Delete

if ( isset( $tax_query_item['operator'] ) ) {

[276] Fix | Delete

$meta_query[0]['compare'] = $tax_query_item['operator'];

[277] Fix | Delete

}

[278] Fix | Delete

}

[279] Fix | Delete

[280] Fix | Delete

return $meta_query;

[281] Fix | Delete

}

[282] Fix | Delete

[283] Fix | Delete

/**

[284] Fix | Delete

* Get results of query.

[285] Fix | Delete

*

[286] Fix | Delete

* @param \WP_REST_Request $request Request data.

[287] Fix | Delete

* @return array

[288] Fix | Delete

*/

[289] Fix | Delete

public function get_results( $request ) {

[290] Fix | Delete

$query_args = $this->prepare_objects_query( $request );

[291] Fix | Delete

[292] Fix | Delete

add_filter( 'posts_clauses', array( $this, 'add_query_clauses' ), 10, 2 );

[293] Fix | Delete

[294] Fix | Delete

$query = new \WP_Query();

[295] Fix | Delete

$results = $query->query( $query_args );

[296] Fix | Delete

$total_posts = $query->found_posts;

[297] Fix | Delete

[298] Fix | Delete

// Out-of-bounds, run the query again without LIMIT for total count.

[299] Fix | Delete

if ( $total_posts < 1 && $query_args['paged'] > 1 ) {

[300] Fix | Delete

unset( $query_args['paged'] );

[301] Fix | Delete

$count_query = new \WP_Query();

[302] Fix | Delete

$count_query->query( $query_args );

[303] Fix | Delete

$total_posts = $count_query->found_posts;

[304] Fix | Delete

}

[305] Fix | Delete

[306] Fix | Delete

remove_filter( 'posts_clauses', array( $this, 'add_query_clauses' ), 10 );

[307] Fix | Delete

[308] Fix | Delete

return array(

[309] Fix | Delete

'results' => $results,

[310] Fix | Delete

'total' => (int) $total_posts,

[311] Fix | Delete

'pages' => $query->query_vars['posts_per_page'] > 0 ? (int) ceil( $total_posts / (int) $query->query_vars['posts_per_page'] ) : 1,

[312] Fix | Delete

);

[313] Fix | Delete

}

[314] Fix | Delete

[315] Fix | Delete

/**

[316] Fix | Delete

* Get objects.

[317] Fix | Delete

*

[318] Fix | Delete

* @param \WP_REST_Request $request Request data.

[319] Fix | Delete

* @return array

[320] Fix | Delete

*/

[321] Fix | Delete

public function get_objects( $request ) {

[322] Fix | Delete

$results = $this->get_results( $request );

[323] Fix | Delete

[324] Fix | Delete

return array(

[325] Fix | Delete

'objects' => array_map( 'wc_get_product', $results['results'] ),

[326] Fix | Delete

'total' => $results['total'],

[327] Fix | Delete

'pages' => $results['pages'],

[328] Fix | Delete

);

[329] Fix | Delete

}

[330] Fix | Delete

[331] Fix | Delete

/**

[332] Fix | Delete

* Get last modified date for all products.

[333] Fix | Delete

*

[334] Fix | Delete

* @return int timestamp.

[335] Fix | Delete

*/

[336] Fix | Delete

public function get_last_modified() {

[337] Fix | Delete

global $wpdb;

[338] Fix | Delete

[339] Fix | Delete

$last_modified = $wpdb->get_var( "SELECT MAX( post_modified_gmt ) FROM {$wpdb->posts} WHERE post_type IN ( 'product', 'product_variation' );" );

[340] Fix | Delete

[341] Fix | Delete

return $last_modified ? strtotime( $last_modified ) : null;

[342] Fix | Delete

}

[343] Fix | Delete

[344] Fix | Delete

/**

[345] Fix | Delete

* Add in conditional search filters for products.

[346] Fix | Delete

*

[347] Fix | Delete

* @param array $args Query args.

[348] Fix | Delete

* @param \WP_Query $wp_query WP_Query object.

[349] Fix | Delete

* @return array

[350] Fix | Delete

*/

[351] Fix | Delete

public function add_query_clauses( array $args, \WP_Query $wp_query ) {

[352] Fix | Delete

global $wpdb;

[353] Fix | Delete

[354] Fix | Delete

if ( $wp_query->get( 'search' ) ) {

[355] Fix | Delete

$search = '%' . $wpdb->esc_like( $wp_query->get( 'search' ) ) . '%';

[356] Fix | Delete

$search_query = wc_product_sku_enabled()

[357] Fix | Delete

? $wpdb->prepare( " AND ( $wpdb->posts.post_title LIKE %s OR wc_product_meta_lookup.sku LIKE %s ) ", $search, $search )

[358] Fix | Delete

: $wpdb->prepare( " AND $wpdb->posts.post_title LIKE %s ", $search );

[359] Fix | Delete

$args['where'] .= $search_query;

[360] Fix | Delete

$args['join'] = $this->append_product_sorting_table_join( $args['join'] );

[361] Fix | Delete

}

[362] Fix | Delete

[363] Fix | Delete

if ( $wp_query->get( 'sku' ) ) {

[364] Fix | Delete

$skus = explode( ',', $wp_query->get( 'sku' ) );

[365] Fix | Delete

// Include the current string as a SKU too.

[366] Fix | Delete

if ( 1 < count( $skus ) ) {

[367] Fix | Delete

$skus[] = $wp_query->get( 'sku' );

[368] Fix | Delete

}

[369] Fix | Delete

$args['join'] = $this->append_product_sorting_table_join( $args['join'] );

[370] Fix | Delete

$args['where'] .= ' AND wc_product_meta_lookup.sku IN (\'' . implode( '\',\'', array_map( 'esc_sql', $skus ) ) . '\')';

[371] Fix | Delete

}

[372] Fix | Delete

[373] Fix | Delete

if ( $wp_query->get( 'slug' ) ) {

[374] Fix | Delete

$slugs = explode( ',', $wp_query->get( 'slug' ) );

[375] Fix | Delete

// Include the current string as a slug too.

[376] Fix | Delete

if ( 1 < count( $slugs ) ) {

[377] Fix | Delete

$slugs[] = $wp_query->get( 'slug' );

[378] Fix | Delete

}

[379] Fix | Delete

$args['join'] = $this->append_product_sorting_table_join( $args['join'] );

[380] Fix | Delete

$post_name__in = implode( '","', array_map( 'esc_sql', $slugs ) );

[381] Fix | Delete

$args['where'] .= " AND $wpdb->posts.post_name IN (\"$post_name__in\")";

[382] Fix | Delete

}

[383] Fix | Delete

[384] Fix | Delete

if ( $wp_query->get( 'stock_status' ) ) {

[385] Fix | Delete

$args['join'] = $this->append_product_sorting_table_join( $args['join'] );

[386] Fix | Delete

$args['where'] .= ' AND wc_product_meta_lookup.stock_status IN (\'' . implode( '\',\'', array_map( 'esc_sql', $wp_query->get( 'stock_status' ) ) ) . '\')';

[387] Fix | Delete

} elseif ( 'yes' === get_option( 'woocommerce_hide_out_of_stock_items' ) ) {

[388] Fix | Delete

$args['join'] = $this->append_product_sorting_table_join( $args['join'] );

[389] Fix | Delete

$args['where'] .= ' AND wc_product_meta_lookup.stock_status NOT IN (\'outofstock\')';

[390] Fix | Delete

}

[391] Fix | Delete

[392] Fix | Delete

if ( $wp_query->get( 'min_price' ) || $wp_query->get( 'max_price' ) ) {

[393] Fix | Delete

$args = $this->add_price_filter_clauses( $args, $wp_query );

[394] Fix | Delete

}

[395] Fix | Delete

[396] Fix | Delete

return $args;

[397] Fix | Delete

}

[398] Fix | Delete

[399] Fix | Delete

/**

[400] Fix | Delete

* Add in conditional price filters.

[401] Fix | Delete

*

[402] Fix | Delete

* @param array $args Query args.

[403] Fix | Delete

* @param \WC_Query $wp_query WC_Query object.

[404] Fix | Delete

* @return array

[405] Fix | Delete

*/

[406] Fix | Delete

protected function add_price_filter_clauses( $args, $wp_query ) {

[407] Fix | Delete

global $wpdb;

[408] Fix | Delete

[409] Fix | Delete

$adjust_for_taxes = $this->adjust_price_filters_for_displayed_taxes();

[410] Fix | Delete

$args['join'] = $this->append_product_sorting_table_join( $args['join'] );

[411] Fix | Delete

[412] Fix | Delete

if ( $wp_query->get( 'min_price' ) ) {

[413] Fix | Delete

$min_price_filter = $this->prepare_price_filter( $wp_query->get( 'min_price' ) );

[414] Fix | Delete

[415] Fix | Delete

if ( $adjust_for_taxes ) {

[416] Fix | Delete

$args['where'] .= $this->get_price_filter_query_for_displayed_taxes( $min_price_filter, 'max_price', '>=' );

[417] Fix | Delete

} else {

[418] Fix | Delete

$args['where'] .= $wpdb->prepare( ' AND wc_product_meta_lookup.max_price >= %f ', $min_price_filter );

[419] Fix | Delete

}

[420] Fix | Delete

}

[421] Fix | Delete

[422] Fix | Delete

if ( $wp_query->get( 'max_price' ) ) {

[423] Fix | Delete

$max_price_filter = $this->prepare_price_filter( $wp_query->get( 'max_price' ) );

[424] Fix | Delete

[425] Fix | Delete

if ( $adjust_for_taxes ) {

[426] Fix | Delete

$args['where'] .= $this->get_price_filter_query_for_displayed_taxes( $max_price_filter, 'min_price', '<=' );

[427] Fix | Delete

} else {

[428] Fix | Delete

$args['where'] .= $wpdb->prepare( ' AND wc_product_meta_lookup.min_price <= %f ', $max_price_filter );

[429] Fix | Delete

}

[430] Fix | Delete

}

[431] Fix | Delete

[432] Fix | Delete

return $args;

[433] Fix | Delete

}

[434] Fix | Delete

[435] Fix | Delete

/**

[436] Fix | Delete

* Get query for price filters when dealing with displayed taxes.

[437] Fix | Delete

*

[438] Fix | Delete

* @param float $price_filter Price filter to apply.

[439] Fix | Delete

* @param string $column Price being filtered (min or max).

[440] Fix | Delete

* @param string $operator Comparison operator for column.

[441] Fix | Delete

* @return string Constructed query.

[442] Fix | Delete

*/

[443] Fix | Delete

protected function get_price_filter_query_for_displayed_taxes( $price_filter, $column = 'min_price', $operator = '>=' ) {

[444] Fix | Delete

global $wpdb;

[445] Fix | Delete

[446] Fix | Delete

// Select only used tax classes to avoid unwanted calculations.

[447] Fix | Delete

$product_tax_classes = $wpdb->get_col( "SELECT DISTINCT tax_class FROM {$wpdb->wc_product_meta_lookup};" );

[448] Fix | Delete

[449] Fix | Delete

if ( empty( $product_tax_classes ) ) {

[450] Fix | Delete

return '';

[451] Fix | Delete

}

[452] Fix | Delete

[453] Fix | Delete

$or_queries = array();

[454] Fix | Delete

[455] Fix | Delete

// We need to adjust the filter for each possible tax class and combine the queries into one.

[456] Fix | Delete

foreach ( $product_tax_classes as $tax_class ) {

[457] Fix | Delete

$adjusted_price_filter = $this->adjust_price_filter_for_tax_class( $price_filter, $tax_class );

[458] Fix | Delete

$or_queries[] = $wpdb->prepare(

[459] Fix | Delete

'( wc_product_meta_lookup.tax_class = %s AND wc_product_meta_lookup.`' . esc_sql( $column ) . '` ' . esc_sql( $operator ) . ' %f )',

[460] Fix | Delete

$tax_class,

[461] Fix | Delete

$adjusted_price_filter

[462] Fix | Delete

);

[463] Fix | Delete

}

[464] Fix | Delete

[465] Fix | Delete

// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQL.NotPrepared

[466] Fix | Delete

return $wpdb->prepare(

[467] Fix | Delete

' AND (

[468] Fix | Delete

wc_product_meta_lookup.tax_status = "taxable" AND ( 0=1 OR ' . implode( ' OR ', $or_queries ) . ')

[469] Fix | Delete

OR ( wc_product_meta_lookup.tax_status != "taxable" AND wc_product_meta_lookup.`' . esc_sql( $column ) . '` ' . esc_sql( $operator ) . ' %f )

[470] Fix | Delete

) ',

[471] Fix | Delete

$price_filter

[472] Fix | Delete

);

[473] Fix | Delete

// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQL.NotPrepared

[474] Fix | Delete

}

[475] Fix | Delete

[476] Fix | Delete

/**

[477] Fix | Delete

* If price filters need adjustment to work with displayed taxes, this returns true.

[478] Fix | Delete

*

[479] Fix | Delete

* This logic is used when prices are stored in the database differently to how they are being displayed, with regards

[480] Fix | Delete

* to taxes.

[481] Fix | Delete

*

[482] Fix | Delete

* @return boolean

[483] Fix | Delete

*/

[484] Fix | Delete

protected function adjust_price_filters_for_displayed_taxes() {

[485] Fix | Delete

$display = get_option( 'woocommerce_tax_display_shop' );

[486] Fix | Delete

$database = wc_prices_include_tax() ? 'incl' : 'excl';

[487] Fix | Delete

[488] Fix | Delete

return $display !== $database;

[489] Fix | Delete

}

[490] Fix | Delete

[491] Fix | Delete

/**

[492] Fix | Delete

* Converts price filter from subunits to decimal.

[493] Fix | Delete

*

[494] Fix | Delete

* @param string|int $price_filter Raw price filter in subunit format.

[495] Fix | Delete

* @return float Price filter in decimal format.

[496] Fix | Delete

*/

[497] Fix | Delete

protected function prepare_price_filter( $price_filter ) {

[498] Fix | Delete

return floatval( $price_filter / ( 10 ** wc_get_price_decimals() ) );

[499] Fix | Delete