Zinn® ChatZinn® Chat shortcodes: every shortcode and attribute
The complete list of Zinn® Chat and knowledge base shortcodes, what each shows, every attribute it accepts, its default, and an example.
Every Zinn® Chat element is a shortcode, a block and a module for the main page builders, with the same options. This page lists every shortcode with every attribute. All attributes are optional.
Attributes that switch something on or off accept yes, no, 1, 0, true or false. Categories and articles can be given by slug or by ID, and several are separated by commas.
[zinn_chat_support]
The whole support page: the submit-a-ticket form for visitors, and a signed-in customer's own requests with their replies.
This shortcode has no attributes.
Example: [zinn_chat_support]
[zinn_chat_ticket_form]
Only the submit-a-ticket form.
| Attribute | Default | What it does |
|---|---|---|
title | (empty) | A heading above the form. |
subject | (empty) | A subject filled in for the customer, for example on a product page. |
button | (empty) | The text of the send button. |
show_subject | yes | Show the subject field (yes) or hide it (no). |
Example: [zinn_chat_ticket_form title="Contact support" button="Send" show_subject="no"]
[zinn_chat_my_tickets]
The signed-in customer's support requests, each with its status and a link to the conversation.
This shortcode has no attributes.
Example: [zinn_chat_my_tickets]
[zinn_chat_button]
A button that opens the chat. Any link to #zinn-chat, or any element with the class zinn-chat-open, does the same.
| Attribute | Default | What it does |
|---|---|---|
label | Chat with us | The button text. |
Example: [zinn_chat_button label="Ask us anything"]
[zinn_kb]
Zinn® Chat Pro
The knowledge base home: a heading, the search box and the category cards with their articles.
| Attribute | Default | What it does |
|---|---|---|
title | (empty) | The heading. Empty uses the knowledge base title from the settings. |
categories | (empty) | Show only these categories. |
exclude | (empty) | Leave these categories out. |
columns | (empty) | Category columns, 1 to 4. Empty uses the settings. |
articles | (empty) | How many articles to list under each category. 0 lists none. |
show_count | (empty) | Show how many articles each category has. |
search | yes | Show the search box. |
Example: [zinn_kb title="Help centre" columns="3" articles="5"]
[zinn_kb_search]
Zinn® Chat Pro
A knowledge base search box. Results appear as the visitor types; without JavaScript it opens the site's search results.
| Attribute | Default | What it does |
|---|---|---|
placeholder | (empty) | The text inside the empty search box. |
button | (empty) | The text of the search button. |
category | (empty) | Search only this category and its sub-categories. |
live | yes | Show results while the visitor types. |
Example: [zinn_kb_search placeholder="How can we help?" category="billing"]
[zinn_kb_categories]
Zinn® Chat Pro
Category cards, with a description, a count and the first articles of each.
| Attribute | Default | What it does |
|---|---|---|
include | (empty) | Show only these categories. |
exclude | (empty) | Leave these categories out. |
parent | (empty) | Show the sub-categories of this category. Empty shows the top level. |
columns | (empty) | Columns, 1 to 4. |
articles | 0 | How many articles to list in each card. |
show_count | (empty) | Show how many articles each category has. |
show_description | yes | Show each category's description. |
orderby | order | The order: order (the Order field of each category), name, or count (most articles first). |
hide_empty | yes | Hide categories that have no articles yet. |
Example: [zinn_kb_categories include="shipping,returns" columns="2" articles="3"]
[zinn_kb_category]
Zinn® Chat Pro
One category page: breadcrumbs, its description, a search box for that category, its sub-categories and its articles.
| Attribute | Default | What it does |
|---|---|---|
category | (empty) | The category to show. Empty uses the category page being viewed. |
title | (empty) | The heading. Empty uses the category name. |
limit | (empty) | How many articles. Empty shows them all. |
orderby | order | The order: order (each article's Order field), title, date, modified or helpful. |
show_excerpt | yes | Show a short summary under each article. |
subcategories | yes | Show the sub-categories above the articles. |
Example: [zinn_kb_category category="shipping" limit="10"]
[zinn_kb_articles]
Zinn® Chat Pro
A list or grid of articles: from a category, chosen by ID, the newest, the most helpful or the most recently updated.
| Attribute | Default | What it does |
|---|---|---|
category | (empty) | Only articles from this category. |
ids | (empty) | These articles, by ID, in this order. |
limit | 10 | How many articles, up to 100. |
orderby | date | The order: date (newest first), modified (recently updated), title, order or helpful (most Yes votes). |
show_excerpt | no | Show a short summary under each article. |
layout | list | list or grid. |
columns | (empty) | Grid columns, 1 to 4. |
title | (empty) | A heading above the list. |
Example: [zinn_kb_articles orderby="helpful" limit="5" title="Most helpful"]
[zinn_kb_article]
Zinn® Chat Pro
One article's content anywhere on the site, for example in a product description.
| Attribute | Default | What it does |
|---|---|---|
id | (empty) | The article, by ID or slug. |
show_title | yes | Show the article's title as a link above it. |
Example: [zinn_kb_article id="return-an-item" show_title="no"]
[zinn_kb_breadcrumbs]
Zinn® Chat Pro
Where the visitor is in the knowledge base (help centre, category, article). Shown automatically on knowledge base pages; use it in your own templates.
This shortcode has no attributes.
Example: [zinn_kb_breadcrumbs]
In the block editor and Page Builder Sandwich, search for Zinn® Chat in the block inserter. In Elementor, Beaver Builder, Divi and Bricks, the same elements are in the widget list under Zinn® Chat.
Included with Zinn Digital® hosting
Already installed on every WordPress site we host
The free Zinn® Chat plugin comes installed and activated on every WordPress site we host on our own servers, so a chat is one switch away. Premium is an upgrade, per site, when you need more.