Limited Time Offer

Save 25% on our plugins with this coupon:

LOVEWORDPRESS

Buy Now
Skip to content
TaxoPress
  • TaxoPress
  • Tag Groups
  • Docs
  • Blog
  • Support
  • Login
Buy Now
TaxoPress

Tag Groups: Getting Started

  • Introduction to Tag Groups
  • How to Install Tag Groups Free
  • How to Install Tag Groups Pro
  • First Steps With Tag Groups
  • Tag Groups Free vs Pro

How to Use Groups for Tags

  • Creating and Editing Groups
  • Filter Tag Groups on the Tags Screen
  • Bulk Actions for Groups on the Tags Screen
  • Organizing Groups with a Parent Level
  • Using the Tag Groups Metabox on the Post Edit Screen

Display Options for Tags

  • How To Use Gutenberg Blocks With Tag Groups
  • How to Use Shortcodes With Tag Groups
  • Tag Groups Themes: Design and Colors
  • How to Design Tag Colors in Tag Groups
  • How to Modify a Theme in Tag Groups
  • Create Your Own Accordion and Tab Themes

Tag List

  • Tag List – Overview
  • Tag List – Gutenberg Block
  • Tag List – Shortcode Parameters

Tabbed Tag Cloud

  • Tabbed Tag Cloud – Overview
  • Tabbed Tag Cloud – Gutenberg Block
  • Tabbed Tag Cloud – Shortcode Parameters
  • Tabbed Tag Cloud – Themes

Alphabetical Tag Index

  • Alphabetical Tag Index – Overview
  • Alphabetical Tag Index – Gutenberg Block
  • Alphabetical Tag Index – Shortcode Parameters

Alphabetical Tag Cloud

  • Alphabetical Tag Cloud – Overview
  • Alphabetical Tag Cloud – Gutenberg Block
  • Alphabetical Tag Cloud – Shortcode Parameters
  • Alphabetical Tag Cloud – Themes

Accordion Tag Cloud

  • Accordion Tag Cloud – Overview
  • Accordion Tag Cloud – Gutenberg Block
  • Accordion Tag Cloud – Shortcode Parameters
  • Accordion Tag Cloud – Themes

Tag Groups Info

  • Tag Groups Info – Overview
  • Tag Groups Info – Shortcode Parameters

Show Tags Under Posts (Pro)

  • How to Show Tag Groups on Posts
  • Change the Icons on Tags Under Posts

Shuffle Box (Pro)

  • Shuffle Box – Overview
  • Shuffle Box – Gutenberg Block
  • Shuffle Box – Shortcode Parameters
  • Create a Custom Color Scheme for Shuffle Box
  • Hide the “not assigned” button in the Shuffle Box

Simple Tag Cloud (Pro)

  • Simple Tag Cloud – Overview
  • Simple Tag Cloud – Gutenberg Block
  • Simple Tag Cloud – Shortcode Parameters

Table Tag Cloud (Pro)

  • Table Tag Cloud – Overview
  • Table Tag Cloud – Gutenberg Block
  • Table Tag Cloud – Shortcode Parameters

Post List (Pro)

  • Post List – Overview
  • Post List – Gutenberg Block
  • Post List – Shortcode Parameters

Dynamic Post Filter (Pro)

  • Dynamic Post Filter – Overview
  • Dynamic Post Filter – Gutenberg Block
  • Dynamic Post Filter – Shortcode Parameters
  • I Don’t See Posts In the Dynamic Post Filter

Tag Cloud Search (Pro)

  • Tag Cloud Search – Overview
  • Tag Cloud Search – Gutenberg Block
  • Tag Cloud Search – Shortcode Parameters

Tag Groups Menu (Pro)

  • Tag Groups Menu – Overview
  • Tag Groups Menu – Shortcode Parameters

