Skip to main content

Simple tagging for the Wagtail CMS.

Project description

Wagtail Taggable

Simple tag functionality for Wagtail sites wanting curated tags without the complexity.

Change Log

  • v0.0.10:
    • Updated InlinePanel invocation to match requirements for Wagtail 4.2 and therefore pin Wagtail 4.2 as the minimum supported version.

Installation & Setup

Install with pip

pip install wagtail-taggable


poetry add wagtail-taggable

Add to Django installed apps


Setup your tag models

Using the register_tag decorator automatically sets up any ForeignKey references to the decorated model to render using a chooser widget specifically for your tag model. It takes care of registering all the form widgets and urls needed to get this interface working.

class ExampleTag(BaseTag):

    class Meta:
        verbose_name = _('Example')

Optionally expose Tag models using Model Admin

from django.apps import apps
from wagtail.contrib.modeladmin.options import ModelAdmin, ModelAdminGroup

class ExampleTagModelAdmin(ModelAdmin):

    def model(self):
        return apps.get_model('app.ExampleTag')

    menu_label = 'Example'
    menu_icon = 'tasks'
    menu_order = 100
    list_display = ('name',)

class TagsModelAdminGroup(ModelAdminGroup):

    menu_label = 'Tags'
    menu_icon = 'tag'
    menu_order = 502
    items = [

from app.admin.tags import TagsModelAdminGroup


Use tags on page models (or any other model)

  1. Define through relationship:

     class ExamplePageExampleTagRelationship(models.Model):
         page = ParentalKey(
         example_tag = models.ForeignKey(
  2. Use TagsPanel to render the tags interface in the CMS for the taggable model (in this case a wagtail.Page)

     class ExamplePage(Page):
         content_panels = [
             TagsPanel('example_tag_relationships', heading='Example Tags'),


Query items based on tags

Perform queries based on tags like you would with any other related table

tagged_items = (
    .filter(example_tag_relationship__example_tag__name='My Cool Tag')

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wagtail_taggable-0.0.10.tar.gz (8.0 kB view hashes)

Uploaded Source

Built Distribution

wagtail_taggable-0.0.10-py2.py3-none-any.whl (8.6 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page