Table Tag Cloud Parameters

205 0 0 June 2, 2019

This is a feature of the premium plugin.

Note: This shortcode is also available as Gutenberg block. You can configure the block without using any code or parameters.

Shortcode

[tag_groups_table]

Example

[tag_groups_table include=3,5,6 smallest=16 largest=16]

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.

Gutenberg Block

If you are using Gutenberg, most of the parameters below will also be available in the corresponding block. You can always convert a block to a shortcode while preserving your settings.

Parameters

Tags or Terms

taxonomy

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

accepted values	default	example shortcode
comma-separated list of taxonomy names	Taxonomies selected in the settings under “Basics”.	`taxonomy=post_tag,product_tag`

smallest

Font-size in pt of the smallest tags.

accepted values	default	example shortcode
integer	12	`smallest=12`

largest

Font-size in pt of the largest tags.

accepted values	default	example shortcode
integer	22	`largest=20`

orderby

Which field to use for sorting.

option	description
name	display name of the tag
natural	natural sort order (See note below.)
count	post count
slug	tag slug
term_id	ID of the tag
description	tag 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 values	default	example shortcode
string	name	`orderby=natural`

order

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

accepted values	default	example shortcode
string	ASC	`order=desc`

amount

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

accepted values	default	example shortcode
integer	0 (unlimited)	`amount=30`

hide_empty

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

accepted values	default	example shortcode
0 or 1	1 (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 values	default	example 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 values	default	example shortcode
string	empty (off)	`assigned_class=“color-for-assigned-tag”`

separator

A separator between the tags.

accepted values	default	example shortcode
string	empty	`separator=“•”`

adjust_separator_size

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

accepted values	default	example shortcode
0 or 1	1	`adjust_separator_size=1`

separator_size

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

accepted values	default	example shortcode
integer	12	`separator_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 values	default	example shortcode
string	empty	`prepend=“#”`

append

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

accepted values	default	example shortcode
string	empty	`append=“{count}”`

link_target

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 values	default	example shortcode
string: “_blank”, “_self”, “_parent”, “_top”, or the name of a frame	empty (= opens in the same window, same as using _self)	`link_target=“_blank”`

link_append

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

accepted values	default	example shortcode
string	empty	`link_append=“track=this”`

Available only in the shortcode!

show_tag_count

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

accepted values	default	example shortcode
0 or 1	1 (show)	`show_tag_count=0`

custom_title

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

accepted values	default	example shortcode
string	empty (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 values	default	example shortcode
0 or 1	0 (no filter)	`add_premium_filter=1`

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 values	default	example shortcode
comma-separated list of integers	all	`include=“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 values	default	example shortcode
integer	-1 (all groups displayed).	`groups_post_id=14`

hide_empty_columns

Whether to force hide columns (groups) that contain no tags.

accepted values	default	example shortcode
0 or 1	0	`hide_empty_columns=1`

show_all_groups

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

accepted values	default	example shortcode
0 or 1	0	`show_all_groups=1`

Available only in the shortcode!

show_not_assigned

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

accepted values	default	example shortcode
0 or 1	0	`show_not_assigned=1`

In the Gutenberg block this parameter is not available. Instead, add the “not assigned” group to the list of included groups.

not_assigned_name

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

accepted values	default	example shortcode
string	“not assigned”	`not_assigned_name=“Other”`

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.

responsive_breakpoint

Width of the viewport (window) when the table should switch into responsive mode.

accepted values	default	example shortcode
integer	800	`responsive_breakpoint=500`

table_id

Define an ID for the enclosing <table>.

Avoid words that are used by WordPress such as “content” or “main”. Each ID must be unique for the entire page.

accepted values	default	example shortcode
string	empty	`table_id=“sidebar_01”`

table_class

Define a class for the enclosing <table>.

accepted values	default	example shortcode
string	tag-groups-cloud-table	`table_class=“make-it-dark”`

th_class

Define a class for the <th>.

accepted values	default	example shortcode
string	empty	`th_class=“change-pointer”`

td_class

Define a class for the <td>.

accepted values	default	example shortcode
string	empty	`td_class=“change-pointer”`