WC_Admin_List_Table_Products
extends WC_Admin_List_Table
in package
WC_Admin_List_Table_Products Class.
Table of Contents
- $list_table_type : string
- Post type.
- $object : object|null
- Object being shown on the row.
- $cogs_is_enabled : bool
- Caches the value of the "COGS is enabled" flag.
- $use_cogs_lookup_column : bool
- Flag indicating if the COGS value column in the product meta lookup table can be used.
- __construct() : mixed
- Constructor.
- add_custom_query_var() : array<string|int, mixed>
- Query vars for custom searches.
- add_sample_product_badge() : mixed
- Add a sample product badge to the product list table.
- add_variation_parents_for_shipping_class() : array<string|int, mixed>
- Modifies post query so that it includes parent products whose variations have particular shipping class assigned.
- default_hidden_columns() : array<string|int, mixed>
- Adjust which columns are displayed by default.
- define_bulk_actions() : array<string|int, mixed>
- Define bulk actions.
- define_columns() : array<string|int, mixed>
- Define which columns to show on this screen.
- define_sortable_columns() : array<string|int, mixed>
- Define which columns are sortable.
- disable_view_mode() : array<string|int, mixed>
- Removes this type from list of post types that support "View Mode" switching.
- filter_downloadable_post_clauses() : array<string|int, mixed>
- Filter by type.
- filter_stock_status_post_clauses() : array<string|int, mixed>
- Filter by stock status.
- filter_virtual_post_clauses() : array<string|int, mixed>
- Filter by type.
- handle_bulk_actions() : string
- Handle bulk actions.
- list_table_primary_column() : string
- Set list table primary column.
- maybe_render_blank_state() : mixed
- Show blank slate.
- order_by_cogs_value_asc_post_clauses() : array<string|int, mixed>
- Handle COGS value sorting.
- order_by_cogs_value_desc_post_clauses() : array<string|int, mixed>
- Handle COGS value sorting.
- order_by_global_unique_id_asc_post_clauses() : array<string|int, mixed>
- Handle global unique ID sorting.
- order_by_global_unique_id_desc_post_clauses() : array<string|int, mixed>
- Handle global unique ID sorting.
- order_by_price_asc_post_clauses() : array<string|int, mixed>
- Handle numeric price sorting.
- order_by_price_desc_post_clauses() : array<string|int, mixed>
- Handle numeric price sorting.
- order_by_sku_asc_post_clauses() : array<string|int, mixed>
- Handle sku sorting.
- order_by_sku_desc_post_clauses() : array<string|int, mixed>
- Handle sku sorting.
- order_search_results() : array<string|int, mixed>
- Prioritize title matches in unsorted product searches.
- posts_clauses() : array<string|int, mixed>
- Undocumented function
- prime_thumbnail_caches() : array<string|int, mixed>
- Prime featured image caches for product queries to avoid individual queries during rendering.
- product_views() : array<string|int, mixed>
- Change views on the edit product screen.
- remove_ordering_args() : array<string|int, mixed>
- Remove ordering queries.
- render_columns() : mixed
- Render individual columns.
- render_products_stock_status_filter() : mixed
- Render the stock status filter for the list table.
- request_query() : array<string|int, mixed>
- Handle any filters.
- restrict_manage_posts() : mixed
- See if we should render search filters or not.
- row_actions() : array<string|int, mixed>
- Set row actions.
- search_label() : string
- Change the label when searching products
- sku_search() : string
- Search by SKU or ID for products.
- define_hidden_columns() : array<string|int, mixed>
- Define which columns are hidden by default.
- get_primary_column() : string
- Define primary column.
- get_row_actions() : array<string|int, mixed>
- Get row actions to show in the list table.
- prepare_row_data() : mixed
- Pre-fetch any data for the row each column has access to it. the_product global is there for bw compat.
- query_filters() : array<string|int, mixed>
- Handle any custom filters.
- render_blank_state() : mixed
- Render blank state.
- render_cogs_value_column() : mixed
- Render column: cost.
- render_featured_column() : mixed
- Render column: featured.
- render_filters() : mixed
- Render any custom filters and search inputs for the list table.
- render_global_unique_id_column() : mixed
- Render column: global_unique_id.
- render_is_in_stock_column() : mixed
- Render column: is_in_stock.
- render_name_column() : mixed
- Render column: name.
- render_price_column() : mixed
- Render column: price.
- render_product_cat_column() : mixed
- Render column: product_cat.
- render_product_tag_column() : mixed
- Render column: product_tag.
- render_products_category_filter() : mixed
- Render the product category filter for the list table.
- render_products_type_filter() : mixed
- Render the product type filter for the list table.
- render_sku_column() : mixed
- Render column: sku.
- render_thumb_column() : mixed
- Render column: thumb.
- append_product_sorting_table_join() : string
- Join wc_product_meta_lookup to posts if not already joined.
- build_title_match_case_clause() : string
- Build the relevance expression that ranks title matches ahead of the remaining search results.
- get_default_search_order() : string|null
- Get the default ordering mode for a product search.
- get_search_stopwords() : array<string|int, string>
- Retrieve stopwords used when parsing product search terms.
- get_valid_search_terms() : array<string|int, string>
- Remove unsuitable product search terms.
- orderby_leads_with() : bool
- Determine whether a clause still leads with the ordering core generated for this view.
- parse_search_terms() : array<string|int, string>
- Parse a product search group using WooCommerce search-term rules.
Properties
$list_table_type
Post type.
protected
string
$list_table_type
= 'product'
$object
Object being shown on the row.
protected
object|null
$object
=
ull
$cogs_is_enabled
Caches the value of the "COGS is enabled" flag.
private
bool
$cogs_is_enabled
$use_cogs_lookup_column
Flag indicating if the COGS value column in the product meta lookup table can be used.
private
bool
$use_cogs_lookup_column
Methods
__construct()
Constructor.
public
__construct() : mixed
Return values
mixed —add_custom_query_var()
Query vars for custom searches.
public
add_custom_query_var(mixed $public_query_vars) : array<string|int, mixed>
Parameters
- $public_query_vars : mixed
-
Array of query vars.
Return values
array<string|int, mixed> —add_sample_product_badge()
Add a sample product badge to the product list table.
public
add_sample_product_badge(string $column_name, int $post_id) : mixed
Parameters
- $column_name : string
-
Column name.
- $post_id : int
-
Post ID.
Tags
Return values
mixed —add_variation_parents_for_shipping_class()
Modifies post query so that it includes parent products whose variations have particular shipping class assigned.
public
add_variation_parents_for_shipping_class(array<string|int, mixed> $pieces, WP_Query $wp_query) : array<string|int, mixed>
Parameters
- $pieces : array<string|int, mixed>
-
Array of SELECT statement pieces (from, where, etc).
- $wp_query : WP_Query
-
WP_Query instance.
Return values
array<string|int, mixed> — Array of products, including parents of variations.default_hidden_columns()
Adjust which columns are displayed by default.
public
default_hidden_columns(array<string|int, mixed> $hidden, object $screen) : array<string|int, mixed>
Parameters
- $hidden : array<string|int, mixed>
-
Current hidden columns.
- $screen : object
-
Current screen.
Return values
array<string|int, mixed> —define_bulk_actions()
Define bulk actions.
public
define_bulk_actions(array<string|int, mixed> $actions) : array<string|int, mixed>
Parameters
- $actions : array<string|int, mixed>
-
Existing actions.
Return values
array<string|int, mixed> —define_columns()
Define which columns to show on this screen.
public
define_columns(array<string|int, mixed> $columns) : array<string|int, mixed>
Parameters
- $columns : array<string|int, mixed>
-
Existing columns.
Return values
array<string|int, mixed> —define_sortable_columns()
Define which columns are sortable.
public
define_sortable_columns(array<string|int, mixed> $columns) : array<string|int, mixed>
Parameters
- $columns : array<string|int, mixed>
-
Existing columns.
Return values
array<string|int, mixed> —disable_view_mode()
Removes this type from list of post types that support "View Mode" switching.
public
disable_view_mode(array<string|int, mixed> $post_types) : array<string|int, mixed>
View mode is seen on posts where you can switch between list or excerpt. Our post types don't support it, so we want to hide the useless UI from the screen options tab.
Parameters
- $post_types : array<string|int, mixed>
-
Array of post types supporting view mode.
Return values
array<string|int, mixed> — Array of post types supporting view mode, without this type.filter_downloadable_post_clauses()
Filter by type.
public
filter_downloadable_post_clauses(array<string|int, mixed> $args) : array<string|int, mixed>
Parameters
- $args : array<string|int, mixed>
-
Query args.
Return values
array<string|int, mixed> —filter_stock_status_post_clauses()
Filter by stock status.
public
filter_stock_status_post_clauses(array<string|int, mixed> $args) : array<string|int, mixed>
Parameters
- $args : array<string|int, mixed>
-
Query args.
Return values
array<string|int, mixed> —filter_virtual_post_clauses()
Filter by type.
public
filter_virtual_post_clauses(array<string|int, mixed> $args) : array<string|int, mixed>
Parameters
- $args : array<string|int, mixed>
-
Query args.
Return values
array<string|int, mixed> —handle_bulk_actions()
Handle bulk actions.
public
handle_bulk_actions(string $redirect_to, string $action, array<string|int, mixed> $ids) : string
Parameters
- $redirect_to : string
-
URL to redirect to.
- $action : string
-
Action name.
- $ids : array<string|int, mixed>
-
List of ids.
Return values
string —list_table_primary_column()
Set list table primary column.
public
list_table_primary_column(string $default, string $screen_id) : string
Parameters
- $default : string
-
Default value.
- $screen_id : string
-
Current screen ID.
Return values
string —maybe_render_blank_state()
Show blank slate.
public
maybe_render_blank_state(string $which) : mixed
Parameters
- $which : string
-
String which tablenav is being shown.
Return values
mixed —order_by_cogs_value_asc_post_clauses()
Handle COGS value sorting.
public
order_by_cogs_value_asc_post_clauses(array<string|int, mixed> $args) : array<string|int, mixed>
Parameters
- $args : array<string|int, mixed>
-
Query args.
Return values
array<string|int, mixed> —order_by_cogs_value_desc_post_clauses()
Handle COGS value sorting.
public
order_by_cogs_value_desc_post_clauses(array<string|int, mixed> $args) : array<string|int, mixed>
Parameters
- $args : array<string|int, mixed>
-
Query args.
Return values
array<string|int, mixed> —order_by_global_unique_id_asc_post_clauses()
Handle global unique ID sorting.
public
order_by_global_unique_id_asc_post_clauses(array<string|int, mixed> $args) : array<string|int, mixed>
Parameters
- $args : array<string|int, mixed>
-
Query args.
Return values
array<string|int, mixed> —order_by_global_unique_id_desc_post_clauses()
Handle global unique ID sorting.
public
order_by_global_unique_id_desc_post_clauses(array<string|int, mixed> $args) : array<string|int, mixed>
Parameters
- $args : array<string|int, mixed>
-
Query args.
Return values
array<string|int, mixed> —order_by_price_asc_post_clauses()
Handle numeric price sorting.
public
order_by_price_asc_post_clauses(array<string|int, mixed> $args) : array<string|int, mixed>
Parameters
- $args : array<string|int, mixed>
-
Query args.
Return values
array<string|int, mixed> —order_by_price_desc_post_clauses()
Handle numeric price sorting.
public
order_by_price_desc_post_clauses(array<string|int, mixed> $args) : array<string|int, mixed>
Parameters
- $args : array<string|int, mixed>
-
Query args.
Return values
array<string|int, mixed> —order_by_sku_asc_post_clauses()
Handle sku sorting.
public
order_by_sku_asc_post_clauses(array<string|int, mixed> $args) : array<string|int, mixed>
Parameters
- $args : array<string|int, mixed>
-
Query args.
Return values
array<string|int, mixed> —order_by_sku_desc_post_clauses()
Handle sku sorting.
public
order_by_sku_desc_post_clauses(array<string|int, mixed> $args) : array<string|int, mixed>
Parameters
- $args : array<string|int, mixed>
-
Query args.
Return values
array<string|int, mixed> —order_search_results()
Prioritize title matches in unsorted product searches.
public
order_search_results(array<string|int, mixed> $clauses, WP_Query $query) : array<string|int, mixed>
Runs on posts_clauses rather than posts_orderby so that every posts_orderby callback, at any priority, still observes the ORDER BY clause core generated. Reading it that late means it may already carry third-party ordering, so orderby_leads_with() decides whether ranking still leads.
Parameters
- $clauses : array<string|int, mixed>
-
Array of SELECT statement pieces (from, where, orderby, etc).
- $query : WP_Query
-
WP_Query instance.
Tags
Return values
array<string|int, mixed> —posts_clauses()
Undocumented function
public
posts_clauses(array<string|int, mixed> $args, WP_Query $query) : array<string|int, mixed>
Parameters
- $args : array<string|int, mixed>
-
Array of SELECT statement pieces (from, where, etc).
- $query : WP_Query
-
WP_Query instance.
Return values
array<string|int, mixed> —prime_thumbnail_caches()
Prime featured image caches for product queries to avoid individual queries during rendering.
public
prime_thumbnail_caches(array<string|int, WP_Post> $posts, WP_Query $query) : array<string|int, mixed>
Parameters
- $posts : array<string|int, WP_Post>
-
Posts from WP Query.
- $query : WP_Query
-
Current query.
Tags
Return values
array<string|int, mixed> —product_views()
Change views on the edit product screen.
public
product_views(array<string|int, mixed> $views) : array<string|int, mixed>
Parameters
- $views : array<string|int, mixed>
-
Array of views.
Return values
array<string|int, mixed> —remove_ordering_args()
Remove ordering queries.
public
remove_ordering_args([array<string|int, mixed> $posts = array() ]) : array<string|int, mixed>
Parameters
- $posts : array<string|int, mixed> = array()
-
Posts array, keeping this for backwards compatibility defaulting to empty array.
Return values
array<string|int, mixed> —render_columns()
Render individual columns.
public
render_columns(string $column, int $post_id) : mixed
Parameters
- $column : string
-
Column ID to render.
- $post_id : int
-
Post ID being shown.
Return values
mixed —render_products_stock_status_filter()
Render the stock status filter for the list table.
public
render_products_stock_status_filter() : mixed
Tags
Return values
mixed —request_query()
Handle any filters.
public
request_query(array<string|int, mixed> $query_vars) : array<string|int, mixed>
Parameters
- $query_vars : array<string|int, mixed>
-
Query vars.
Return values
array<string|int, mixed> —restrict_manage_posts()
See if we should render search filters or not.
public
restrict_manage_posts() : mixed
Return values
mixed —row_actions()
Set row actions.
public
row_actions(array<string|int, mixed> $actions, WP_Post $post) : array<string|int, mixed>
Parameters
- $actions : array<string|int, mixed>
-
Array of actions.
- $post : WP_Post
-
Current post object.
Return values
array<string|int, mixed> —search_label()
Change the label when searching products
public
search_label(string $query) : string
Parameters
- $query : string
-
Search Query.
Return values
string —sku_search()
Search by SKU or ID for products.
public
sku_search(string $where) : string
Parameters
- $where : string
-
Where clause SQL.
Tags
Return values
string —define_hidden_columns()
Define which columns are hidden by default.
protected
define_hidden_columns() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_primary_column()
Define primary column.
protected
get_primary_column() : string
Return values
string —get_row_actions()
Get row actions to show in the list table.
protected
get_row_actions(array<string|int, mixed> $actions, WP_Post $post) : array<string|int, mixed>
Parameters
- $actions : array<string|int, mixed>
-
Array of actions.
- $post : WP_Post
-
Current post object.
Return values
array<string|int, mixed> —prepare_row_data()
Pre-fetch any data for the row each column has access to it. the_product global is there for bw compat.
protected
prepare_row_data(int $post_id) : mixed
Parameters
- $post_id : int
-
Post ID being shown.
Return values
mixed —query_filters()
Handle any custom filters.
protected
query_filters(array<string|int, mixed> $query_vars) : array<string|int, mixed>
Parameters
- $query_vars : array<string|int, mixed>
-
Query vars.
Return values
array<string|int, mixed> —render_blank_state()
Render blank state.
protected
render_blank_state() : mixed
Return values
mixed —render_cogs_value_column()
Render column: cost.
protected
render_cogs_value_column() : mixed
Return values
mixed —render_featured_column()
Render column: featured.
protected
render_featured_column() : mixed
Return values
mixed —render_filters()
Render any custom filters and search inputs for the list table.
protected
render_filters() : mixed
Return values
mixed —render_global_unique_id_column()
Render column: global_unique_id.
protected
render_global_unique_id_column() : mixed
Return values
mixed —render_is_in_stock_column()
Render column: is_in_stock.
protected
render_is_in_stock_column() : mixed
Return values
mixed —render_name_column()
Render column: name.
protected
render_name_column() : mixed
Return values
mixed —render_price_column()
Render column: price.
protected
render_price_column() : mixed
Return values
mixed —render_product_cat_column()
Render column: product_cat.
protected
render_product_cat_column() : mixed
Return values
mixed —render_product_tag_column()
Render column: product_tag.
protected
render_product_tag_column() : mixed
Return values
mixed —render_products_category_filter()
Render the product category filter for the list table.
protected
render_products_category_filter() : mixed
Tags
Return values
mixed —render_products_type_filter()
Render the product type filter for the list table.
protected
render_products_type_filter() : mixed
Tags
Return values
mixed —render_sku_column()
Render column: sku.
protected
render_sku_column() : mixed
Return values
mixed —render_thumb_column()
Render column: thumb.
protected
render_thumb_column() : mixed
Return values
mixed —append_product_sorting_table_join()
Join wc_product_meta_lookup to posts if not already joined.
private
append_product_sorting_table_join(string $sql) : string
Parameters
- $sql : string
-
SQL join.
Return values
string —build_title_match_case_clause()
Build the relevance expression that ranks title matches ahead of the remaining search results.
private
build_title_match_case_clause(string $search_term) : string
Parameters
- $search_term : string
-
Search term the product matcher already ran against.
Tags
Return values
string — CASE expression, or an empty string when the term yields no title predicates.get_default_search_order()
Get the default ordering mode for a product search.
private
get_default_search_order(array<string|int, mixed> $query_vars) : string|null
Parameters
- $query_vars : array<string|int, mixed>
-
Query variables.
Return values
string|null —get_search_stopwords()
Retrieve stopwords used when parsing product search terms.
private
get_search_stopwords() : array<string|int, string>
Return values
array<string|int, string> —get_valid_search_terms()
Remove unsuitable product search terms.
private
get_valid_search_terms(array<string|int, string> $terms) : array<string|int, string>
Mirrors WP_Query::get_search_terms(), including its stopword and single-character rules.
Parameters
- $terms : array<string|int, string>
-
Search terms.
Return values
array<string|int, string> —orderby_leads_with()
Determine whether a clause still leads with the ordering core generated for this view.
private
orderby_leads_with(string $orderby, string $core_orderby) : bool
A third party that appends a tiebreak leaves core's ordering in charge of the primary sort, so ranking can still lead. One that prepends or replaces has taken the primary sort over, and ranking defers to it. Only a comma may follow the core clause, so a longer token that merely starts the same way is not mistaken for it.
Parameters
- $orderby : string
-
Clause observed on the query.
- $core_orderby : string
-
Clause core generated for this view.
Tags
Return values
bool —parse_search_terms()
Parse a product search group using WooCommerce search-term rules.
private
parse_search_terms(string $search_group) : array<string|int, string>
Parameters
- $search_group : string
-
Search group without OR separators.