Toggle Post Filter (Pro)

  • Toggle Post Filter – Overview
  • Toggle Post Filter – Shortcodes Overview
  • Toggle Post Filter, Posts – Gutenberg Block
  • Toggle Post Filter, Posts – Shortcode Parameters
  • Toggle Post Filter, Menu – Gutenberg Blocks
  • Toggle Post Filter, Menu – Shortcode Parameters
  • Toggle Post Filter, Text Search – Gutenberg Block
  • Toggle Post Filter, Text Search – Shortcode Parameters
  • Toggle Post Filter, Slider Button – Gutenberg Block
  • Toggle Post Filter, Slider Button – Shortcode Parameters
  • Toggle Post Filter, Order Menu, Gutenberg Block
  • Toggle Post Filter, Order Menu – Shortcode Parameters
  • Toggle Post Filter, Reset Button – Shortcode Parameters

Tag Groups: Settings

  • The Home Screen in Tag Groups
  • Taxonomies and the Tag Groups Plugin
  • Front End Settings
  • Back End Settings in Tag Groups
  • Tools
  • Troubleshooting
  • Control Who Can Edit the Tag Groups

Tag Groups: Frequently Asked Questions

  • Glossary of Useful Words for Tag Groups
  • How to Display Tags in a Custom Sort Order?
  • Can I Use Tag Groups Multiple Times on The Same Page?
  • Which Tag Groups Feature Do I Need?
  • Can I Use the Tag Groups Plugin with Pages?
  • Can I Use the Tag Groups plugin with Categories?
  • How to Make the Alphabetical Tag Index or the Tag List Responsive?
  • Can I Use Tag Groups with Custom Taxonomies?
  • What are the Minimum System Requirements to Install Tag Groups?
  • “The free Tag Groups plugin cannot be active together with Tag Groups Pro.”

Tag Groups: Troubleshooting

  • Tags Not Visible in the WordPress Admin After Installing Tag Groups
  • Debugging a WordPress Ajax Error
  • Shortcodes Don’t Work Inside Widgets
  • I Cannot Use Multiple Tag Clouds on the Same Page
  • I Don’t See All Tags in the Tag Meta Box
  • How To Use The Debug Log in Tag Groups
  • Instead of the Tag Cloud There’s An Empty Space
  • Can Not Save HTML in the Tag Description
  • Tag Cloud: When I Click on a Tag, the Posts Don’t Differentiate by Groups
  • “Error loading block: The response is not a valid JSON response.”

Questions About Post Filters

  • Using the Post Filter on Frontend URLs
  • How to Choose a Custom Order in the Post Filter
  • How to Change the Length of the Post Excerpts
  • Change the Size of the First Posts in the Masonry Layout
  • Limit the Size of the Menu in the Dynamic Post Filter

Tag Groups: Maintenance and Optimization

  • How to Reduce the Number of Loaded Scripts for Better Speed and SEO
  • How to Improve the Performance of the Toggle Post Filter/Dynamic Post Filter
  • Running Maintenance
  • How to Improve the Speed of Tag Groups
  • Migrating your Tags and Posts to Tag Groups

Tag Groups: For Developers

  • Tag Groups and the REST API
  • Filters and Actions in Tag Groups
  • Modifying the Post Query
  • Modifying the Term Query
  • Using Tag Groups in Theme Files
  • Useful Constants for the Tag Groups Plugin

Tag Groups Integrations

  • Integration with WooCommerce Attributes
  • Does Tag Groups Work with the Polylang Plugin?
  • Translating Tag Group Names With WPML
  • Home
  • TaxoPress Documentation
  • The Tag Groups Plugin
  • Tag Groups: For Developers
  • Tag Groups and the REST API

Tag Groups and the REST API

