Tabbed Tag Cloud Parameters

Shortcode

[tag_groups_cloud]

 

Example

[tag_groups_cloud collapsible=1]

 

Data Types

  • string: A text. For identifiers that won’t be visible to visitors you often have to replace spaces with _ or -. If the string contains spaces, you need to wrap it in quotes.
  • integer: A number without decimal places.
  • 0 or 1: 0 turns the feature off and 1 on.

 

Parameters

Tags or Terms

taxonomy

Restrict the tags only to these taxonomies. Available are only taxonomies that have been activated in the Settings.

accepted valuesdefaultexample shortcode
comma-separated list of taxonomy namesTaxonomies selected in the settings under “Basics”.taxonomy=post_tag,product_tag

smallest

Font-size in pt of the smallest tags.

accepted valuesdefaultexample shortcode
integer12smallest=12

largest

Font-size in pt of the largest tags.

accepted valuesdefaultexample shortcode
integer22largest=20

include_terms

Here you can specify tags/terms by their IDs that alone should be included.

accepted valuesdefaultexample shortcode
comma-separated list of integersempty (= no restriction)include_terms=4,5,212

exclude_terms

Here you can specify a list of tag/term IDs that should be excluded. exclude_terms is ignored if you use include_terms.

accepted valuesdefaultexample shortcode
comma-separated list of integersempty (= no restriction)exclude_terms=3,2,11

orderby

Which field to use for sorting.

optiondescription
namedisplay name of the tag
naturalnatural sort order (See note below.)
countpost count
slugtag slug
term_idID of the tag
descriptiontag description

Since WordPress doesn’t natively offer natural sort order, we have to first order them by name and then by natural sort order. If you limit the number of tags with amount, the amount of tags is therefore determined by cutting off with “name” sorting and then sorting them with “natural”.

accepted valuesdefaultexample shortcode
stringnameorderby=natural

order

Whether to sort the tags in ascending or descending order. Ascending order also means from oldest to newest.

accepted valuesdefaultexample shortcode
stringASCorder=desc

amount

Maximum amount of tags in one cloud (per group).

accepted valuesdefaultexample shortcode
integer0 (unlimited)amount=30

hide_empty

Whether to hide or show tags that are not assigned to any post.

accepted valuesdefaultexample shortcode
0 or 11 (hide empty)hide_empty=1

tags_post_id

Display only tags that are assigned to the post (or page) with a specified ID. If the value is set to 0, the plugin will try to retrieve the current post ID. Turn it off with -1.

accepted valuesdefaultexample shortcode
integer-1 (all tags displayed)tags_post_id=0

assigned_class

A modification of the tags_post_id parameter: Rather than hiding tags that are not assigned to the post (or page), they can be styled differently. Tags will receive this class name with appended _1 or _0. (If you output the tags as an array, a new element with the key “assigned” will be true or false.)

accepted valuesdefaultexample shortcode
stringempty (off)assigned_class=“color-for-assigned-tag”

separator

A separator between the tags.

accepted valuesdefaultexample shortcode
stringemptyseparator=“•”

adjust_separator_size

Whether to adjust the separator’s size to the size of the following tag.

accepted valuesdefaultexample shortcode
0 or 11adjust_separator_size=1

separator_size

The size of the separator, if not automatically adjusted to the size of the following tag.

accepted valuesdefaultexample shortcode
integer12separator_size=12

prepend

Prepend to each tag label. Can obtain the placeholder {count} that will be replaced with the post count for that tag.

accepted valuesdefaultexample shortcode
stringemptyprepend=“#”

append

Append to each tag label. Can obtain the placeholder {count} that will be replaced with the post count for that tag.

accepted valuesdefaultexample shortcode
stringemptyappend=“{count}”

Append something to each tag’s link, for example a query.

accepted valuesdefaultexample shortcode
stringemptylink_append=“track=this”

Set the “target” attribute for the links of the tags. Possible values are: _blank, _self, _parent or _top. In the shortcode you can also set the name of a frame.

accepted valuesdefaultexample shortcode
string: “_blank”, “_self”, “_parent”, “_top”, or the name of a frameempty (= opens in the same window, same as using _self)link_target=“_blank”

show_tag_count

Whether to show the number of posts as tooltip (behind the tag description) when hovering the mouse over the tag.

accepted valuesdefaultexample shortcode
0 or 11 (show)show_tag_count=0

custom_title

Custom title shown as tooltip. No HTML, but you can use {count} and {description} as placeholders.

accepted valuesdefaultexample shortcode
stringempty (using the description, see also show_tag_count)custom_title=“Used for {count} posts.”

add_premium_filter

When you use the premium plugin, additional query parameters in the links make sure that we can distinguish between the same tag that is used in different groups. If the resulting posts are not complete and troubleshooting doesn’t help, you can disable it here.

accepted valuesdefaultexample shortcode
0 or 11 (use the filter)add_premium_filter=0

Groups and Tabs

include

Tag groups that will be considered in the tag cloud. In the short code you use the IDs, which you find in the left column in the list of groups. Empty or not used means that all tag groups will be used.

accepted valuesdefaultexample shortcode
comma-separated list of integersallinclude=“1,5,9”

groups_post_id

Display only groups of which at least one assigned tag is also assigned to the post (or page) with the ID x. If set to 0, it will try to retrieve the current post ID. Matching groups will be added to the list specified by the parameter include

accepted valuesdefaultexample shortcode
integer-1 (all groups displayed).groups_post_id=14

show_tabs

Whether to show the tabs. This option is useful if you want to show only one group – see include.

accepted valuesdefaultexample shortcode
0 or 11show_tabs=0

hide_empty_tabs

Whether to hide tabs without tags.

accepted valuesdefaultexample shortcode
0 or 10 (Not implemented for PHP function with second parameter set to ‘true’. Not effective with groups_post_idhide_empty_tabs=1

show_all_groups

Whether to force showing all groups. Useful with the parameters tags_post_id and assigned_class.

accepted valuesdefaultexample shortcode
0 or 10show_all_groups=1

show_not_assigned

Whether to show all not-assigned tags as an own group.

accepted valuesdefaultexample shortcode
0 or 10show_not_assigned=1

not_assigned_name

The name used in the tab of not-assigned tags, if you activated show_not_assigned.

accepted valuesdefaultexample shortcode
string“not assigned”not_assigned_name=“Other”

collapsible

Whether tabs are collapsible (toggle open/close).

accepted valuesdefaultexample shortcode
0 or 1Settings in the back end.collapsible=1

mouseover

Whether tabs can be selected by hovering over with the mouse pointer (without clicking).

accepted valuesdefaultexample shortcode
0 or 1Settings in the back end.mouseover=1

active

Whether tabs are initially expanded or collapsed. Useful in connection with the parameter collapsible.

accepted valuesdefaultexample shortcode
0 or 11active=1

Advanced Styling

You can set here IDs and classes to be referred to in CSS. You need some knowledge of CSS to use these options.

div_id

Define an ID for the enclosing <div>.

accepted valuesdefaultexample shortcode
stringempty (random value)div_id=“sidebar_01”

div_class

Define a class for the enclosing <div>.

accepted valuesdefaultexample shortcode
stringtag-groups-cloud-tabsdiv_class=“make-it-dark”

ul_class

Define a class for the <ul> that generates the tabs with the group labels.

accepted valuesdefaultexample shortcode
stringemptyul_class=“change-pointer”