Alphabetical Tag Index – Shortcode Parameters

This is a feature of the free and the premium plans.

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

If you don’t know what is a shortcode and how to use it, you first may want to read this article.

Shortcode

[tag_groups_alphabetical_index]

Example

[tag_groups_alphabetical_index column_count=2]

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

This overview assumes that you know how to use shortcodes. Shortcodes are the traditional WordPress way how to add features into posts, pages and widgets.

amount

the maximum number of tags per group to display

append

adds something behind the tag name; placeholder: {count} for post count

column_count

number of columns; for responsive design follow these instructions

column_gap

width of the gap between columns

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

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).

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.

div_class

class of the enclosing div for own styling

div_id

ID of the enclosing div

exclude_letters

letters/characters that should not appear in the list

exclude_terms

a list of tags that should not appear

h_level

<h3>/h3>, <h4></h4>, … of the headings with the group names

header_class

class for the headers

hide_empty

hide tags with post count zero

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.

include

groups to include

exclude

groups to exclude

include_letters

which first letters to use

include_terms

tags to include (see also “hide_empty”)

keep_together

whether to keep headings and tag block together; otherwise tags lists may continue in a new column

largest

max. font size in pt

link_target

target attribute of the tag link (_blank, _top, _self, …)

link_append

append query to the link

locale

Customize the locale (language-specific setting) that is used for sorting the first letters (initials). By default we use the language setting of your site. This sort order affects only the order of the first letters, not the tag order (see “orderby” and “order”).

Accepted values depend on which locales PHP can use on your server. They can have formats like “fr”, “fr_FR” or “fr_FR.UTF8”. Please ask your provider if you cannot find it by guessing or googling.

ignore_accents

If you turn this on, then accented (or umlaut) letters will be treated like normal letters. For a list of changes see remove_accents.

order

ascending or descending order; use with orderby

orderby

by what to order the tags

use together with order

prepend

prepend to the tag; placeholder: {count} for post count

show_tag_count

show the post count in the title (deprecated option, better use custom_title

smallest

min. font size in pt

tags_div_class

class name for the divs around tags

tags_post_id

Use post ID or zero for current post.

taxonomy

taxonomies (tag types) to use