WooCommerce Code Reference

Search results

WC_Widget_Product_Tag_Cloud extends WC_Widget

Widget product tag cloud

Table of Contents

$widget_cssclass CSS class. string
$widget_description Widget description. string
$widget_id Widget ID. string
$widget_name Widget name. string
$settings Settings. array
__construct() Constructor. mixed
widget() Output widget. mixed
get_current_taxonomy() Return the taxonomy being displayed. string
topic_count_text() Returns topic count text. string
_get_current_taxonomy() Return the taxonomy being displayed. string
_topic_count_text() Returns topic count text. string
__construct() Constructor. mixed
get_cached_widget() Get cached widget. bool
cache_widget() Cache the widget. string
flush_widget_cache() Flush the cache. mixed
get_instance_title() Get this widgets title. string
widget_start() Output the html at the start of a widget. mixed
widget_end() Output the html at the end of a widget. mixed
update() Updates a particular instance of a widget. array
form() Outputs the settings update form. mixed
get_current_page_url() Get current page URL with various filtering props supported by WC. string
get_widget_id_for_cache() Get widget id plus scheme/protocol to prevent serving mixed content from (persistently) cached widgets. string

Properties

Methods

widget()

Output widget.

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

Arguments.

$instance : array

Widget instance.

Tags
see
Return values
mixed

get_current_taxonomy()

Return the taxonomy being displayed.

public get_current_taxonomy( $instance : object ) : string
Parameters
$instance : object

Widget instance.

Return values
string

topic_count_text()

Returns topic count text.

public topic_count_text( $count : int ) : string
Parameters
$count : int

Count text.

Tags
since
Return values
string

_get_current_taxonomy()

Return the taxonomy being displayed.

public _get_current_taxonomy( $instance : object ) : string
Parameters
$instance : object

Widget instance.

Tags
deprecated
Return values
string

_topic_count_text()

Returns topic count text.

public _topic_count_text( $count : int ) : string
Parameters
$count : int

Count text.

Tags
deprecated
since
Return values
string

get_cached_widget()

Get cached widget.

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

Arguments.

Return values
bool

true if the widget is cached otherwise false

cache_widget()

Cache the widget.

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

Arguments.

$content : string

Content.

Return values
string

the content that was cached

flush_widget_cache()

Flush the cache.

public flush_widget_cache( ) : mixed
Return values
mixed

get_instance_title()

Get this widgets title.

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

Array of instance options.

Return values
string

widget_start()

Output the html at the start of a widget.

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

Arguments.

$instance : array

Instance.

Return values
mixed

widget_end()

Output the html at the end of a widget.

public widget_end( $args : array ) : mixed
Parameters
$args : array

Arguments.

Return values
mixed

update()

Updates a particular instance of a widget.

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

New instance.

$old_instance : array

Old instance.

Tags
see

WP_Widget->update

Return values
array

form()

Outputs the settings update form.

public form( $instance : array ) : mixed
Parameters
$instance : array

Instance.

Tags
see

WP_Widget->form

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
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( $widget_id : string [, $scheme : string = '' ] ) : string
Parameters
$widget_id : string

Id of the cached widget.

$scheme : string = ''

Scheme for the widget id.

Tags
since
Return values
string

Widget id including scheme/protocol.

Back to the top