WC_Product_Table_Query
extends Table_Query
in package
Responsible for managing the product table query, retrieving the list of products (as an array of WP_Post objects), and finding the product totals.
Tags
Table of Contents
- $args : mixed
- $products : mixed
- $total_filtered_products : mixed
- $total_products : mixed
- __construct() : mixed
- Table_Query constructor.
- get_products() : array<string|int, mixed>|null
- Get the list of products for this table query.
- get_total_filtered_products() : mixed
- get_total_products() : mixed
- set_products() : mixed
- set_total_filtered_products() : mixed
- set_total_products() : mixed
- add_user_search_args() : mixed
- append_ordering_args() : array<string|int, mixed>
- Add the ordering args for our product query.
- build_base_product_query() : mixed
- build_meta_query() : mixed
- build_product_query() : mixed
- build_product_totals_query() : mixed
- build_search_filters_tax_query() : mixed
- build_tax_query() : mixed
- check_within_product_limit() : mixed
- get_user_products() : mixed
- maybe_add_relation() : mixed
- run_product_query() : mixed
- tax_query_item() : mixed
Properties
$args
public
mixed
$args
$products
private
mixed
$products
= null
$total_filtered_products
private
mixed
$total_filtered_products
= null
$total_products
private
mixed
$total_products
= null
Methods
__construct()
Table_Query constructor.
public
__construct(Table_Args $args) : mixed
Parameters
- $args : Table_Args
Return values
mixed —get_products()
Get the list of products for this table query.
public
get_products() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —An array of WC_Product objects.
get_total_filtered_products()
public
get_total_filtered_products() : mixed
Return values
mixed —get_total_products()
public
get_total_products() : mixed
Return values
mixed —set_products()
public
set_products(mixed $products) : mixed
Parameters
- $products : mixed
Return values
mixed —set_total_filtered_products()
public
set_total_filtered_products(mixed $total_filtered_products) : mixed
Parameters
- $total_filtered_products : mixed
Return values
mixed —set_total_products()
public
set_total_products(mixed $total_products) : mixed
Parameters
- $total_products : mixed
Return values
mixed —add_user_search_args()
private
add_user_search_args(array<string|int, mixed> $query_args) : mixed
Parameters
- $query_args : array<string|int, mixed>
Return values
mixed —append_ordering_args()
Add the ordering args for our product query.
private
append_ordering_args(array<string|int, mixed> $query_args) : array<string|int, mixed>
Note: for standard loading, DataTables will re-sort the results if the sort column is present in table.
Parameters
- $query_args : array<string|int, mixed>
-
The query args.
Return values
array<string|int, mixed> —The updated query args.
build_base_product_query()
private
build_base_product_query() : mixed
Return values
mixed —build_meta_query()
private
build_meta_query() : mixed
Return values
mixed —build_product_query()
private
build_product_query() : mixed
Return values
mixed —build_product_totals_query()
private
build_product_totals_query() : mixed
Return values
mixed —build_search_filters_tax_query()
private
build_search_filters_tax_query([mixed $tax_query = [] ]) : mixed
Parameters
- $tax_query : mixed = []
Return values
mixed —build_tax_query()
private
build_tax_query() : mixed
Return values
mixed —check_within_product_limit()
private
check_within_product_limit(mixed $count) : mixed
Parameters
- $count : mixed
Return values
mixed —get_user_products()
private
get_user_products() : mixed
Return values
mixed —maybe_add_relation()
private
maybe_add_relation(mixed $query[, mixed $relation = 'AND' ]) : mixed
Parameters
- $query : mixed
- $relation : mixed = 'AND'
Return values
mixed —run_product_query()
private
run_product_query(mixed $query_args) : mixed
Parameters
- $query_args : mixed
Return values
mixed —tax_query_item()
private
tax_query_item(mixed $terms, mixed $taxonomy[, mixed $operator = 'IN' ][, mixed $field = '' ]) : mixed
Parameters
- $terms : mixed
- $taxonomy : mixed
- $operator : mixed = 'IN'
- $field : mixed = ''