QueryFilters
in package
Process the query data for filtering purposes.
Do not delete this file until https://github.com/woocommerce/woocommerce/issues/52311 is resolved. The upgrade flow can still load stale autoloader manifests that point to this file.
Tags
Table of Contents
- __construct() : mixed
- Constructor.
- add_query_clauses() : array<string|int, mixed>
- Add conditional query clauses based on the filter params in query vars.
- get_attribute_counts() : array<string|int, mixed>
- Get attribute counts for the current products.
- get_filtered_price() : object
- Get price data for current products.
- get_rating_counts() : array<string|int, mixed>
- Get rating counts for the current products.
- get_stock_status_counts() : array<string|int, mixed>
- Get stock status counts for the current products.
- main_query_filter() : array<string|int, mixed>
- Filter the posts clauses of the main query to support global filters.
Methods
__construct()
Constructor.
public
__construct() : mixed
Tags
Return values
mixed —add_query_clauses()
Add conditional query clauses based on the filter params in query vars.
public
add_query_clauses(array<string|int, mixed> $args, WP_Query $wp_query) : array<string|int, mixed>
Parameters
- $args : array<string|int, mixed>
-
Query args.
- $wp_query : WP_Query
-
WP_Query object.
Return values
array<string|int, mixed> —get_attribute_counts()
Get attribute counts for the current products.
public
get_attribute_counts(array<string|int, mixed> $query_vars, string $attribute_to_count) : array<string|int, mixed>
Parameters
- $query_vars : array<string|int, mixed>
-
The WP_Query arguments.
- $attribute_to_count : string
-
Attribute taxonomy name.
Return values
array<string|int, mixed> — termId=>count pairs.get_filtered_price()
Get price data for current products.
public
get_filtered_price(array<string|int, mixed> $query_vars) : object
Parameters
- $query_vars : array<string|int, mixed>
-
The WP_Query arguments.
Return values
object —get_rating_counts()
Get rating counts for the current products.
public
get_rating_counts(array<string|int, mixed> $query_vars) : array<string|int, mixed>
Parameters
- $query_vars : array<string|int, mixed>
-
The WP_Query arguments.
Return values
array<string|int, mixed> — rating=>count pairs.get_stock_status_counts()
Get stock status counts for the current products.
public
get_stock_status_counts(array<string|int, mixed> $query_vars) : array<string|int, mixed>
Parameters
- $query_vars : array<string|int, mixed>
-
The WP_Query arguments.
Return values
array<string|int, mixed> — status=>count pairs.main_query_filter()
Filter the posts clauses of the main query to support global filters.
public
main_query_filter(array<string|int, mixed> $args, WP_Query $wp_query) : array<string|int, mixed>
Parameters
- $args : array<string|int, mixed>
-
Query args.
- $wp_query : WP_Query
-
WP_Query object.