WC_Widget_Product_Categories
extends WC_Widget
in package
Product categories widget class.
Tags
Table of Contents
- $cat_ancestors : array<string|int, mixed>
- Category ancestors.
- $current_cat : bool
- Current Category.
- $settings : array<string|int, mixed>
- 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.
- update() : array<string|int, mixed>
- 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_instance_title() : string
- Get this widgets title.
- get_widget_id_for_cache() : string
- Get widget id plus scheme/protocol to prevent serving mixed content from (persistently) cached widgets.
Properties
$cat_ancestors
Category ancestors.
public
array<string|int, mixed>
$cat_ancestors
$current_cat
Current Category.
public
bool
$current_cat
$settings
Settings.
public
array<string|int, mixed>
$settings
$widget_cssclass
CSS class.
public
string
$widget_cssclass
$widget_description
Widget description.
public
string
$widget_description
$widget_id
Widget ID.
public
string
$widget_id
$widget_name
Widget name.
public
string
$widget_name
Methods
__construct()
Constructor.
public
__construct() : mixed
Return values
mixed —cache_widget()
Cache the widget.
public
cache_widget(array<string|int, mixed> $args, string $content) : string
Parameters
- $args : array<string|int, mixed>
-
Arguments.
- $content : string
-
Content.
Return values
string — the content that was cachedflush_widget_cache()
Flush the cache.
public
flush_widget_cache() : mixed
Return values
mixed —form()
Outputs the settings update form.
public
form(array<string|int, mixed> $instance) : mixed
Parameters
- $instance : array<string|int, mixed>
-
Instance.
Tags
Return values
mixed —get_cached_widget()
Get cached widget.
public
get_cached_widget(array<string|int, mixed> $args) : bool
Parameters
- $args : array<string|int, mixed>
-
Arguments.
Return values
bool — true if the widget is cached otherwise falseupdate()
Updates a particular instance of a widget.
public
update(array<string|int, mixed> $new_instance, array<string|int, mixed> $old_instance) : array<string|int, mixed>
Parameters
- $new_instance : array<string|int, mixed>
-
New instance.
- $old_instance : array<string|int, mixed>
-
Old instance.
Tags
Return values
array<string|int, mixed> —widget()
Output widget.
public
widget(array<string|int, mixed> $args, array<string|int, mixed> $instance) : mixed
Parameters
- $args : array<string|int, mixed>
-
Widget arguments.
- $instance : array<string|int, mixed>
-
Widget instance.
Tags
Return values
mixed —widget_end()
Output the html at the end of a widget.
public
widget_end(array<string|int, mixed> $args) : mixed
Parameters
- $args : array<string|int, mixed>
-
Arguments.
Return values
mixed —widget_start()
Output the html at the start of a widget.
public
widget_start(array<string|int, mixed> $args, array<string|int, mixed> $instance) : mixed
Parameters
- $args : array<string|int, mixed>
-
Arguments.
- $instance : array<string|int, mixed>
-
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
Return values
string —get_instance_title()
Get this widgets title.
protected
get_instance_title(array<string|int, mixed> $instance) : string
Parameters
- $instance : array<string|int, mixed>
-
Array of instance options.
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.