Skip to main content

Feature flags for Wagtail sites

Project description


Build Status Coverage Status

Feature flags allow you to toggle functionality in the Wagtail based on configurable conditions.

Wagtail-Flags adds a Wagtail admin UI and Wagtail Site-based condition on top of Django-Flags. For a more complete overview of feature flags and how to use them, please see the Django-Flags documentation.

Feature flags in the Wagtail admin


  • Python 2.7+, 3.6+
  • Django 1.11+, 2.0+
  • Wagtail 1.13+, 2.0+
  • Django-Flags 4.0+


  1. Install wagtail-flags:
pip install wagtail-flags
  1. Add flags and wagtailflags as installed apps in your Django


Please see the Django-Flags documentation for the most current information about defining and checking feature flags.

First, define the flag in Django

    'MY_FLAG': {}

Then use the flag in a Django template (mytemplate.html):

{% load feature_flags %}
{% flag_enabled 'MY_FLAG' as my_flag %}

{% if my_flag %}
  <div class="flagged-banner">
    I’m the result of a feature flag.   
{% endif %}

Next, configure a URL for that template (

from django.urls import path
from django.views.generic import TemplateView

urlpatterns = [
    path(r'mypage/', TemplateView.as_view(template_name='mytemplate.html')),

Finally, add conditions for the flag in the Wagtail admin under "Settings", "Flags":

Creating conditions in the Wagtail admin

Extended conditions

Wagtail-Flags adds the following conditions to Django-Flags:


Allows a flag to be enabled for a Wagtail site that matches the hostname and port in the condition value.

FLAGS = {'MY_FLAG': {'site': ''}}

Getting help

Please add issues to the issue tracker.

Getting involved

General instructions on how to contribute can be found in CONTRIBUTING.


  1. TERMS
  3. CFPB Source Code Policy

Credits and references

  1. Forked from cfgov-refresh

Download files

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

Files for wagtail-flags, version 4.0.3
Filename, size File type Python version Upload date Hashes
Filename, size wagtail_flags-4.0.3-py2.py3-none-any.whl (13.4 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size wagtail-flags-4.0.3.tar.gz (10.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page