Table of Contents
  • Enabling POST/PUT/DELETE
  • Groups
    • Retrieve one or more groups
      • Routes
      • Methods
      • Arguments
    • Create or update a group
      • Routes
      • Methods
      • Arguments
    • Delete a group
      • Routes
      • Methods
      • Arguments
  • Terms (Tags)
    • Retrieve one or more terms (tags)
      • Routes
      • Methods
      • Arguments
    • Update the groups of a term (tag)
      • Routes
      • Methods
      • Arguments
  • Taxonomies
    • Retrieve enabled taxonomies
      • Routes
      • Methods
      • Arguments
    • Update enabled taxonomies
      • Routes
      • Methods
      • Arguments
  • Post Tags
    • Retrieve post tags
      • Routes
      • Methods
      • Arguments
    • Update post tags
      • Routes
      • Methods
      • Arguments

The Tag Groups plugin does integrate with the WordPress REST API, however the features below are still considered experimental and not officially supported.

Please be careful with all operations that change data. There will be no confirmation dialog. To be on the safe side, make a backup of your database before you start and test first with non-critical sample data.

POST and PUT requests are handled by WordPress interchangeably.

If you use a client like Postman or RESTED, send the attributes as URLencoded form data (Header: Content-Type application/x-www-form-urlencoded) and use Basic Auth with your application password, available in WP 5.6+ or via 3rd-party plugins (untested and unsupported).

Permissions to create or edit groups can be changed in the Tag Groups Settings (Pro version only).

Add the routes after your site URL. In GET requests you can simply add the arguments as parameters. Any returned data will be JSON-encoded, if applicable.


Enabling POST/PUT/DELETE #

While all GET (retrieve) operations are available by default, all PUT/POST/DELETE (create, update, delete) operations are opt-in. You enable them by adding to your wp-config.php:

define( 'TAG_GROUPS_REST_API_EDITABLE', true );

Additionally you may have to authenticate, see below.


Groups #

Retrieve one or more groups #

Returns all groups or one group with its ID, label, position and terms.

Routes #

/wp-json/tag-groups/v1/groups/

/wp-json/tag-groups/v1/groups/{id}/

Methods #

GET

Arguments #

ArgumentValuesDefaultDescription
taxonomycomma-separated listall that are selected for tag groups
hide_emptybooleanfalse
fieldsids, …ids
orderbyname, …name
orderASC, DESCASC
typeall, metaboxallIf you choose ‘metabox’, you see all groups that appear in the Tag Meta Box. (Pro version only)

Create or update a group #

In order to use this endpoint you will need to authenticate as a user who has sufficient permissions.

For creating a new group you use 0 as ID.

Routes #

/wp-json/tag-groups/v1/groups/{id}/

Methods #

PUT, POST

Arguments #

ArgumentValuesDefaultDescription
labelstringcannot be empty if you create a new group
positioninteger > 0after last existingThe position among the groups. The new group will be added at the end if you omit this argument.

Delete a group #

In order to use this endpoint you will need to authenticate as a user who has sufficient permissions.

Routes #

/wp-json/tag-groups/v1/groups/{id}/

Methods #

DELETE

Arguments #

not available


Terms (Tags) #

Retrieve one or more terms (tags) #

Returns all terms or one term with its ID, label, position and terms.

Routes #

/wp-json/tag-groups/v1/terms/

/wp-json/tag-groups/v1/terms/{id}/

Methods #

GET

Arguments #

ArgumentValuesDefaultDescription
taxonomycomma-separated list, or keyword “public”all enabledThis endpoint returns only taxonomies that are enabled in the Tag Groups (Pro) settings. The keyword “public”, however, makes it return all public taxonomies, including those that are not-enabled.
hide_emptybooleanfalse
fieldsids
groupIDrestrict terms to those belonging to a certain group
orderbyname
orderASC

Update the groups of a term (tag) #

In order to use this endpoint you will need to authenticate as a user who has sufficient permissions.

Routes #

/wp-json/tag-groups/v1/terms/{id}/

Methods #

PUT, POST

Arguments #

ArgumentValuesDescription
groupscomma-separated list of group IDsPlease note that groups will not be added but overwrite previous data.

Taxonomies #

Retrieve enabled taxonomies #

Returns all taxonomies (slug and name) that are enabled for tag groups or for the Tag Meta Box (Pro only).

Routes #

