WooCommerce Code Reference

WC_Widget_Layered_Nav extends WC_Widget
in package

Widget layered nav class.

Table of Contents

$settings  : array
Settings.
$widget_cssclass  : string
CSS class.
$widget_description  : string
Widget description.
$widget_id  : string
Widget ID.
$widget_name  : string
Widget name.
__construct()  : mixed
Constructor.
cache_widget()  : string
Cache the widget.
flush_widget_cache()  : mixed
Flush the cache.
form()  : mixed
Outputs the settings update form.
get_cached_widget()  : bool
Get cached widget.
init_settings()  : mixed
Init settings after post types are registered.
update()  : array
Updates a particular instance of a widget.
widget()  : mixed
Output widget.
widget_end()  : mixed
Output the html at the end of a widget.
widget_start()  : mixed
Output the html at the start of a widget.
get_current_page_url()  : string
Get current page URL with various filtering props supported by WC.
get_current_taxonomy()  : string
Return the currently viewed taxonomy name.
get_current_term_id()  : int
Return the currently viewed term ID.
get_current_term_slug()  : int
Return the currently viewed term slug.
get_filtered_term_product_counts()  : array
Count products within certain terms, taking the main WP query into consideration.
get_instance_display_type()  : string
Get this widgets display type.
get_instance_query_type()  : string
Get this widgets query type.
get_instance_taxonomy()  : string
Get this widgets taxonomy.
get_instance_title()  : string
Get this widgets title.
get_main_meta_query()  : array
Wrapper for WC_Query::get_main_search_queryget_main_meta_query to ease unit testing.
get_main_search_query_sql()  : string
Wrapper for WC_Query::get_main_search_query_sql() to ease unit testing.
get_main_tax_query()  : array
Wrapper for WC_Query::get_main_tax_query() to ease unit testing.
get_widget_id_for_cache()  : string
Get widget id plus scheme/protocol to prevent serving mixed content from (persistently) cached widgets.
layered_nav_dropdown()  : bool
Show dropdown layered nav.
layered_nav_list()  : bool
Show list based layered nav.

Properties

Methods

cache_widget()

Cache the widget.

public cache_widget(array $args, string $content) : string
Parameters
$args : array

Arguments.

$content : string

Content.

Return values
stringthe content that was cached

get_cached_widget()

Get cached widget.

public get_cached_widget(array $args) : bool
Parameters
$args : array

Arguments.

Return values
booltrue if the widget is cached otherwise false

update()

Updates a particular instance of a widget.

public update(array $new_instance, array $old_instance) : array
Parameters
$new_instance : array

New Instance.

$old_instance : array

Old Instance.

Tags
see

WP_Widget->update

Return values
array

widget_start()

Output the html at the start of a widget.

public widget_start(array $args, array $instance) : mixed
Parameters
$args : array

Arguments.

$instance : array

Instance.

Return values
mixed

get_current_page_url()

Get current page URL with various filtering props supported by WC.

protected get_current_page_url() : string
Tags
since
3.3.0
Return values
string

get_filtered_term_product_counts()

Count products within certain terms, taking the main WP query into consideration.

protected get_filtered_term_product_counts(array $term_ids, string $taxonomy, string $query_type) : array

This query allows counts to be generated based on the viewed products, not all products.

Parameters
$term_ids : array

Term IDs.

$taxonomy : string

Taxonomy.

$query_type : string

Query Type.

Return values
array

get_instance_display_type()

Get this widgets display type.

protected get_instance_display_type(array $instance) : string
Parameters
$instance : array

Array of instance options.

Return values
string

get_instance_query_type()

Get this widgets query type.

protected get_instance_query_type(array $instance) : string
Parameters
$instance : array

Array of instance options.

Return values
string

get_instance_taxonomy()

Get this widgets taxonomy.

protected get_instance_taxonomy(array $instance) : string
Parameters
$instance : array

Array of instance options.

Return values
string

get_instance_title()

Get this widgets title.

protected get_instance_title(array $instance) : string
Parameters
$instance : array

Array of instance options.

Return values
string

get_main_meta_query()

Wrapper for WC_Query::get_main_search_queryget_main_meta_query to ease unit testing.

protected get_main_meta_query() : array
Tags
since
4.4.0
Return values
array

get_main_search_query_sql()

Wrapper for WC_Query::get_main_search_query_sql() to ease unit testing.

protected get_main_search_query_sql() : string
Tags
since
4.4.0
Return values
string

get_widget_id_for_cache()

Get widget id plus scheme/protocol to prevent serving mixed content from (persistently) cached widgets.

protected get_widget_id_for_cache(string $widget_id[, string $scheme = '' ]) : string
Parameters
$widget_id : string

Id of the cached widget.

$scheme : string = ''

Scheme for the widget id.

Tags
since
3.4.0
Return values
stringWidget id including scheme/protocol.

layered_nav_dropdown()

Show dropdown layered nav.

protected layered_nav_dropdown(array $terms, string $taxonomy, string $query_type) : bool
Parameters
$terms : array

Terms.

$taxonomy : string

Taxonomy.

$query_type : string

Query Type.

Return values
boolWill nav display?

layered_nav_list()

Show list based layered nav.

protected layered_nav_list(array $terms, string $taxonomy, string $query_type) : bool
Parameters
$terms : array

Terms.

$taxonomy : string

Taxonomy.

$query_type : string

Query Type.

Return values
boolWill nav display?