Accordion Tag Cloud – Shortcode Parameters

This guide shows you how to use and customize the shortcode for the Accordion Tag Cloud feature in the Tag Groups plugin.


Shortcode #

[tag_groups_accordion]

Example #

[tag_groups_accordion taxonomy=product_tag orderby=count order=desc append="{count}"]

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
Available only in the shortcode!

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
Available only in the shortcode!

orderby #

Which field to use for sorting.

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

threshold #

Set a minimum count of published posts that use a tag for this tag to appear. Posts are counted across all groups. Please also pay attention to the value of hide_empty.

DefaultPossible ValuesExample
0integerthreshold=2

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"
Available only in the shortcode!

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 #

tooltip when hovering the mouse over a tag; placeholders: {count} for post count, {description} for tag description, {name} for tag name

If you also use custom_title_plural then the text of custom_title will be used for a post count of 1 and you can use here the singular form

DefaultPossible ValuesExample
depends on show_tag_countstringcustom_title="One post uses {name}"

custom_title_zero #

tooltip when hovering the mouse over a tag; placeholders: {count} for post count, {description} for tag description, {name} for tag name

This text will be used for tags that have a post count of 0 (i.e. they are not used with any published post).

DefaultPossible ValuesExample
not usedstringcustom_title_zero="No post uses {name}"

custom_title_plural #

tooltip when hovering the mouse over a tag; placeholders: {count} for post count, {description} for tag description, {name} for tag name

This text will be used for tags that have a post count of >1. You can use here plural forms.

DefaultPossible ValuesExample
not usedstringcustom_title_plural="{count} posts use {name}"

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.

accepted valuesdefaultexample shortcode
0 or 10 (no filter)add_premium_filter=1

Groups and Accordion #

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"

exclude #

groups to exclude

DefaultPossible ValuesExample
nonecomma-separated list of group IDsexclude=2,3,5

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_accordion #

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

accepted valuesdefaultexample shortcode
0 or 11show_accordion=0

hide_empty_content #

Whether to hide panels without tags.

accepted valuesdefaultexample shortcode
0 or 10 (Not implemented for PHP function with second parameter set to ‘true’. Not effective with groups_post_id)hide_empty_content=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
Available only in the shortcode!

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 panels are collapsible (toggle open/close).

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

mouseover #

Whether panels 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 panels are initially expanded or collapsed. Useful in connection with the parameter collapsible.

accepted valuesdefaultexample shortcode
0 or 11active=1

heightstyle #

The heightstyle parameter determines how the height of the boxes with tags will be determined. Possible values are “auto” (all boxes will be set to the height of the tallest box), “fill” (expand to the available height based on the accordion’s parent height) or “content” (each panel will be as tall as its content).

accepted valuesdefaultexample shortcode
stringautoheightstyle="make-it-dark"

delay #

Since version 1.29.0, we reveal the tag cloud only after the accordion has finished rendering. This prevents that visitors of your site first see tags in a list (often with bullets) before the software is able to kick in. If for any reason you need to restore the previous behavior, you can turn it off here.

accepted valuesdefaultexample shortcode
integer1 (on)delay=0

group_in_class #

Add class names to each tag that indicates its group ID (tg_tag_group_id_1) and group label (tg_tag_group_label_first_group).

accepted valuesdefaultexample shortcode
0 or 10group_in_class=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>.

  1. If you display more than one tag cloud on the same page, each shortcode needs a different value. The safest solution is to leave it empty so that div_id automatically receives a random value.
  1. Avoid words that are used by WordPress such as “content” or “main”. Each ID must be unique for the entire page.
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-accordiondiv_class="make-it-dark"

header_class #

Define a class for the <h3> that contains the headers.

accepted valuesdefaultexample shortcode
stringemptyheader_class="change-pointer"

inner_div_class #

Define a class for the inner <div> that contains the tags.

accepted valuesdefaultexample shortcode
stringemptyinner_div_class="change-pointer"