Ultimate Tag Cloud Widget
Back to top  

Configuration class for the widget.

since 2.0
package utcw
subpackage main

 Methods

Loads a configuration instance array and parses the options

__construct(array $input, \UTCW_Plugin $plugin) 
since 2.0

Parameters

$input

array

Array of key => value pairs of settings and values

$plugin

\UTCW_Plugin

Reference to the main plugin instance

Returns the default values for all the configuration options

getDefaults() : array
Static
static
since 2.0

Returns

array

Returns an array of current configuration

getInstance() : array
since 2.0

Returns

array

Checks if the two measurements have the same unit

equalUnits(string $measurement1, string $measurement2) : bool
since 2.1

Parameters

$measurement1

string

$measurement2

string

Returns

bool

Checks if every item in the array is numeric

isArrayNumeric(array $array) : bool
since 2.0

Parameters

$array

array

Returns

bool

Parses the input value as measurement

parseMeasurement(mixed $input) : bool | string
since 2.1

Parameters

$input

mixed

Returns

boolstringFalse on failure

 Properties

 

$after_title : string

The default value for this setting will probably be determined by the theme Default: (an empty string)

since 2.0
 

$after_widget : string

The default value for this setting will probably be determined by the theme Default: (an empty string)

since 2.0
 

$authors : array

An empty array will include all authors Default: [] (an empty array)

since 2.0
 

$before_title : string

The default value for this setting will probably be determined by the theme Default: (an empty string)

since 2.0
 

$before_widget : string

The default value for this setting will probably be determined by the theme Default: (an empty string)

since 2.0
 

$case_sensitive : bool
since 2.0
 

$color : string
since 2.0
 

$color_set : array
since 2.0
 

$color_span_from : string

This is the color that the biggest tag will get. Default: (an empty string)

since 2.0
 

$color_span_to : string

This is the color that the smallest tag will get. Default: (an empty string)

since 2.0
 

$days_old : int
since 2.0
 

$debug : bool
since 2.0
 

$hover_bg_color : string
since 2.0
 

$hover_bold : string
since 2.0
 

$hover_border_color : string
since 2.0
 

$hover_border_style : string
since 2.0
 

$hover_border_width : string
since 2.0
 

$hover_color : string
since 2.0
 

$hover_italic : string
since 2.0
 

$hover_underline : string
since 2.0
 

$letter_spacing : string
since 2.0
 

$line_height : string
since 2.0
 

$link_bg_color : string
since 2.0
 

$link_bold : string
since 2.0
 

$link_border_color : string
since 2.0
 

$link_border_style : string
since 2.0
 

$link_border_width : string
since 2.0
 

$link_italic : string
since 2.0
 

$link_underline : string
since 2.0
 

$max : int
since 2.0
 

$minimum : int
since 2.0
 

$order : string
since 2.0
 

$post_type : array
since 2.0
 

$prefix : string
since 2.0
 

$reverse : bool
since 2.0
 

$separator : string
since 2.0
 

$show_links : bool
since 2.2
 

$show_title : bool
since 2.0
 

$show_title_text : bool
since 2.0
 

$size_from : string
since 2.0
 

$size_to : string
since 2.0
 

$strategy : string
since 2.2
 

$suffix : string
since 2.0
 

$tag_spacing : string
since 2.0
 

$tags_list : array

Inclusion or exclusion is determined by $tags_list_type Default: [] (an empty array)

since 2.0
 

$tags_list_type : string
since 2.0
 

$taxonomy : array
since 2.0
 

$text_transform : string
since 2.0
 

$title : string

Default value: Tag cloud

since 2.0
 

$word_spacing : string
since 2.0
 

$allowed_border_styles : array
since 2.0
 

$allowed_colors : array
since 2.0
 

$allowed_optional_booleans : array

These are values which can be true, false or fallback to theme default (where applicable)

since 2.0
 

$allowed_orders : array
since 2.0
 

$allowed_post_types : array

Will be set dynamically at load

since 2.0
 

$allowed_strategies : array
since 2.2
 

$allowed_tags_list_types : array
since 2.0
 

$allowed_taxonomies : array

Will be set dynamically at load

since 2.0
 

$allowed_text_transforms : array
since 2.0
 

$options : array
static
since 2.0