/wp-json/tag-groups/v1/taxonomies/

Methods #

GET

Arguments #

ArgumentValuesDefaultDescription
typemetabox, enabledenabled

Update enabled taxonomies #

Updates all taxonomies that are enabled for tag groups or for the Tag Meta Box (Pro only).

In order to use this endpoint you will need to authenticate as a user who has sufficient permissions.

Routes #

/wp-json/tag-groups/v1/taxonomies/

Methods #

PUT, POST

Arguments #

ArgumentValuesDescription
enabledcomma-separated list of taxonomy slugstaxonomies that are enabled for tag groups
metaboxcomma-separated list of taxonomy slugstaxonomies that are enabled for the Tag Meta Box (Pro only)

Post Tags #

Only available in the Pro version.

These endpoints retrieve and update only tags in groups as used by this plugin. If you need to handle other post data you should use the built-in endpoints of WP.

Retrieve post tags #

Only posts will appear that you are allowed to view.

The ID is a post ID. For each post the authenticated user’s (if applicable) permissions will be checked.

Routes #

/wp-json/tag-groups/v1/post-tags/

/wp-json/tag-groups/v1/post-tags/{id}/

Methods #

GET

Arguments #

ArgumentValuesDescription
post_typestring (slug)usually “post_tag”

Update post tags #

In order to use this endpoint you will need to authenticate as a user who has sufficient permissions.

The ID is a post ID. For each post the authenticated user’s permissions will be checked.

If you add a tag to a post and this tag is not yet assigned to the submitted group, then this group will be assigned.

Routes #

/wp-json/tag-groups/v1/post-tags/{id}/

Methods #

PUT, POST

Arguments #

ArgumentValuesDescription
termsJSON-encoded arrayJSON-encoded array of group IDs as keys and an array of term IDs as each value. Use group ID 0 for unassigned tags. example: {“0″:[1235],”9”:[147]}
taxonomytaxonomy slug
Filters and Actions in Tag Groups
Table of Contents
  • Enabling POST/PUT/DELETE
  • Groups
    • Retrieve one or more groups
      • Routes
      • Methods
      • Arguments
    • Create or update a group
      • Routes
      • Methods
      • Arguments
    • Delete a group
      • Routes
      • Methods
      • Arguments
  • Terms (Tags)
    • Retrieve one or more terms (tags)
      • Routes
      • Methods
      • Arguments
    • Update the groups of a term (tag)
      • Routes
      • Methods
      • Arguments
  • Taxonomies
    • Retrieve enabled taxonomies
      • Routes
      • Methods
      • Arguments
    • Update enabled taxonomies
      • Routes
      • Methods
      • Arguments
  • Post Tags
    • Retrieve post tags
      • Routes
      • Methods
      • Arguments
    • Update post tags
      • Routes
      • Methods
      • Arguments

Recent Posts

  • How to Find the IDs of WordPress Tags, Posts or Categories May 24, 2023
  • How to Change the Design of Accordions and Tabbed Tag Clouds May 16, 2023
  • How to Add Custom Designs to Terms in Tag Groups May 15, 2023
  • Find The Most Used Tags On Your WordPress Site May 14, 2023
  • What is a Tag Slug in WordPress? May 11, 2023

Testimonials

This plugin is the best available for suggesting tags, is also easy to install and use. Highly recommended.

supertrooper2

The plugin has great features even in the free version. I had a minor issue and the plugin author replied within hours even on Sunday! Highly recommended.

Sanchit Goyal

Important Links

  • TaxoPress Demos
  • Frequently Asked Questions
  • About the TaxoPress Team
  • Terms of Service
  • TaxoPress Affiliates
  • Logo and Brand Materials

Our Projects

  • PublishPress
  • MetaSlider
  • KinshiPress
  • Ramble Ventures
  • Logtivity

© 2023 TaxoPress

Facebook Twitter
Scroll to top
  • TaxoPress
  • Tag Groups
  • Docs
  • Blog
  • Support
Search