NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
PyPI, #4986 most downloaded on PyPI
A Django content management system.
Latest stable
8.1
Last release 20 days ago
02 Nov 2026
Release timing varies
gaps range from 9 days to 2 months
Nearly every release is documented
notes for 60 of the last 60 stable releases
1 version withdrawn
withdrawn after publishing
13 years old
305 releases · first in 2014
Drag across the ruler to compare, or tap a release to open it.
Fix usage URL on the document edit page (Jérôme Lebleu)
Changes since 2.1rc1:
form_fields_exclude on models with explicit panel definitionsAdd HelpPanel to add HTML within an edit form (Kevin Chung)
HelpPanel to add HTML within an edit form (Kevin Chung)assert statements from Wagtail API (Kim Chee Leong)jquery-datetimepicker dependency to make Wagtail more CSP-friendly (unsafe-eval) (Mike Kamermans)wagtail command on Python <3.4 (Matt Westcott)update_index management command now accepts a --chunk_size option to determine the number of items to load at once (Dave Bell)register_account_menu_item to add new account preference items (Michael van Tellingen)wagtail_icon template tag to facilitate making admin icons accessible (Sander Tuit)ALLOWED_HOSTS in the project template to allow any host in development (Tom Dyson)WAGTAILFRONTENDCACHE_LANGUAGES setting to specify the languages whose URLs are to be purged when using i18n_patterns (PyMan Claudio Marinozzi)extra_footer_actions template blocks for customising the add/edit page views (Arthur Holzner)WAGTAILADMIN_RICH_TEXT_EDITORS setting (Todd Dembrey)UserAttributeSimilarityValidator is now correctly enforced on user creation / editing forms (Tim Heap)get_admin_display_title methods (Kim Chee Leong)get_admin_display_title methods (Arthur Holzner, Wietze Helmantel, Matt Westcott)update_index for ParentalManyToManyField to fix crash (Tim Kamanin)get_admin_display_title methods when sorting <100 pages (Matt Westcott)Your coding agent can read these notes before it upgrades. Set up the MCP server →
Fix: Restored ability to use non-model fields with FieldPanel (Matt Westcott, LB (Ben Johnston))
August 13, 2018
Restored ability to use non-model fields with FieldPanel (Matt Westcott, LB (Ben Johnston))
Fix usage URL on the document edit page (Jérôme Lebleu)
Pin Beautiful Soup to 4.6.0 due to further regressions in formatting empty elements (Matt Westcott)
Added error notification when running the wagtail command on Python <3.4 (Matt Westcott)
wagtail command on Python <3.4 (Matt Westcott)WAGTAILADMIN_RICH_TEXT_EDITORS setting (Todd Dembrey)UserAttributeSimilarityValidator is now correctly enforced on user creation / editing forms (Tim Heap)April 4, 2018
Added error notification when running the wagtail command on Python <3.4 (Matt Westcott)
Added error handling to the Draftail editor (Thibaud Colas)
Draftail now supports features specified via the WAGTAILADMIN_RICH_TEXT_EDITORS setting (Todd Dembrey)
Password reset form no longer indicates whether the email is recognized, as per standard Django behavior (Bertrand Bordage)
UserAttributeSimilarityValidator is now correctly enforced on user creation / editing forms (Tim Heap)
Editing setting object with no site configured no longer crashes (Harm Zeinstra)
Creating a new object with inlines while mandatory fields are empty no longer crashes (Bertrand Bordage)
Added support for Django 2.0 (Matt Westcott, Karl Hobley, LB (Ben Johnston), Mads Jensen)
wagtail.contrib.api) to an external app (https://github.com/wagtail/wagtailapi_legacy) (Karl Hobley)construct_explorer_page_queryset hook and ModelAdmin.exclude_from_explorer property (Tim Heap)before_create_user, after_create_user, before_delete_user, after_delete_user, before_edit_user, after_edit_user (Jon Carmack)exclude_fields_in_copy property to Page to define fields that should not be included on page copy (LB (Ben Johnston)){% image %} tag syntax (LB (Ben Johnston))render_landing_page method to AbstractForm to be easily overridden and pass form_submission to landing page context (Stein Strindhaug)heading kwarg to InlinePanel to allow heading to be set independently of button label (Adrian Turjak)StructBlock can now be customised (LB (Ben Johnston))bgcolor image operation (Karl Hobley)WAGTAILADMIN_USER_LOGIN_FORM setting for overriding the admin login form (Mike Dingjan)WAGTAILADMIN_NOTIFICATION_INCLUDE_SUPERUSERS setting to determine whether superusers are included in moderation email notifications (Bruno Alla)get_template methods for overriding templates in instances (Christopher Bledsoe).richtext CSS class in favour of more explicit extension points (Thibaud Colas)assertCanCreate (Tim Heap, Matt Westcott)QuerySet when searching with order_by_relevance=False (Bertrand Bordage)modeladmin_register as a decorator no longer replaces the decorated class with None (Tim Heap){% routablepageurl %} template tag no longer generates invalid URLs when the WAGTAIL_APPEND_SLASH setting was set to False (Venelin Stoykov)FormSubmissionsPanel now recognises custom form submission classes (LB (Ben Johnston))TableBlock context menu (LB (Ben Johnston))ATOMIC_REBUILD for projects with Elasticsearch client >=1.7.0 (Mikalai Radchuk)__in filter (Karl Hobley, Matt Westcott)__isnull filters no longer fail on Elasticsearch 5 (Karl Hobley)SearchField and a FilterField (Matt Westcott)h2 elements (Thibaud Colas)1.11, 2.0
3.4, 3.5, 3.6
1.13 LTS
1.8, 1.10, 1.11
2.7, 3.4, 3.5, 3.6
1.12 LTS
1.8, 1.10, 1.11
2.7, 3.4, 3.5, 3.6
February 28, 2018
Wagtail is now compatible with Django 2.0. Compatibility fixes were contributed by Matt Westcott, Karl Hobley, LB (Ben Johnston) and Mads Jensen.
Wagtail's rich text editor has now been replaced with Draftail, a new editor based on Draft.js, fixing numerous bugs and providing an improved editing experience, better support for current browsers, and more consistent HTML output. This feature was developed by Thibaud Colas, Loïc Teixeira and Matt Westcott.
The modules that make up Wagtail have been renamed and reorganized, to avoid the repetition in names like wagtail.wagtailcore.models (originally an artifact of app naming limitations in Django 1.6) and to improve consistency. While this will require some up-front work to upgrade existing Wagtail sites, we believe that this will be a long-term improvement to the developer experience, improving readability of code and reducing errors. This change was implemented by Karl Hobley and Matt Westcott.
The behavior of scheduled publishing has been revised so that pages are no longer unpublished at the point of setting a future go-live date, making it possible to schedule updates to an existing published page. This feature was developed by Patrick Woods.
Moved Wagtail API v1 implementation (wagtail.contrib.api) to an external app (Karl Hobley)
The page chooser now searches all fields of a page, instead of just the title (Bertrand Bordage)
Implement ordering by date in form submission view (LB (Ben Johnston))
Elasticsearch scroll API is now used when fetching more than 100 search results (Karl Hobley)
Added hidden field to the form builder (Ross Crawford-d'Heureuse)
Usage count now shows on delete confirmation page when WAGTAIL_USAGE_COUNT_ENABLED is active (Kees Hink)
Added usage count to snippets (Kees Hink)
Moved usage count to the sidebar on the edit page (Kees Hink)
Explorer menu now reflects customizations to the page listing made via the construct_explorer_page_queryset hook and ModelAdmin.exclude_from_explorer property (Tim Heap)
"Choose another image" button changed to "Change image" to avoid ambiguity (Edd Baldry)
Added hooks before_create_user, after_create_user, before_delete_user, after_delete_user, before_edit_user, after_edit_user (Jon Carmack)
Added exclude_fields_in_copy property to Page to define fields that should not be included on page copy (LB (Ben Johnston))
Improved error message on incorrect {% image %} tag syntax (LB (Ben Johnston))
Optimised preview data storage (Bertrand Bordage)
Added render_landing_page method to AbstractForm to be easily overridden and pass form_submission to landing page context (Stein Strindhaug)
Added heading kwarg to InlinePanel to allow heading to be set independently of button label (Adrian Turjak)
The value type returned from a StructBlock can now be customized. See custom_value_class_for_structblock (LB (Ben Johnston))
Added bgcolor image operation (Karl Hobley)
Added WAGTAILADMIN_USER_LOGIN_FORM setting for overriding the admin login form (Mike Dingjan)
Snippets now support custom primary keys (Sævar Öfjörð Magnússon)
Upgraded jQuery to version 3.2.1 (Janneke Janssen)
Update autoprefixer configuration to better match browser support targets (Janneke Janssen)
Update React and related dependencies to latest versions (Janneke Janssen, Hugo van den Berg)
Remove Hallo editor .richtext CSS class in favor of more explicit extension points (Thibaud Colas)
Updated documentation styling (LB (Ben Johnston))
Rich text fields now take feature lists into account when whitelisting HTML elements (Matt Westcott)
FormPage lists and Form submission lists in admin now use class based views for easy overriding (Johan Arensman)
Form submission csv exports now have the export date in the filename and can be customized (Johan Arensman)
FormBuilder class now uses bound methods for field generation, adding custom fields is now easier and documented (LB (Ben Johnston))
Added WAGTAILADMIN_NOTIFICATION_INCLUDE_SUPERUSERS setting to determine whether superusers are included in moderation email notifications (Bruno Alla)
Added a basic Dockerfile to the project template (Tom Dyson)
StreamField blocks now allow custom get_template methods for overriding templates in instances (Christopher Bledsoe)
Simplified edit handler API (Florent Osmont, Bertrand Bordage)
Made 'add/change/delete collection' permissions configurable from the group edit page (Matt Westcott)
Expose React-related dependencies as global variables for extension in the admin interface (Thibaud Colas)
Added helper functions for constructing form data for use with assertCanCreate. See form_data_test_helpers (Tim Heap, Matt Westcott)
Do not remove stopwords when generating slugs from non-ASCII titles, to avoid issues with incorrect word boundaries (Sævar Öfjörð Magnússon)
The PostgreSQL search backend now preserves ordering of the QuerySet when searching with order_by_relevance=False (Bertrand Bordage)
Using modeladmin_register as a decorator no longer replaces the decorated class with None (Tim Heap)
Fixed crash in XML sitemap generator when all pages on the site are private (Stein Strindhaug)
The {% routablepageurl %} template tag no longer generates invalid URLs when the WAGTAIL_APPEND_SLASH setting was set to False (Venelin Stoykov)
The "View live" button is no longer shown if the page doesn't have a routable URL (Tim Heap)
API listing views no longer fail when no site records are defined (Karl Hobley)
Fixed rendering of border on dropdown arrow buttons on Chrome (Bertrand Bordage)
Fixed incorrect z-index on userbar causing it to appear behind page content (Stein Strindhaug)
Form submissions pagination no longer looses date filter when changing page (Bertrand Bordage)
PostgreSQL search backend now removes duplicate page instances from the database (Bertrand Bordage)
FormSubmissionsPanel now recognizes custom form submission classes (LB (Ben Johnston))
Prevent the footer and revisions link from unnecessarily collapsing on mobile (Jack Paine)
Empty searches were activated when paginating through images and documents (LB (Ben Johnston))
Summary numbers of pages, images and documents were not responsive when greater than 4 digits (Michael Palmer)
Project template now has password validators enabled by default (Matt Westcott)
Alignment options correctly removed from TableBlock context menu (LB (Ben Johnston))
Fix support of ATOMIC_REBUILD for projects with Elasticsearch client >=1.7.0 (Mikalai Radchuk)
Fixed error on Elasticsearch backend when passing a QuerySet as an __in filter (Karl Hobley, Matt Westcott)
__isnull filters no longer fail on Elasticsearch 5 (Karl Hobley)
Prevented intermittent failures on Postgres search backend when a field is defined as both a SearchField and a FilterField (Matt Westcott)
Alt text of images in rich text is no longer truncated on double-quote characters (Matt Westcott)
Ampersands in embed URLs within rich text are no longer double-escaped (Matt Westcott)
Using RGBA images no longer crashes with Pillow >= 4.2.0 (Karl Hobley)
Copying a page with PostgreSQL search enabled no longer crashes (Bertrand Bordage)
Style of the page unlock button was broken (Bertrand Bordage)
Admin search no longer floods browser history (Bertrand Bordage)
Version comparison now handles custom primary keys on inline models correctly (LB (Ben Johnston))
Fixed error when inserting chooser panels into FieldRowPanel (Florent Osmont, Bertrand Bordage)
Reinstated missing error reporting on image upload (Matt Westcott)
Only load Hallo CSS if Hallo is in use (Thibaud Colas)
Prevent style leak of Wagtail panel icons in widgets using h2 elements (Thibaud Colas)
Python 2.7, Django 1.8 and Django 1.10 are no longer supported in this release. You are advised to upgrade your project to Python 3 and Django 1.11 before upgrading to Wagtail 2.0.
Before upgrading to Django 2.0, you are advised to review the release notes, especially the backwards incompatible changes and removed features.
Many of the module paths within Wagtail have been reorganized to reduce duplication - for example, wagtail.wagtailcore.models is now wagtail.core.models. As a result, import lines and other references to Wagtail modules will need to be updated when you upgrade to Wagtail 2.0. A new command has been added to assist with this - from the root of your project's code base:
$ wagtail updatemodulepaths --list # list the files to be changed without updating them
$ wagtail updatemodulepaths --diff # show the changes to be made, without updating files
$ wagtail updatemodulepaths # actually update the files
Or, to run from a different location:
$ wagtail updatemodulepaths /path/to/project --list
$ wagtail updatemodulepaths /path/to/project --diff
$ wagtail updatemodulepaths /path/to/project
For the full list of command line options, enter wagtail help updatemodulepaths.
You are advised to take a backup of your project codebase before running this command. The command will perform a search-and-replace over all *.py files for the affected module paths; while this should catch the vast majority of module references, it will not be able to fix instances that do not use the dotted path directly, such as from wagtail import wagtailcore.
The full list of modules to be renamed is as follows:
Old name |
New name |
Notes |
|---|---|---|
wagtail.wagtailcore |
wagtail.core |
|
wagtail.wagtailadmin |
wagtail.admin |
|
wagtail.wagtaildocs |
wagtail.documents |
'documents' no longer abbreviated |
wagtail.wagtailembeds |
wagtail.embeds |
|
wagtail.wagtailimages |
wagtail.images |
|
wagtail.wagtailsearch |
wagtail.search |
|
wagtail.wagtailsites |
wagtail.sites |
|
wagtail.wagtailsnippets |
wagtail.snippets |
|
wagtail.wagtailusers |
wagtail.users |
|
wagtail.wagtailforms |
wagtail.contrib.forms |
Moved into 'contrib' |
wagtail.wagtailredirects |
wagtail.contrib.redirects |
Moved into 'contrib' |
wagtail.contrib.wagtailapi |
removed |
API v1, removed in this release |
wagtail.contrib.wagtailfrontendcache |
wagtail.contrib.frontend_cache |
Underscore added |
wagtail.contrib.wagtailroutablepage |
wagtail.contrib.routable_page |
Underscore added |
wagtail.contrib.wagtailsearchpromotions |
wagtail.contrib.search_promotions |
Underscore added |
wagtail.contrib.wagtailsitemaps |
wagtail.contrib.sitemaps |
|
wagtail.contrib.wagtailstyleguide |
wagtail.contrib.styleguide |
Places these should be updated include:
import lines
Paths specified in settings, such as INSTALLED_APPS, MIDDLEWARE and WAGTAILSEARCH_BACKENDS
Fields and blocks referenced within migrations, such as wagtail.wagtailcore.fields.StreamField and wagtail.wagtailcore.blocks.RichTextBlock
However, note that this only applies to dotted module paths beginning with wagtail.. App names that are not part of a dotted module path should be left unchanged - in this case, the wagtail prefix is still required to avoid clashing with other apps that might exist in the project with names such as admin or images. The following should be left unchanged:
Foreign keys specifying a model as 'app_name.ModelName', e.g. models.ForeignKey('wagtailimages.Image',...)
App labels used in database table names, content types or permissions
Paths to templates and static files, e.g. when overriding admin templates with custom branding
Template tag library names, e.g. {% load wagtailcore_tags %}
The Draftail rich text editor has a substantially different API from Hallo.js, including the use of a non-HTML format for its internal data representation; as a result, functionality added through Hallo.js plugins will be unavailable. If your project is dependent on Hallo.js-specific behavior, you can revert to the original Hallo-based editor by adding the following to your settings:
WAGTAILADMIN_RICH_TEXT_EDITORS = {
'default': {
'WIDGET': 'wagtail.admin.rich_text.HalloRichTextArea'
}
}
The assertCanCreate test method (see /advanced_topics/testing) requires data to be passed in the same format that the page edit form would submit. The Draftail rich text editor posts this data in a non-HTML format, and so any existing assertCanCreate tests involving rich text fields will fail when Draftail is in use:
self.assertCanCreate(root_page, ContentPage, {
'title': 'About us',
'body': '<p>Lorem ipsum dolor sit amet</p>', # will not work
})
Wagtail now provides a set of helper functions for constructing form data: see form_data_test_helpers. The above assertion can now be rewritten as:
from wagtail.tests.utils.form_data import rich_text
self.assertCanCreate(root_page, ContentPage, {
'title': 'About us',
'body': rich_text('<p>Lorem ipsum dolor sit amet</p>'),
})
Elasticsearch 1.x is no longer supported in this release. Please upgrade to a 2.x or 5.x release of Elasticsearch before upgrading to Wagtail 2.0.
Version 1 of the Wagtail API (wagtail.contrib.wagtailapi) has been removed from Wagtail.
If you're using version 1, you will need to migrate to version 2. Please see /advanced_topics/api/v2/configuration and /advanced_topics/api/v2/usage.
If migrating to version 2 is not an option right now (if you have API clients that you don't have direct control over, such as a mobile app), you can find the implementation of the version 1 API in the new wagtailapi_legacy repository.
This repository has been created to provide a place for the community to collaborate on supporting legacy versions of the API until everyone has migrated to an officially supported version.
The construct_whitelister_element_rules hook, used to specify additional HTML elements to be permitted in rich text, is deprecated. The recommended way of whitelisting elements is now to use rich text features. For example, a whitelist rule that was previously defined as:
from wagtail.core import hooks
from wagtail.core.whitelist import allow_without_attributes
@hooks.register('construct_whitelister_element_rules')
def whitelist_blockquote():
return {
'blockquote': allow_without_attributes,
}
can be rewritten as:
from wagtail.admin.rich_text.converters.editor_html import WhitelistRule
from wagtail.core import hooks
from wagtail.core.whitelist import allow_without_attributes
@hooks.register('register_rich_text_features')
def blockquote_feature(features):
# register a feature 'blockquote' which whitelists the <blockquote> element
features.register_converter_rule('editorhtml', 'blockquote', [
WhitelistRule('blockquote', allow_without_attributes),
])
# add 'blockquote' to the default feature set
features.default_features.append('blockquote')
Please note that the new Draftail rich text editor uses a different mechanism to process rich text content, and does not apply whitelist rules; they only take effect when the Hallo.js editor is in use.
The generate_signature function in wagtail.images.views.serve, used to build URLs for the dynamic image serve view, now returns a string rather than a byte string. This ensures that any existing user code that builds up the final image URL with reverse will continue to work on Django 2.0 (which no longer allows byte strings to be passed to reverse). Any code that expects a byte string as the return value of generate_string - for example, calling decode() on the result - will need to be updated. (Apps that need to preserve compatibility with earlier versions of Wagtail can call django.utils.encoding.force_text instead of decode.)
Wagtail has always included a bundled view for frontend search. However, this view isn't easy to customize so defining this view per project is usually preferred. If you have used this bundled view (check for an import from wagtail.wagtailsearch.urls in your project's urls.py), you will need to replace this with your own implementation.
See the search view in Wagtail demo for a guide: https://github.com/wagtail/wagtaildemo/blob/master/demo/views.py
With the introduction of a new editor, we want to make sure existing editor plugins meant for Hallo only target Hallo editors for extension.
The existing .richtext CSS class is no longer applied to the Hallo editor’s DOM element.
In JavaScript, use the [data-hallo-editor] attribute selector to target the editor, eg. var $editor = $('[data-hallo-editor]');.
In CSS, use the .halloeditor class selector.
For example,
/* JS */
- var widget = $(elem).parent('.richtext').data('IKS-hallo');
+ var widget = $(elem).parent('[data-hallo-editor]').data('IKS-hallo');
[...]
/* Styles */
- .richtext {
+ .halloeditor {
font-family: monospace;
}
Added support for Django 2.0 (Matt Westcott, Karl Hobley, LB (Ben Johnston), Mads Jensen)
wagtail.contrib.api) to an external app (https://github.com/wagtail/wagtailapi_legacy) (Karl Hobley)construct_explorer_page_queryset hook and ModelAdmin.exclude_from_explorer property (Tim Heap)before_create_user, after_create_user, before_delete_user, after_delete_user, before_edit_user, after_edit_user (Jon Carmack)exclude_fields_in_copy property to Page to define fields that should not be included on page copy (LB (Ben Johnston)){% image %} tag syntax (LB (Ben Johnston))render_landing_page method to AbstractForm to be easily overridden and pass form_submission to landing page context (Stein Strindhaug)heading kwarg to InlinePanel to allow heading to be set independently of button label (Adrian Turjak)StructBlock can now be customised (LB (Ben Johnston))bgcolor image operation (Karl Hobley)WAGTAILADMIN_USER_LOGIN_FORM setting for overriding the admin login form (Mike Dingjan)WAGTAILADMIN_NOTIFICATION_INCLUDE_SUPERUSERS setting to determine whether superusers are included in moderation email notifications (Bruno Alla)get_template methods for overriding templates in instances (Christopher Bledsoe).richtext CSS class in favour of more explicit extension points (Thibaud Colas)assertCanCreate (Tim Heap, Matt Westcott)QuerySet when searching with order_by_relevance=False (Bertrand Bordage)modeladmin_register as a decorator no longer replaces the decorated class with None (Tim Heap){% routablepageurl %} template tag no longer generates invalid URLs when the WAGTAIL_APPEND_SLASH setting was set to False (Venelin Stoykov)FormSubmissionsPanel now recognises custom form submission classes (LB (Ben Johnston))TableBlock context menu (LB (Ben Johnston))ATOMIC_REBUILD for projects with Elasticsearch client >=1.7.0 (Mikalai Radchuk)__in filter (Karl Hobley, Matt Westcott)__isnull filters no longer fail on Elasticsearch 5 (Karl Hobley)SearchField and a FilterField (Matt Westcott)h2 elements (Thibaud Colas)Added support for Django 2.0 (Matt Westcott, Karl Hobley, LB (Ben Johnston), Mads Jensen)
wagtail.contrib.api) to an external app (https://github.com/wagtail/wagtailapi_legacy) (Karl Hobley)construct_explorer_page_queryset hook and ModelAdmin.exclude_from_explorer property (Tim Heap)before_create_user, after_create_user, before_delete_user, after_delete_user, before_edit_user, after_edit_user (Jon Carmack)exclude_fields_in_copy property to Page to define fields that should not be included on page copy (LB (Ben Johnston)){% image %} tag syntax (LB (Ben Johnston))render_landing_page method to AbstractForm to be easily overridden and pass form_submission to landing page context (Stein Strindhaug)heading kwarg to InlinePanel to allow heading to be set independently of button label (Adrian Turjak)StructBlock can now be customised (LB (Ben Johnston))bgcolor image operation (Karl Hobley)WAGTAILADMIN_USER_LOGIN_FORM setting for overriding the admin login form (Mike Dingjan)WAGTAILADMIN_NOTIFICATION_INCLUDE_SUPERUSERS setting to determine whether superusers are included in moderation email notifications (Bruno Alla)get_template methods for overriding templates in instances (Christopher Bledsoe)QuerySet when searching with order_by_relevance=False (Bertrand Bordage)modeladmin_register as a decorator no longer replaces the decorated class with None (Tim Heap){% routablepageurl %} template tag no longer generates invalid URLs when the WAGTAIL_APPEND_SLASH setting was set to False (Venelin Stoykov)FormSubmissionsPanel now recognises custom form submission classes (LB (Ben Johnston))TableBlock context menu (LB (Ben Johnston))ATOMIC_REBUILD for projects with Elasticsearch client >=1.7.0 (Mikalai Radchuk)__in filter (Karl Hobley, Matt Westcott)__isnull filters no longer fail on Elasticsearch 5 (Karl Hobley)SearchField and a FilterField (Matt Westcott)Fix: Pin Beautiful Soup to 4.6.0 due to further regressions in formatting empty elements (Matt Westcott)
August 13, 2018
Pin Beautiful Soup to 4.6.0 due to further regressions in formatting empty elements (Matt Westcott)
Fix: Pin django-taggit to <0.23 to restore Django 1.8 compatibility (Matt Westcott)
August 13, 2018
Pin django-taggit to <0.23 to restore Django 1.8 compatibility (Matt Westcott)
Mark Beautiful Soup 4.6.1 as incompatible due to bug in formatting empty elements (Matt Westcott)
Fix: Fix support of ATOMIC_REBUILD for projects with Elasticsearch client >=1.7.0 (Mikalai Radchuk)
ATOMIC_REBUILD for projects with Elasticsearch client >=1.7.0 (Mikalai Radchuk)July 4, 2018
Fix support of ATOMIC_REBUILD for projects with Elasticsearch client >=1.7.0 (Mikalai Radchuk)
Logging an indexing failure on an object with a non-ASCII representation no longer crashes on Python 2 (Aram Dulyan)
Rich text image chooser no longer skips format selection after a validation error (Matt Westcott)
Null characters in URLs no longer crash the redirect middleware on PostgreSQL (Matt Westcott)
Fix: API listing views no longer fail when no site records are defined (Karl Hobley)
__in filter (Karl Hobley, Matt Westcott)__isnull filters no longer fail on Elasticsearch 5 (Karl Hobley)SearchField and a FilterField (Matt Westcott)November 17, 2017
API listing views no longer fail when no site records are defined (Karl Hobley)
Fixed crash in XML sitemap generator when all pages on the site are private (Stein Strindhaug)
Fixed incorrect z-index on userbar causing it to appear behind page content (Stein Strindhaug)
Fixed error in Postgres search backend when searching specific fields of a specific() Page QuerySet (Bertrand Bordage, Matt Westcott)
Fixed error on Elasticsearch backend when passing a QuerySet as an __in filter (Karl Hobley, Matt Westcott)
__isnull filters no longer fail on Elasticsearch 5 (Karl Hobley)
Prevented intermittent failures on Postgres search backend when a field is defined as both a SearchField and a FilterField (Matt Westcott)
Fix: Removed deprecated SessionAuthenticationMiddleware from project template (Samir Shah)
request.FILES, for use in custom form handlers (LB (Ben Johnston))Page.last_published_at is now a filterable field for search (Mikalai Radchuk)order_by_relevance=False when searching with PostgreSQL now works (Mitchel Cabuloy)WAGTAILAPI_LIMIT_MAX now accepts None to disable limiting (jcronyn)USE_THOUSAND_SEPARATOR = True from breaking the image focal point chooser (Sævar Öfjörð Magnússon)SessionAuthenticationMiddleware from project template (Samir Shah)get_admin_display_title are now shown in search results (Ben Sturmfels, Matt Westcott)October 16, 2017
Wagtail 1.13 is designated a Long Term Support (LTS) release. Long Term Support releases will continue to receive maintenance updates as necessary to address security and data-loss related issues, up until the next LTS release (typically a period of 8 months). Please note that Wagtail 1.13 will be the last LTS release to support Python 2.
Front-end cache invalidator now supports purging URLs as a batch - see frontend_cache_invalidating_urls (Karl Hobley)
Custom document model is now documented (Emily Horsman)
Use minified versions of CSS in the admin by adding minification to the front-end tooling (Vincent Audebert, Thibaud Colas)
Wagtailforms serve view now passes request.FILES, for use in custom form handlers (LB (Ben Johnston))
Documents and images are now given new filenames on re-uploading, to avoid old versions being kept in cache (Bertrand Bordage)
Added custom 404 page for admin interface (Jack Paine)
Breadcrumb navigation now uses globe icon to indicate tree root, rather than home icon (Matt Westcott)
Wagtail now uses React 15.6.2 and above, released under the MIT license (Janneke Janssen)
User search in the Wagtail admin UI now works across multiple fields (Will Giddens)
Page.last_published_at is now a filterable field for search (Mikalai Radchuk)
Page search results and usage listings now include navigation links (Matt Westcott)
"Open Link in New Tab" on a right arrow in page explorer should open page list (Emily Horsman)
Using order_by_relevance=False when searching with PostgreSQL now works (Mitchel Cabuloy)
Inline panel first and last sorting arrows correctly hidden in non-default tabs (Matt Westcott)
WAGTAILAPI_LIMIT_MAX now accepts None to disable limiting (jcronyn)
In PostgreSQL, new default ordering when ranking of objects is the same (Bertrand Bordage)
Fixed overlapping header elements on form submissions view on mobile (Jack Paine)
Fixed avatar position in footer on mobile (Jack Paine)
Custom document models no longer require their own post-delete signal handler (Gordon Pendleton)
Deletion of image / document files now only happens when database transaction has completed (Gordon Pendleton)
Fixed Node build scripts to work on Windows (Mikalai Radchuk)
Stop breadcrumb home icon from showing as ellipsis in Chrome 60 (Matt Westcott)
Prevent USE_THOUSAND_SEPARATOR = True from breaking the image focal point chooser (Sævar Öfjörð Magnússon)
Removed deprecated SessionAuthenticationMiddleware from project template (Samir Shah)
Custom display page titles defined with get_admin_display_title are now shown in search results (Ben Sturmfels, Matt Westcott)
Custom PageManagers now return the correct PageQuerySet subclass (Matt Westcott)
Fix: Removed deprecated SessionAuthenticationMiddleware from project template (Samir Shah)
request.FILES, for use in custom form handlers (LB (Ben Johnston))Page.last_published_at is now a filterable field for search (Mikalai Radchuk)order_by_relevance=False when searching with PostgreSQL now works (Mitchel Cabuloy)WAGTAILAPI_LIMIT_MAX now accepts None to disable limiting (jcronyn)USE_THOUSAND_SEPARATOR = True from breaking the image focal point chooser (Sævar Öfjörð Magnússon)SessionAuthenticationMiddleware from project template (Samir Shah)get_admin_display_title are now shown in search results (Ben Sturmfels, Matt Westcott)Fix: Pin Beautiful Soup to 4.6.0 due to further regressions in formatting empty elements (Matt Westcott)
August 13, 2018
Pin Beautiful Soup to 4.6.0 due to further regressions in formatting empty elements (Matt Westcott)
Fix: Pin django-taggit to <0.23 to restore Django 1.8 compatibility (Matt Westcott)
August 13, 2018
Pin django-taggit to <0.23 to restore Django 1.8 compatibility (Matt Westcott)
Mark Beautiful Soup 4.6.1 as incompatible due to bug in formatting empty elements (Matt Westcott)
Fix: Fix support of ATOMIC_REBUILD for projects with Elasticsearch client >=1.7.0 (Mikalai Radchuk)
ATOMIC_REBUILD for projects with Elasticsearch client >=1.7.0 (Mikalai Radchuk)July 4, 2018
Fix support of ATOMIC_REBUILD for projects with Elasticsearch client >=1.7.0 (Mikalai Radchuk)
Logging an indexing failure on an object with a non-ASCII representation no longer crashes on Python 2 (Aram Dulyan)
Rich text image chooser no longer skips format selection after a validation error (Matt Westcott)
Null characters in URLs no longer crash the redirect middleware on PostgreSQL (Andrew Crewdson, Matt Westcott)
Fix: API listing views no longer fail when no site records are defined (Karl Hobley)
__in filter (Karl Hobley, Matt Westcott)__isnull filters no longer fail on Elasticsearch 5 (Karl Hobley)SearchField and a FilterField (Matt Westcott)November 17, 2017
API listing views no longer fail when no site records are defined (Karl Hobley)
Pinned Django REST Framework to <3.7 to restore Django 1.8 compatibility (Matt Westcott)
Fixed crash in XML sitemap generator when all pages on the site are private (Stein Strindhaug)
Fixed error in Postgres search backend when searching specific fields of a specific() Page QuerySet (Bertrand Bordage, Matt Westcott)
Fixed error on Elasticsearch backend when passing a QuerySet as an __in filter (Karl Hobley, Matt Westcott)
__isnull filters no longer fail on Elasticsearch 5 (Karl Hobley)
Prevented intermittent failures on Postgres search backend when a field is defined as both a SearchField and a FilterField (Matt Westcott)
Fix: Migration for addition of Page.draft_title field is now reversible (Venelin Stoykov)
Page.draft_title field is now reversible (Venelin Stoykov)ManifestStaticFilesStorage is in use and collectstatic has not yet been run (Matt Westcott)September 18, 2017
Migration for addition of Page.draft_title field is now reversible (Venelin Stoykov)
Fixed failure on application startup when ManifestStaticFilesStorage is in use and collectstatic has not yet been run (Matt Westcott)
Fixed handling of Vimeo and other oEmbed providers with a format parameter in the endpoint URL (Mitchel Cabuloy)
Fixed regression in rendering save button in wagtail.contrib.settings edit view (Matt Westcott)
Fix: Prevent home page draft title from displaying as blank (Mikalai Radchuk, Matt Westcott)
August 30, 2017
Prevent home page draft title from displaying as blank (Mikalai Radchuk, Matt Westcott)
Fix regression on styling of preview button with more than one preview mode (Jack Paine)
Enabled translations within date-time chooser widget (Lucas Moeskops)
Fix: Removed deprecated jQuery load call from TableBlock initialisation (Jack Paine)
RoutablePageMixin now has a default "index" route (Andreas Nüßlein, Matt Westcott)blank setting; StreamBlock accepts a required setting (Loic Teixeira)min_num, max_num and block_counts settings to control the minimum and maximum numbers of blocks (Edwar Baron, Matt Westcott)process_form_submission method of form pages now return the created form submission object (cho-leukeleu)WAGTAILUSERS_PASSWORD_ENABLED and WAGTAILUSERS_PASSWORD_REQUIRED settings to permit creating users with no Django-side passwords, to support external authentication setups (Matt Westcott)DecimalBlock and RegexBlock (Tomasz Knapik)prepare_value method (Tim Heap)str representation, to prevent infinite loops in debugging / logging tools (Matt Westcott)load call from TableBlock initialisation (Jack Paine)August 21, 2017
Wagtail 1.12 is designated a Long Term Support (LTS) release. Long Term Support releases will continue to receive maintenance updates as necessary to address security and data-loss related issues, up until the next LTS release (typically a period of 8 months).
The feature set provided by the rich text editor can now be configured on a per-field basis, by passing a features keyword argument; for example, a field can be configured to allow bold / italic formatting and links, but not headings or embedded images or media. For further information, see rich_text_features. This feature was developed by Matt Westcott.
New configuration options for embedded media have been added, to give greater control over how media URLs are converted to embeds, and to make it possible to specify additional media providers beyond the ones built in to Wagtail. For further information, see embedded_content. This feature was developed by Karl Hobley.
The admin interface now displays a title of the latest draft (Mikalai Radchuk)
RoutablePageMixin now has a default "index" route (Andreas Nüßlein, Matt Westcott)
Added multi-select form field to the form builder (dwasyl)
Improved performance of sitemap generation (Levi Adler)
StreamField now respects the blank setting; StreamBlock accepts a required setting (Loic Teixeira)
StreamBlock now accepts min_num, max_num and block_counts settings to control the minimum and maximum numbers of blocks (Edwar Baron, Matt Westcott)
Users can no longer remove their own active / superuser flags through Settings -> Users (Stein Strindhaug, Huub Bouma)
The process_form_submission method of form pages now return the created form submission object (Christine Ho)
Added WAGTAILUSERS_PASSWORD_ENABLED and WAGTAILUSERS_PASSWORD_REQUIRED settings to permit creating users with no Django-side passwords, to support external authentication setups (Matt Westcott)
Added help text parameter to DecimalBlock and RegexBlock (Tomasz Knapik)
Optimised caudal oscillation parameters on logo (Jack Paine)
FieldBlocks in StreamField now call the field's prepare_value method (Tim Heap)
Initial disabled state of InlinePanel add button is now set correctly on non-default tabs (Matthew Downey)
Redirects with unicode characters now work (Rich Brennan)
Prevent explorer view from crashing when page model definitions are missing, allowing the offending pages to be deleted (Matt Westcott)
Hide the userbar from printed page representation (Eugene Morozov)
Prevent the page editor footer content from collapsing into two lines unnecessarily (Jack Paine)
StructBlock values no longer render HTML templates as their str representation, to prevent infinite loops in debugging / logging tools (Matt Westcott)
Removed deprecated jQuery load call from TableBlock initialization (Jack Paine)
Position of options in mobile nav-menu (Jack Paine)
Center page editor footer regardless of screen width (Jack Paine)
Change the design of the navbar toggle icon so that it no longer obstructs page headers (Jack Paine)
Document add/edit forms no longer render container elements for hidden fields (Jeffrey Chau)
StreamField now respects the blank field setting; when this is false, at least one block must be supplied for the field to pass validation. To match the behavior of other model fields, blank defaults to False; if you wish to allow a StreamField to be left empty, you must now add blank=True to the field.
When passing an explicit StreamBlock as the top-level block of a StreamField definition, note that the StreamField's blank keyword argument always takes precedence over the block's required property, including when it is left as the default value of blank=False. Consequently, setting required=False on a top-level StreamBlock has no effect.
The configuration settings WAGTAILEMBEDS_EMBED_FINDER and WAGTAILEMBEDS_EMBEDLY_KEY have been deprecated in favor of the new WAGTAILEMBEDS_FINDERS setting. Please see configuring_embed_finders for the new configuration to use.
The ability to enable / disable hallo.js plugins by calling registerHalloPlugin or modifying the halloPlugins list has been deprecated, and will be removed in Wagtail 1.14. The recommended way of customizing the hallo.js editor is now through rich text features.
This release introduces a new draft_title field on page models, so that page titles as used across the admin interface will correctly reflect any changes that exist in draft. If any of your page models override the get_admin_display_title method, to customize the display of page titles in the admin, it is recommended that you now update these to base their output on draft_title rather than title. Alternatively, to preserve backwards compatibility, you can invoke super on the method, for example:
def get_admin_display_title(self):
return "%(title)s (%(lang)s)" % {
'title': super(TranslatablePage, self).get_admin_display_title(),
'lang': self.language_code,
}
In most situations, the new draft_title field on page models will automatically be populated from the page title. However, this is not the case for pages that are created from fixtures. Projects that use fixtures to load initial data should therefore ensure that a draft_title field is specified.
If you've used RoutablePageMixin on a Page model, you may have had to manually define an index route to serve the page at its main URL (r'^$') so it behaves like a normal page. Wagtail now defines a default index route so this is no longer required.
Fix: Removed deprecated jQuery load call from TableBlock initialisation (Jack Paine)
RoutablePageMixin now has a default "index" route (Andreas Nüßlein, Matt Westcott)blank setting; StreamBlock accepts a required setting (Loic Teixeira)min_num, max_num and block_counts settings to control the minimum and maximum numbers of blocks (Edwar Baron, Matt Westcott)process_form_submission method of form pages now return the created form submission object (cho-leukeleu)WAGTAILUSERS_PASSWORD_ENABLED and WAGTAILUSERS_PASSWORD_REQUIRED settings to permit creating users with no Django-side passwords, to support external authentication setups (Matt Westcott)DecimalBlock and RegexBlock (Tomasz Knapik)prepare_value method (Tim Heap)str representation, to prevent infinite loops in debugging / logging tools (Matt Westcott)load call from TableBlock initialisation (Jack Paine)Fix: Custom display page titles defined with get_admin_display_title are now shown within the page explorer menu (Matt Westcott, Janneke Janssen)
get_admin_display_title are now shown within the page explorer menu (Matt Westcott, Janneke Janssen)July 7, 2017
Custom display page titles defined with get_admin_display_title are now shown within the page explorer menu (Matt Westcott, Janneke Janssen)
Added a new page explorer menu built with the admin API and React (Karl Hobley, Josh Barr, Thibaud Colas, Janneke Janssen, Rob Moorman, Maurice Bartni
StreamField is now assigned a globally unique identifier (Matt Westcott)last_published_at field to the Page model (Matt Westcott)show_in_menus_default flag on page models, to allow "show in menus" to be checked by default (LB (Ben Johnston))RelatedFields for elasticsearch & PostgreSQL search backends (Lucas Moeskops, Bertrand Bordage)TableBlock options afterChange, afterCreateCol, afterCreateRow, afterRemoveCol, afterRemoveRow and contextMenu can now be overridden (Loic Teixeira)June 30, 2017
After more than a year of work, the new explorer menu has finally landed! It comes with the following improvements:
View all pages - not just the ones with child pages.
Better performance, no matter the number of pages or levels in the hierarchy.
Navigate the menu via keyboard.
View Draft pages, and go to page editing, directly from the menu.
Beyond features, the explorer is built with the new admin API and React components. This will facilitate further evolutions to make it even faster and user-friendly. This work is the product of 4 Wagtail sprints, and the efforts of 16 people, listed here by order of first involvement:
Karl Hobley (Cape town sprint, admin API)
Josh Barr (Cape town sprint, prototype UI)
Thibaud Colas (Ede sprint, Reykjavík sprint)
Janneke Janssen (Ede sprint, Reykjavík sprint, Wagtail Space sprint)
Rob Moorman (Ede sprint, eslint-config-wagtail, ES6+React+Redux styleguide)
Maurice Bartnig (Ede sprint, i18n and bug fixes)
Jonny Scholes (code review)
Matt Westcott (Reykjavík sprint, refactorings)
Sævar Öfjörð Magnússon (Reykjavík sprint)
Eirikur Ingi Magnusson (Reykjavík sprint)
Harris Lapiroff (Reykjavík sprint, tab-accessible navigation)
Hugo van den Berg (testing, Wagtail Space sprint)
Olly Willans (UI, UX, Wagtail Space sprint)
Andy Babic (UI, UX)
Ben Enright (UI, UX)
Bertrand Bordage (testing, documentation)
Privacy settings can now be configured on collections, to restrict access to documents either by shared password or by user account. See: private_pages.
This feature was developed by Ulrich Wagner and Matt Westcott. Thank you to Wharton Research Data Services of The Wharton School for sponsoring this feature.
Optimised page URL generation by caching site paths in the request scope (Tobias McNulty, Matt Westcott)
The current live version of a page is now tracked on the revision listing view (Matheus Bratfisch)
Each block created in a StreamField is now assigned a globally unique identifier (Matt Westcott)
Mixcloud oEmbed pattern has been updated (Alice Rose)
Added last_published_at field to the Page model (Matt Westcott)
Added show_in_menus_default flag on page models, to allow "show in menus" to be checked by default (LB (Ben Johnston))
"Copy page" form now validates against copying to a destination where the user does not have permission (Henk-Jan van Hasselaar)
Allows reverse relations in RelatedFields for elasticsearch & PostgreSQL search backends (Lucas Moeskops, Bertrand Bordage)
Added oEmbed support for Facebook (Mikalai Radchuk)
Added oEmbed support for Tumblr (Mikalai Radchuk)
Unauthenticated AJAX requests to admin views now return 403 rather than redirecting to the login page (Karl Hobley)
TableBlock options afterChange, afterCreateCol, afterCreateRow, afterRemoveCol, afterRemoveRow and contextMenu can now be overridden (Loic Teixeira)
The lastmod field returned by wagtailsitemaps now shows the last published date rather than the date of the last draft edit (Matt Westcott)
Document chooser upload form no longer renders container elements for hidden fields (Jeffrey Chau)
Prevented exception when visiting a preview URL without initiating the preview (Paul Kamp)
The new explorer menu does not support IE8, IE9, and IE10. The fallback experience is a link pointing to the explorer pages.
The get_url_parts and relative_url methods on Page now accept an optional request keyword argument. Additionally, two new methods have been added, get_url (analogous to the url property) and get_full_url (analogous to the full_url) property. Whenever possible, these methods should be used instead of the property versions, and the request passed to each method. For example:
page_url = my_page.url
would become:
page_url = my_page.get_url(request=request)
This enables caching of underlying site-level URL information throughout the request cycle, thereby significantly reducing the number of cache or SQL queries your site will generate for a given page load. A common use case for these methods is any custom template tag your project may include for generating navigation menus. For more information, please refer to page_urls.
Furthermore, if you have overridden get_url_parts or relative_url on any of your page models, you will need to update the method signature to support this keyword argument; most likely, this will involve changing the line:
def get_url_parts(self):
to:
def get_url_parts(self, *args, **kwargs):
and passing those through at the point where you are calling get_url_parts on super (if applicable).
See also: wagtail.models.AbstractPage.get_url_parts, wagtail.models.AbstractPage.get_url, wagtail.models.AbstractPage.get_full_url, and wagtail.models.AbstractPage.relative_url
This release adds the ability to password-protect documents as well as pages. The template used for the "password required" form is distinct from the one used for pages; if you have previously overridden the default template through the PASSWORD_REQUIRED_TEMPLATE setting, you may wish to provide a corresponding template for documents through the setting DOCUMENT_PASSWORD_REQUIRED_TEMPLATE. See: private_pages
While not specific to Wagtail 1.11, users of Elasticsearch should be aware that the ATOMIC_REBUILD option is not compatible with Elasticsearch 5.4.x due to a bug in the handling of aliases. If you wish to use this feature, please use Elasticsearch 5.3.x or 5.5.x (when available).
Added a new page explorer menu built with the admin API and React (Karl Hobley, Josh Barr, Thibaud Colas, Janneke Janssen, Rob Moorman, Maurice Bartni
StreamField is now assigned a globally unique identifier (Matt Westcott)last_published_at field to the Page model (Matt Westcott)show_in_menus_default flag on page models, to allow "show in menus" to be checked by default (LB (Ben Johnston))RelatedFields for elasticsearch & PostgreSQL search backends (Lucas Moeskops, Bertrand Bordage)TableBlock options afterChange, afterCreateCol, afterCreateRow, afterRemoveCol, afterRemoveRow and contextMenu can now be overridden (Loic Teixeira)Fix: Fix admin page preview that was broken 24 hours after previewing a page (Martin Hill)
May 19, 2017
Fix admin page preview that was broken 24 hours after previewing a page (Martin Hill)
Removed territory-specific translations for Spanish, Polish, Swedish, Russian and Chinese (Taiwan) that block more complete translations from being used (Matt Westcott)
Added PostgreSQL search engine (Bertrand Bordage, Jaap Roes, Arne de Laat, Ramon de Jezus)
WAGTAILADMIN_PERMITTED_LANGUAGES (Daniel Chimeno)WAGTAIL_AUTO_UPDATE_PREVIEW setting that when set to True, allows the preview window to be refreshed when changes have been made in the editor (Bertrand Bordage)submit_buttons block to login template (Gagaro)construct_image_chooser_queryset, construct_document_chooser_queryset and construct_page_chooser_queryset hooks (Gagaro)Image and Rendition models are connected automatically (Mike Dingjan)PageChooserBlock can now accept a list/tuple of page models as target_model (Mikalai Radchuk)IndexView to be more inline with the Wagtail styleguide (Andy Babic).nvmrc to the project root for Node versioning support (Janneke Janssen)form_fields_exclude property to ModelAdmin views (Matheus Bratfisch)AUTH_PASSWORD_VALIDATORS (Bertrand Bordage)non_field_errors when validation fails in the page editor (Matt Westcott)WAGTAILADMIN_RECENT_EDITS_LIMIT setting to to define the number of your most recent edits on the dashboard (Maarten Kling)is_staff flag (Matt Westcott)TAG_SPACES_ALLOWED setting (Kees Hink, Alex Gleason)Page.api_fields using a new APIField class (Karl Hobley)classname argument to StreamFieldPanel (Christine Ho)group keyword argument to StreamField blocks for grouping related blocks together in the block menu (Andreas Nüßlein){{ block.super }} in snippets/type_index.html (LB (Ben Johnston))request.is_preview flag (Wietze Helmantel)get_db_prep_value conversion are now supported (thenewguy)annotate_score (Karl Hobley)RichTextBlock toolbar now correctly positioned within StructBlock (Janneke Janssen)|safe filter from search results template in project template (Karl Hobley)May 3, 2017
A new search engine has been added to Wagtail which uses PostgreSQL's built-in full-text search functionality. This means that if you use PostgreSQL to manage your database, you can now get a good quality search engine without needing to install Elasticsearch.
This feature was developed at the Arnhem sprint by Bertrand Bordage, Jaap Roes, Arne de Laat and Ramon de Jezus.
Wagtail is now compatible with Django 1.11 and Python 3.6. Compatibility fixes were contributed by Tim Graham, Matt Westcott, Mikalai Radchuk and Bertrand Bordage.
Users can now set their preferred language for the Wagtail admin interface under Account Settings → Language Preferences. The list of available languages can be configured via the WAGTAILADMIN_PERMITTED_LANGUAGES setting. This feature was developed by Daniel Chimeno.
Previewing pages in Wagtail admin interface was rewritten to make it more robust. In previous versions, preview was broken in several scenarios so users often ended up on a blank page with an infinite spinner.
An additional setting was created: WAGTAIL_AUTO_UPDATE_PREVIEW. It allows users to see changes done in the editor by refreshing the preview tab without having to click again on the preview button.
This was developed by Bertrand Bordage.
Use minified versions of jQuery and jQuery UI in the admin. Total savings without compression 371 KB (Tom Dyson)
Hooks can now specify the order in which they are run (Gagaro)
Added a submit_buttons block to login template (Gagaro)
Added construct_image_chooser_queryset, construct_document_chooser_queryset and construct_page_chooser_queryset hooks (Gagaro)
The homepage created in the project template is now titled "Home" rather than "Homepage" (Karl Hobley)
Signal receivers for custom Image and Rendition models are connected automatically (Mike Dingjan)
PageChooserBlock can now accept a list/tuple of page models as target_model (Mikalai Radchuk)
Styling tweaks for the ModelAdmin's IndexView to be more inline with the Wagtail styleguide (Andy Babic)
Added .nvmrc to the project root for Node versioning support (Janneke Janssen)
Added form_fields_exclude property to ModelAdmin views (Matheus Bratfisch)
User creation / edit form now enforces password validators set in AUTH_PASSWORD_VALIDATORS (Bertrand Bordage)
Added support for displaying non_field_errors when validation fails in the page editor (Matt Westcott)
Added WAGTAILADMIN_RECENT_EDITS_LIMIT setting to define the number of your most recent edits on the dashboard (Maarten Kling)
Added link to the full Elasticsearch setup documentation from the Performance page (Matt Westcott)
Tag input fields now accept spaces in tags by default, and can be overridden with the TAG_SPACES_ALLOWED setting (Kees Hink, Alex Gleason)
Page chooser widgets now display the required page type where relevant (Christine Ho)
Site root pages are now indicated with a globe icon in the explorer listing (Nick Smith, Huub Bouma)
Draft page view is now restricted to users with edit / publish permission over the page (Kees Hink)
Added the option to delete a previously saved focal point on a image (Maarten Kling)
Page explorer menu item, search and summary panel are now hidden for users with no page permissions (Tim Heap)
Added support for custom date and datetime formats in input fields (Bojan Mihelac)
Added support for custom Django REST framework serialiser fields in Page.api_fields using a new APIField class (Karl Hobley)
Added classname argument to StreamFieldPanel (Christine Ho)
Added group keyword argument to StreamField blocks for grouping related blocks together in the block menu (Andreas Nüßlein)
Update the sitemap generator to use the Django sitemap module (Michael van Tellingen, Mike Dingjan)
Marked 'Date from' / 'Date to' strings in wagtailforms for translation (Vorlif)
"File" field label on image edit form is now translated (Stein Strindhaug)
Unreliable preview is now reliable by always opening in a new window (Kjartan Sverrisson)
Fixed placement of {{ block.super }} in snippets/type_index.html (LB (Ben Johnston))
Optimised database queries on group edit page (Ashia Zawaduk)
Choosing a popular search term for promoted search results now works correctly after pagination (Janneke Janssen)
IDs used in tabbed interfaces are now namespaced to avoid collisions with other page elements (Janneke Janssen)
Page title not displaying page name when moving a page (Trent Holliday)
The ModelAdmin module can now work without the wagtailimages and wagtaildocs apps installed (Andy Babic)
Cloudflare error handling now handles non-string error responses correctly (hdnpl)
Search indexing now uses a defined query ordering to prevent objects from being skipped (Christian Peters)
Ensure that number localization is not applied to object IDs within admin templates (Tom Hendrikx)
Paginating with a search present was always returning the 1st page in Internet Explorer 10 & 11 (Ralph Jacobs)
RoutablePageMixin and wagtailforms previews now set the request.is_preview flag (Wietze Helmantel)
The save and preview buttons in the page editor are now mobile-friendly (Maarten Kling)
Page links within rich text now respect custom URLs defined on specific page models (Gary Krige, Huub Bouma)
Default avatar no longer visible when using a transparent gravatar image (Thijs Kramer)
Scrolling within the datetime picker is now usable again for touchpads (Ralph Jacobs)
List-based fields within form builder form submissions are now displayed as comma-separated strings rather than as Python lists (Christine Ho, Matt Westcott)
The page type usage listing now have a translatable page title (Ramon de Jezus)
Styles for submission filtering form now have a consistent height. (Thijs Kramer)
Slicing a search result set no longer loses the annotation added by annotate_score (Karl Hobley)
String-based primary keys are now escaped correctly in ModelAdmin URLs (Andreas Nüßlein)
Empty search in the API now works (Morgan Aubert)
RichTextBlock toolbar now correctly positioned within StructBlock (Janneke Janssen)
Fixed display of ManyToMany fields and False values on the ModelAdmin inspect view (Andy Babic)
Prevent pages from being recursively copied into themselves (Matheus Bratfisch)
Specifying the full file name in documents URL is mandatory (Morgan Aubert)
Reordering inline forms now works correctly when moving past a deleted form (Janneke Janssen)
Removed erroneous |safe filter from search results template in project template (Karl Hobley)
Support for Django 1.9 and Python 3.3 has been dropped in this release; please upgrade from these before upgrading Wagtail. Note that the Django 1.8 release series is still supported, as a Long Term Support release.
Django-medusa is no longer maintained, and is incompatible with Django 1.8 and above. An alternative module based on the django-bakery package is available as a third-party contribution: https://github.com/moorinteractive/wagtail-bakery.
Projects using custom image models no longer need to set up signal receivers to handle deletion of image files and image feature detection, as these are now handled automatically by Wagtail. The following lines of code should be removed:
# Delete the source image file when an image is deleted
@receiver(post_delete, sender=CustomImage)
def image_delete(sender, instance, **kwargs):
instance.file.delete(False)
# Delete the rendition image file when a rendition is deleted
@receiver(post_delete, sender=CustomRendition)
def rendition_delete(sender, instance, **kwargs):
instance.file.delete(False)
# Perform image feature detection (if enabled)
@receiver(pre_save, sender=CustomImage)
def image_feature_detection(sender, instance, **kwargs):
if not instance.has_focal_point():
instance.set_focal_point(instance.get_suggested_focal_point())
Previously, the is_staff flag (which grants access to the Django admin interface) was automatically set for superusers, and reset for other users, when creating and updating users through the Wagtail admin. This behaviour has now been removed, since Wagtail is designed to work independently of the Django admin. If you need to reinstate the old behavior, you can set up a ~django.db.models.signals.pre_save signal handler on the User model to set the flag appropriately.
In previous releases, it was possible to download a document using the primary key and a fraction of its file name, or even without file name. You could get the same document at the addresses /documents/1/your-file-name.pdf, /documents/1/you & /documents/1/.
This feature was supposed to allow shorter URLs but was not used in Wagtail. For security reasons, we removed it, so only the full URL works: /documents/1/your-file-name.pdf
If any of your applications relied on the previous behavior, you will have to rewrite it to take this into account.
Added PostgreSQL search engine (Bertrand Bordage, Jaap Roes, Arne de Laat, Ramon de Jezus)
WAGTAILADMIN_PERMITTED_LANGUAGES (Daniel Chimeno)WAGTAIL_AUTO_UPDATE_PREVIEW setting that when set to True, allows the preview window to be refreshed when changes have been made in the editor (Bertrand Bordage)submit_buttons block to login template (Gagaro)construct_image_chooser_queryset, construct_document_chooser_queryset and construct_page_chooser_queryset hooks (Gagaro)Image and Rendition models are connected automatically (Mike Dingjan)PageChooserBlock can now accept a list/tuple of page models as target_model (Mikalai Radchuk)IndexView to be more inline with the Wagtail styleguide (Andy Babic).nvmrc to the project root for Node versioning support (Janneke Janssen)form_fields_exclude property to ModelAdmin views (Matheus Bratfisch)AUTH_PASSWORD_VALIDATORS (Bertrand Bordage)non_field_errors when validation fails in the page editor (Matt Westcott)WAGTAILADMIN_RECENT_EDITS_LIMIT setting to to define the number of your most recent edits on the dashboard (Maarten Kling)is_staff flag (Matt Westcott)TAG_SPACES_ALLOWED setting (Kees Hink, Alex Gleason)Page.api_fields using a new APIField class (Karl Hobley)classname argument to StreamFieldPanel (Christine Ho)group keyword argument to StreamField blocks for grouping related blocks together in the block menu (Andreas Nüßlein){{ block.super }} in snippets/type_index.html (LB (Ben Johnston))request.is_preview flag (Wietze Helmantel)get_db_prep_value conversion are now supported (thenewguy)annotate_score (Karl Hobley)RichTextBlock toolbar now correctly positioned within StructBlock (Janneke Janssen)Fix: Removed erroneous |safe filter from search results template in project template (Karl Hobley)
|safe filter from search results template in project template (Karl Hobley)April 21, 2017
Removed erroneous |safe filter from search results template in project template (Karl Hobley)
Prevent pages from being recursively copied into themselves (Matheus Bratfisch)
Added support for comparing page revisions (Karl Hobley, Janneke Janssen, Matt Westcott)
get_context methods on StreamField blocks can now access variables from the parent context (Mikael Svensson, Peter Baumgartner)get_api_representation method to streamfield blocks allowing the JSON representation in the API to be customised (Marco Fucci)before_copy_page and after_copy_page hooks (Matheus Bratfisch)ChoiceBlock now omits the blank option if the block is required and has a default value (Andreas Nüßlein)add_subpage view now maintains a next URL parameter to specify where to redirect to after completing page creation (Robert Rollins)wagtailforms module now allows to define custom form submission model, add custom data to CSV export and some other customisations (Mikalai Radchuk)save(update_fields=[...]) operations (Matt Westcott)get_extra_class_names_for_field_col / get_extra_attrs_for_field_col methods (Andy Babic)pageurl / slugurl tags now function when request.site is not available (Tobias McNulty, Matt Westcott)1.8, 1.9, 1.10
2.7, 3.3, 3.4, 3.5
1.8 LTS
1.8, 1.9, 1.10
2.7, 3.3, 3.4, 3.5
February 16, 2017
Wagtail now provides the ability to view differences between revisions of a page, from the revisions listing page and when reviewing a page in moderation. This feature was developed by Karl Hobley, Janneke Janssen and Matt Westcott. Thank you to Blackstone Chambers for sponsoring this feature.
Wagtail now supports a new field type ParentalManyToManyField that can be used to set up many-to-many relations on pages. For details, see the tutorial_categories section of the tutorial. This feature was developed by Thejaswi Puthraya and Matt Westcott.
Form builder form submissions can now be deleted in bulk from the form submissions index page. This feature was sponsored by St John's College, Oxford and developed by Karl Hobley.
The get_context method on StreamField blocks now receives a parent_context keyword argument, consisting of the dict of variables passed in from the calling template. For example, this makes it possible to perform pagination logic within get_context, retrieving the current page number from parent_context['request'].GET. See get_context on StreamField blocks. This feature was developed by Mikael Svensson and Peter Baumgartner.
The welcome message on the admin dashboard has been updated to be more suitable for multi-tenanted installations. Users whose page permissions lie within a single site will now see that site name in the welcome message, rather than the installation-wide WAGTAIL_SITE_NAME. As before, this message can be customized, and additional template variables have been provided for this purpose - see custom_branding. This feature was developed by Jeffrey Chau.
Changed text of "Draft" and "Live" buttons to "View draft" and "View live" (Dan Braghis)
Added get_api_representation method to streamfield blocks allowing the JSON representation in the API to be customized (Marco Fucci)
Added before_copy_page and after_copy_page hooks (Matheus Bratfisch)
View live / draft links in the admin now consistently open in a new window (Marco Fucci)
ChoiceBlock now omits the blank option if the block is required and has a default value (Andreas Nüßlein)
The add_subpage view now maintains a next URL parameter to specify where to redirect to after completing page creation (Robert Rollins)
The wagtailforms module now allows to define custom form submission model, add custom data to CSV export and some other customizations. See /reference/contrib/forms/customization (Mikalai Radchuk)
The Webpack configuration is now in a subfolder to declutter the project root, and uses environment-specific configurations for smaller bundles in production and easier debugging in development (Janneke Janssen, Thibaud Colas)
Added page titles to title text on action buttons in the explorer, for improved accessibility (Matt Westcott)
Help text for StreamField is now visible and does not cover block controls (Stein Strindhaug)
"X minutes ago" timestamps are now marked for translation (Janneke Janssen, Matt Westcott)
Avoid indexing unsaved field content on save(update_fields=[...]) operations (Matt Westcott)
Corrected ordering of arguments passed to ModelAdmin get_extra_class_names_for_field_col / get_extra_attrs_for_field_col methods (Andy Babic)
pageurl / slugurl tags now function when request.site is not available (Tobias McNulty, Matt Westcott)
Wagtail now requires version 3.0 or later of django-modelcluster and version 0.20 or later of django-taggit; earlier versions are unsupported. In normal circumstances these packages will be upgraded automatically when upgrading Wagtail; however, if your Wagtail project has a requirements file that explicitly specifies an older version, this will need to be updated.
Previously, get_context methods on StreamField blocks returned a dict of variables which would be merged into the calling template's context before rendering the block template. get_context methods now receive a parent_context dict, and are responsible for returning the final context dictionary with any new variables merged into it. The old calling convention is now deprecated, and will be phased out in Wagtail 1.11.
In most cases, the method will be calling get_context on the superclass, and can be updated by passing the new parent_context keyword argument to it:
class MyBlock(Block):
def get_context(self, value):
context = super(MyBlock, self).get_context(value)
...
return context
becomes:
class MyBlock(Block):
def get_context(self, value, parent_context=None):
context = super(MyBlock, self).get_context(value, parent_context=parent_context)
...
return context
Note that get_context methods on page models are unaffected by this change.
Added support for comparing page revisions (Karl Hobley, Janneke Janssen, Matt Westcott)
get_context methods on StreamField blocks can now access variables from the parent context (Mikael Svensson, Peter Baumgartner)get_api_representation method to streamfield blocks allowing the JSON representation in the API to be customised (Marco Fucci)before_copy_page and after_copy_page hooks (Matheus Bratfisch)ChoiceBlock now omits the blank option if the block is required and has a default value (Andreas Nüßlein)add_subpage view now maintains a next URL parameter to specify where to redirect to after completing page creation (Robert Rollins)wagtailforms module now allows to define custom form submission model, add custom data to CSV export and some other customisations (Mikalai Radchuk)save(update_fields=[...]) operations (Matt Westcott)get_extra_class_names_for_field_col / get_extra_attrs_for_field_col methods (Andy Babic)Fix: Removed erroneous |safe filter from search results template in project template (Karl Hobley)
|safe filter from search results template in project template (Karl Hobley)save(update_fields=[...]) operations (Matt Westcott)April 21, 2017
Removed erroneous |safe filter from search results template in project template (Karl Hobley)
Avoid indexing unsaved field content on save(update_fields=[...]) operations (Matt Westcott)
Prevent pages from being recursively copied into themselves (Matheus Bratfisch)
Fix: Reduced Rendition.focal_point_key field length to prevent migration failure when upgrading to Wagtail 1.8 on MySQL with utf8 character encoding (
Rendition.focal_point_key field length to prevent migration failure when upgrading to Wagtail 1.8 on MySQL with utf8 character encoding (Andy Chosak, Matt Westcott)January 26, 2017
Reduced Rendition.focal_point_key field length to prevent migration failure when upgrading to Wagtail 1.8 on MySQL with utf8 character encoding (Andy Chosak, Matt Westcott)
New page privacy options (Shawn Makinson, Tom Miller, Luca Perico, Matt Westcott)
edit_handler in site settings (Axel Haustant)get_landing_page_template getter method to AbstractForm (Gagaro)Page.get_admin_display_title method to override how the title is displayed in the admin (Henk-Jan van Hasselaar)first_common_ancestor method to PageQuerySet (Tim Heap)PageChooserBlock now accepts a target_model option to specify the required page type (Tim Heap)fields / exclude options passed on custom model forms (Thejaswi Puthraya)StaticBlock (Benoît Vogel)BlockQuoteBlock (Scot Hacker)exclude_from_explorer attribute to the ModelAdmin class to allow hiding instances of a page type from Wagtail's explorer views (Andy Babic)above_login, below_login, fields and login_form customisation blocks to the login page template (Tim Heap)ChoiceBlock now accepts a callable as the choices list (Mikalai Radchuk)in_site method for filtering page querysets to pages within the specified site (Chris Rogers)OPTIONS of the WAGTAILSEARCH_BACKENDS setting (PyMan Claudio Marinozzi)AbstractForm now respects custom get_template methods on the page model (Gagaro)get_context_data (Andy Babic)set_url_paths management command is now compatible with Django 1.10 (Benjamin Bach)search_garbage_collect management command now works when wagtailsearchpromotions is not installed (Morgan Aubert)wagtail.contrib.settings context processor no longer fails when request.site is unavailable (Diederik van der Boor)TableBlock content is now indexed for search (Morgan Aubert)Page.copy() is now marked as alters_data, to prevent template code from triggering it (Diederik van der Boor)December 15, 2016
Wagtail 1.8 is designated a Long Term Support (LTS) release. Long Term Support releases will continue to receive maintenance updates as necessary to address security and data-loss related issues, up until the next LTS release (typically a period of 8 months).
Access to pages can now be restricted based on user accounts and group membership, rather than just through a shared password. This makes it possible to set up intranet-style sites via the admin, with no additional coding. This feature was developed by Shawn Makinson, Tom Miller, Luca Perico and Matt Westcott.
See: private_pages
Previously, any user with edit permission over a page and its descendants was able to delete them all as a single action, which led to the risk of accidental deletions. To guard against this, the permission rules have been revised so that a user with basic permissions can only delete pages that have no children; to delete a whole subtree, they must individually delete each child page first. A new "bulk delete" permission type has been added which allows a user to delete pages with children, as before; superusers receive this permission implicitly, and so there is no change of behavior for them.
This feature was developed by Matt Westcott.
Wagtail now supports Elasticsearch 5. See wagtailsearch_backends_elasticsearch for configuration details. This feature was developed by Karl Hobley.
Breadcrumb links within the admin are now limited to the portion of the page tree that covers all pages the user has permission over. As with the changes to the explorer sidebar menu in Wagtail 1.6, this is a step towards supporting full multi-tenancy (where multiple sites on the same Wagtail installation can be fully isolated from each other through permission configuration). This feature was developed by Jeffrey Chau, Robert Rollins and Matt Westcott.
The "Your first Wagtail site" tutorial has been extensively updated to cover concepts such as dynamic page listings, template context variables, and tagging. This update was contributed by Scot Hacker, with additions from Matt Westcott.
Added support of a custom edit_handler for site settings. See docs for the site settings module. (Axel Haustant)
Added get_landing_page_template getter method to AbstractForm (Gagaro)
Added Page.get_admin_display_title method to override how the title is displayed in the admin (Henk-Jan van Hasselaar)
Added support for specifying custom HTML attributes for table rows on ModelAdmin index pages. (Andy Babic)
Added first_common_ancestor method to PageQuerySet (Tim Heap)
Page chooser now opens at the deepest ancestor page that covers all the pages of the required page type (Tim Heap)
PageChooserBlock now accepts a target_model option to specify the required page type (Tim Heap)
Modeladmin forms now respect fields / exclude options passed on custom model forms (Thejaswi Puthraya)
Added new StreamField block type StaticBlock for blocks that occupy a position in a stream but otherwise have no configuration; see StaticBlock (Benoît Vogel)
Added new StreamField block type BlockQuoteBlock (Scot Hacker)
Updated Cloudflare cache module to use the v4 API (Albert O'Connor)
Added exclude_from_explorer attribute to the ModelAdmin class to allow hiding instances of a page type from Wagtail's explorer views (Andy Babic)
Added above_login, below_login, fields and login_form customization blocks to the login page template - see /advanced_topics/customization/admin_templates (Tim Heap)
ChoiceBlock now accepts a callable as the choices list (Mikalai Radchuk)
Redundant action buttons are now omitted from the root page in the explorer (Nick Smith)
Locked pages are now disabled from editing at the browser level (Edd Baldry)
Added wagtail.query.PageQuerySet.in_site method for filtering page QuerySets to pages within the specified site (Chris Rogers)
Added the ability to override the default index settings for Elasticsearch. See wagtailsearch_backends_elasticsearch (PyMan Claudio Marinozzi)
Extra options for the Elasticsearch constructor should be now defined with the new key OPTIONS of the WAGTAILSEARCH_BACKENDS setting (PyMan Claudio Marinozzi)
AbstractForm now respects custom get_template methods on the page model (Gagaro)
Use specific page model for the parent page in the explore index (Gagaro)
Remove responsive styles in embed when there is no ratio available (Gagaro)
Parent page link in page search modal no longer disappears on hover (Dan Braghis)
ModelAdmin views now consistently call get_context_data (Andy Babic)
Header for search results on the redirects index page now shows the correct count when the listing is paginated (Nick Smith)
set_url_paths management command is now compatible with Django 1.10 (Benjamin Bach)
Form builder email notifications now output multiple values correctly (Sævar Öfjörð Magnússon)
Closing 'more' dropdown on explorer no longer jumps to the top of the page (Ducky)
Users with only publish permission are no longer given implicit permission to delete pages (Matt Westcott)
search_garbage_collect management command now works when wagtailsearchpromotions is not installed (Morgan Aubert)
wagtail.contrib.settings context processor no longer fails when request.site is unavailable (Diederik van der Boor)
TableBlock content is now indexed for search (Morgan Aubert)
Page.copy() is now marked as alters_data, to prevent template code from triggering it (Diederik van der Boor)
If your project is using a custom image model (see custom_image_model), you will need to update the unique_together option on the corresponding Rendition model when upgrading to Wagtail 1.8. Change the line:
unique_together = (
('image', 'filter', 'focal_point_key'),
)
to:
unique_together = (
('image', 'filter_spec', 'focal_point_key'),
)
You will then be able to run manage.py makemigrations and manage.py migrate as normal.
Additionally, third-party code that accesses the Filter and Rendition models directly should note the following and make updates where applicable:
Filter will no longer be a Django model as of Wagtail 1.9, and as such, ORM operations on it (such as save() and Filter.objects) are deprecated. It should be instantiated and used as an in-memory object instead - for example, flt, created = Filter.objects.get_or_create(spec='fill-100x100') should become flt = Filter(spec='fill-100x100').
The filter field of Rendition models is no longer in use; lookups should instead be performed on the filter_spec field, which contains a filter spec string such as 'fill-100x100'.
The get_image_model function should now be imported from wagtail.wagtailimages rather than wagtail.wagtailimages.models. See custom_image_model_referring_to_image_model.
As a precaution against accidental data loss, this release introduces a new "bulk delete" permission on pages, which can be set through the Settings -> Groups area. Non-administrator users must have this permission to delete pages that have children; a user without this permission would have to delete each child individually before deleting the parent. By default, no groups are assigned this new permission. If you wish to restore the previous behavior and don't want to configure permissions manually through the admin interface, you can do so with a data migration. Create an empty migration using ./manage.py makemigrations myapp --empty --name assign_bulk_delete_permission (replacing myapp with the name of one of your project's apps) and edit the migration file to contain the following:
from __future__ import unicode_literals
from django.db import migrations
def add_bulk_delete_permission(apps, schema_editor):
"""Find all groups with add/edit page permissions, and assign them bulk_delete permission"""
GroupPagePermission = apps.get_model('wagtailcore', 'GroupPagePermission')
for group_id, page_id in GroupPagePermission.objects.filter(
permission_type__in=['add', 'edit']
).values_list('group', 'page').distinct():
GroupPagePermission.objects.create(
group_id=group_id, page_id=page_id, permission_type='bulk_delete'
)
def remove_bulk_delete_permission(apps, schema_editor):
GroupPagePermission = apps.get_model('wagtailcore', 'GroupPagePermission')
GroupPagePermission.objects.filter(permission_type='bulk_delete').delete()
class Migration(migrations.Migration):
dependencies = [
# keep the original dependencies line
]
operations = [
migrations.RunPython(add_bulk_delete_permission, remove_bulk_delete_permission),
]
The wagtail.contrib.wagtailfrontendcache.backends.CloudflareBackend module has been updated to use Cloudflare's v4 API, replacing the previous v1 implementation (which is unsupported as of November 9th, 2016). The new API requires users to supply a zone identifier, which should be passed as the ZONEID field of the WAGTAILFRONTENDCACHE setting:
WAGTAILFRONTENDCACHE = {
'cloudflare': {
'BACKEND': 'wagtail.contrib.wagtailfrontendcache.backends.CloudflareBackend',
'EMAIL': 'your-cloudflare-email-address@example.com',
'TOKEN': 'your cloudflare api token',
'ZONEID': 'your cloudflare domain zone id',
},
}
For details of how to obtain the zone identifier, see the Cloudflare API documentation.
For the Elasticsearch backend, all extra keys defined in WAGTAILSEARCH_BACKENDS are passed directly to the Elasticsearch constructor. All these keys now should be moved inside the new OPTIONS dictionary. The old behavior is still supported but deprecated.
For example, the following configuration changes the connection class that the Elasticsearch connector uses:
from elasticsearch import RequestsHttpConnection
WAGTAILSEARCH_BACKENDS = {
'default': {
'BACKEND': 'wagtail.wagtailsearch.backends.elasticsearch',
'connection_class': RequestsHttpConnection,
}
}
As connection_class needs to be passed through to the Elasticsearch connector, it should be moved to the new OPTIONS dictionary:
from elasticsearch import RequestsHttpConnection
WAGTAILSEARCH_BACKENDS = {
'default': {
'BACKEND': 'wagtail.wagtailsearch.backends.elasticsearch',
'OPTIONS': {
'connection_class': RequestsHttpConnection,
}
}
}
New page privacy options (Shawn Makinson, Tom Miller, Luca Perico, Matt Westcott)
edit_handler in site settings (Axel Haustant)get_landing_page_template getter method to AbstractForm (Gagaro)Page.get_admin_display_title method to override how the title is displayed in the admin (Henk-Jan van Hasselaar)first_common_ancestor method to PageQuerySet (Tim Heap)PageChooserBlock now accepts a target_model option to specify the required page type (Tim Heap)fields / exclude options passed on custom model forms (Thejaswi Puthraya)StaticBlock (Benoît Vogel)BlockQuoteBlock (Scot Hacker)exclude_from_explorer attribute to the ModelAdmin class to allow hiding instances of a page type from Wagtail's explorer views (Andy Babic)above_login, below_login, fields and login_form customisation blocks to the login page template (Tim Heap)ChoiceBlock now accepts a callable as the choices list (Mikalai Radchuk)in_site method for filtering page querysets to pages within the specified site (Chris Rogers)OPTIONS of the WAGTAILSEARCH_BACKENDS setting (PyMan Claudio Marinozzi)AbstractForm now respects custom get_template methods on the page model (Gagaro)get_context_data (Andy Babic)set_url_paths management command is now compatible with Django 1.10 (Benjamin Bach)search_garbage_collect management command now works when wagtailsearchpromotions is not installed (Morgan Aubert)wagtail.contrib.settings context processor no longer fails when request.site is unavailable (Diederik van der Boor)TableBlock content is now indexed for search (Morgan Aubert)Page.copy() is now marked as alters_data, to prevent template code from triggering it (Diederik van der Boor)Elasticsearch 2 support (Karl Hobley)
|embed filter has been converted into a templatetag {% embed %} (Janneke Janssen)wagtailforms module now provides a FormSubmissionPanel for displaying details of form submissions (João Luiz Lorencetti)from wagtail import VERSION (Tim Heap)send_mail logic has been moved from AbstractEmailForm.process_form_submission into AbstractEmailForm.send_mail. Now it's easier to override this logic (Tim Leguijt)before_create_page, before_edit_page, before_delete_page hooks (Karl Hobley)SnippetChooserBlock now supports passing the model name as a string (Nick Smith)__latest__ migration, logically preventing those apps from receiving new migrations (Matt Westcott)InlinePanel now accepts a classname parameter as per the documentation (emg36, Matt Westcott)USE_THOUSAND_SEPARATOR = True no longer breaks the rendering of numbers in JS code for InlinePanel (Mattias Loverot, Matt Westcott)wagtail_userprofile to avoid naming collisions with other user profile models (Matt Westcott)SECURE_SSL_REDIRECT = True (Aymeric Augustin)October 20, 2016
Wagtail now supports Elasticsearch 2. Note that you need to change backend in WAGTAILSEARCH_BACKENDS, if you wish to switch to Elasticsearch 2. This feature was developed by Karl Hobley.
See: wagtailsearch_backends_elasticsearch
The {% image %} tag now supports extra parameters for specifying the image file type and JPEG compression level on a per-tag basis. See output_image_format and image_quality. This feature was developed by Karl Hobley.
Wagtail's cache invalidation module can now invalidate pages cached in AWS CloudFront when they are updated or unpublished. This feature was developed by Rob Moorman.
See: frontendcache_aws_cloudfront
Unpublishing a page now gives the option to unpublish its subpages at the same time. This feature was developed by Jordi Joan.
The |embed filter has been converted into a templatetag {% embed %} (Janneke Janssen)
The wagtailforms module now provides a FormSubmissionPanel for displaying details of form submissions; see wagtailforms_formsubmissionpanel for documentation. (João Luiz Lorencetti)
The Wagtail version number can now be obtained as a tuple using from wagtail import VERSION (Tim Heap)
send_mail logic has been moved from AbstractEmailForm.process_form_submission into AbstractEmailForm.send_mail. Now it's easier to override this logic (Tim Leguijt)
Added before_create_page, before_edit_page, before_delete_page hooks (Karl Hobley)
Updated font sizes and colors to improve legibility of admin menu and buttons (Stein Strindhaug)
Added pagination to "choose destination" view when moving pages (Nick Smith, Žan Anderle)
Added ability to annotate search results with score - see wagtailsearch_annotating_results_with_score (Karl Hobley)
Added ability to limit access to form submissions - see filter_form_submissions_for_user (Mikalai Radchuk)
Added the ability to configure the number of days search logs are kept for, through the WAGTAILSEARCH_HITS_MAX_AGE setting (Stephen Rice)
SnippetChooserBlock now supports passing the model name as a string (Nick Smith)
Redesigned account settings / logout area in the sidebar for better clarity (Janneke Janssen)
Pillow's image optimization is now applied when saving JPEG images (Karl Hobley)
Migrations for wagtailcore and project template are now reversible (Benjamin Bach)
Migrations no longer depend on wagtailcore and taggit's __latest__ migration, logically preventing those apps from receiving new migrations (Matt Westcott)
The default image format label text ('Full width', 'Left-aligned', 'Right-aligned') is now localized (Mikalai Radchuk)
Text on the front-end 'password required' form is now marked for translation (Janneke Janssen)
Text on the page view restriction form is now marked for translation (Luiz Boaretto)
Fixed toggle behaviour of userbar on mobile (Robert Rollins)
Image rendition / document file deletion now happens on a post_delete signal, so that files are not lost if the deletion does not proceed (Janneke Janssen)
"Your recent edits" list on dashboard no longer leaves out pages that another user has subsequently edited (Michael Cordover, Kees Hink, João Luiz Lorencetti)
InlinePanel now accepts a classname parameter as per the documentation (emg36, Matt Westcott)
Disabled use of escape key to revert content of rich text fields, which could cause accidental data loss (Matt Westcott)
Setting USE_THOUSAND_SEPARATOR = True no longer breaks the rendering of numbers in JS code for InlinePanel (Mattias Loverot, Matt Westcott)
Images / documents pagination now preserves GET parameters (Bojan Mihelac)
Wagtail's UserProfile model now sets a related_name of wagtail_userprofile to avoid naming collisions with other user profile models (Matt Westcott)
Non-text content is now preserved when adding or editing a link within rich text (Matt Westcott)
Fixed preview when SECURE_SSL_REDIRECT = True (Aymeric Augustin)
Prevent hang when truncating an image filename without an extension (Ricky Robinett)
On projects created under previous releases of Wagtail, the home/migrations/0001_initial.py migration created by the wagtail start command contains the following dependency line:
dependencies = [
('wagtailcore', '__latest__'),
]
This may produce InconsistentMigrationHistory errors under Django 1.10 when upgrading Wagtail, since Django interprets this to mean that no new migrations can legally be added to wagtailcore after this migration is applied. This line should be changed to:
dependencies = [
('wagtailcore', '0029_unicode_slugfield_dj19'),
]
The data model for image renditions will be changed in Wagtail 1.8 to eliminate Filter as a model. Wagtail sites using a custom image model (see custom_image_model) need to have a schema and data migration in place before upgrading to Wagtail 1.8. To create these migrations:
Run manage.py makemigrations to create the schema migration
Run manage.py makemigrations --empty myapp (replacing myapp with the name of the app containing the custom image model) to create an empty migration
Edit the created migration to contain:
from wagtail.wagtailimages.utils import get_fill_filter_spec_migrations
and, for the operations list:
forward, reverse = get_fill_filter_spec_migrations('myapp', 'CustomRendition')
operations = [
migrations.RunPython(forward, reverse),
]
replacing myapp and CustomRendition with the app and model name for the custom rendition model.
The embed template filter, used to translate the URL of a media resource (such as a YouTube video) into a corresponding embeddable HTML fragment, has now been converted to a template tag. Any template code such as:
{% load wagtailembeds_tags %}
...
{{ my_media_url|embed }}
should now be rewritten as:
{% load wagtailembeds_tags %}
...
{% embed my_media_url %}
Elasticsearch 2 support (Karl Hobley)
|embed filter has been converted into a templatetag {% embed %} (Janneke Janssen)wagtailforms module now provides a FormSubmissionPanel for displaying details of form submissions (João Luiz Lorencetti)from wagtail import VERSION (Tim Heap)send_mail logic has been moved from AbstractEmailForm.process_form_submission into AbstractEmailForm.send_mail. Now it's easier to override this logic (Tim Leguijt)before_create_page, before_edit_page, before_delete_page hooks (Karl Hobley)SnippetChooserBlock now supports passing the model name as a string (Nick Smith)__latest__ migration, logically preventing those apps from receiving new migrations (Matt Westcott)InlinePanel now accepts a classname parameter as per the documentation (emg36, Matt Westcott)USE_THOUSAND_SEPARATOR = True no longer breaks the rendering of numbers in JS code for InlinePanel (Mattias Loverot, Matt Westcott)wagtail_userprofile to avoid naming collisions with other user profile models (Matt Westcott)SECURE_SSL_REDIRECT = True (Aymeric Augustin)Fix: Restore compatibility with django-debug-toolbar 1.5 (Matt Westcott)
September 30, 2016
Restore compatibility with django-debug-toolbar 1.5 (Matt Westcott)
Edits to StreamFields are no longer ignored in page edits on Django >=1.10.1 when a default value exists (Matt Westcott)
Fix: Initial values of checkboxes on group permission edit form now are visible on Django 1.10 (Matt Westcott)
September 2, 2016
Initial values of checkboxes on group permission edit form now are visible on Django 1.10 (Matt Westcott)
Fix: Wagtail's middleware classes are now compatible with Django 1.10's new-style middleware (Karl Hobley)
Pages.can_create_at method is now checked in the create page view (Mikalai Radchuk)ManifestStaticFilesStorage (Matt Westcott)WAGTAIL_ALLOW_UNICODE_SLUGS setting to make Unicode support optional in page slugs (Matt Westcott)Pages.can_create_at method is now checked in the create page view (Mikalai Radchuk)ManifestStaticFilesStorage (Matt Westcott)August 26, 2016
Added WAGTAIL_ALLOW_UNICODE_SLUGS setting to make Unicode support optional in page slugs (Matt Westcott)
Wagtail's middleware classes are now compatible with Django 1.10's new-style middleware (Karl Hobley)
The ~wagtail.models.AbstractPage.can_create_at method is now checked in the create page view (Mikalai Radchuk)
Fixed regression on Django 1.10.1 causing Page subclasses to fail to use PageManager (Matt Westcott)
ChoiceBlocks with lazy translations as option labels no longer break Elasticsearch indexing (Matt Westcott)
The page editor no longer fails to load JavaScript files with ManifestStaticFilesStorage (Matt Westcott)
Django 1.10 enables client-side validation for all forms by default, but it fails to handle all the nuances of how forms are used in Wagtail. The client-side validation has been disabled for the Wagtail UI (Matt Westcott)
The inheritance rules for custom_page_managers have been updated to match Django's standard behaviour. In the vast majority of scenarios there will be no change. However, in the specific case where a page model with a custom objects manager is subclassed further, the subclass will be assigned a plain Manager instead of a PageManager, and will now need to explicitly override this with a PageManager to function correctly:
class EventPage(Page):
objects = EventManager()
class SpecialEventPage(EventPage):
# Previously SpecialEventPage.objects would be set to a PageManager automatically;
# this now needs to be set explicitly
objects = PageManager()
Fix: Removed alignment options (deprecated in HTML and not rendered by Wagtail) from TableBlock context menu (Moritz Pfeiffer)
include_block template tag for improved StreamField template inclusion (Matt Westcott, Mikalai Radchuk)FieldRowPanel now creates equal-width columns automatically if col* classnames are not specified (Chris Rogers)search_fields are defined on the model (Josh Schneier)wagtailforms.models.AbstractEmailForm now supports multiple email recipients (Serafeim Papastefanos)STATICFILES_STORAGE (Jonny Scholes)TableBlock context menu (Moritz Pfeiffer)RichText values can now be correctly evaluated as booleans (Mike Dingjan, Bertrand Bordage)--schema-only flag on update_index no longer expects an argument (Karl Hobley)August 15, 2016
Wagtail is now compatible with Django 1.10. Thanks to Mikalai Radchuk and Paul J Stevens for developing this, and to Tim Graham for reviewing and additional Django core assistance.
In previous releases, the standard way of rendering the HTML content of a StreamField was through a simple variable template tag, such as {{ page.body }}. This had the drawback that any templates used in the StreamField rendering would not inherit variables from the parent template's context, such as page and request. To address this, a new template tag {% include_block page.body %} has been introduced as the new recommended way of outputting Streamfield content - this replicates the behavior of Django's {% include %} tag, passing on the full template context by default. For full documentation, see streamfield_template_rendering. This feature was developed by Matt Westcott, and additionally ported to Jinja2 (see: /reference/jinja2) by Mikalai Radchuk.
Page URL slugs can now contain Unicode characters, when using Django 1.9 or above. This feature was developed by Behzad Nategh.
The explorer sidebar menu now limits the displayed pages to the ones the logged-in user has permission for. For example, if a user has permission over the pages MegaCorp / Departments / Finance and MegaCorp / Departments / HR, then their menu will begin at "Departments". This reduces the amount of "drilling-down" the user has to do, and is an initial step towards supporting fully independent sites on the same Wagtail installation. This feature was developed by Matt Westcott and Robert Rollins, California Institute of Technology.
Image upload form in image chooser now performs client side validation so that the selected file is not lost in the submission (Jack Paine)
oEmbed URL for audioBoom was updated (Janneke Janssen)
Remember tree location in page chooser when switching between Internal / External / Email link (Matt Westcott)
FieldRowPanel now creates equal-width columns automatically if col* classnames are not specified (Chris Rogers)
Form builder now validates against multiple fields with the same name (Richard McMillan)
The 'choices' field on the form builder no longer has a maximum length (Johannes Spielmann)
Multiple ChooserBlocks inside a StreamField are now prefetched in bulk, for improved performance (Michael van Tellingen, Roel Bruggink, Matt Westcott)
Added new EmailBlock and IntegerBlock (Oktay Altay)
Added a new FloatBlock, DecimalBlock and a RegexBlock (Oktay Altay, Andy Babic)
Wagtail version number is now shown on the settings menu (Chris Rogers)
Added a system check to validate that fields listed in search_fields are defined on the model (Josh Schneier)
Added formal APIs for customizing the display of StructBlock forms within the page editor - see custom_editing_interfaces_for_structblock (Matt Westcott)
wagtailforms.models.AbstractEmailForm now supports multiple email recipients (Serafeim Papastefanos)
Added ability to delete users through Settings -> Users (Vincent Audebert; thanks also to Ludolf Takens and Tobias Schmidt for alternative implementations)
Page previews now pass additional HTTP headers, to simulate the page being viewed by the logged-in user and avoid clashes with middleware (Robert Rollins)
Added back buttons to page delete and unpublish confirmation screens (Matt Westcott)
Recognise Flickr embed URLs using HTTPS (Danielle Madeley)
Success message when publishing a page now correctly respects custom URLs defined on the specific page class (Chris Darko)
Required blocks inside StreamField are now indicated with asterisks (Stephen Rice)
Email templates and document uploader now support custom STATICFILES_STORAGE (Jonny Scholes)
Removed alignment options (deprecated in HTML and not rendered by Wagtail) from TableBlock context menu (Moritz Pfeiffer)
Fixed incorrect CSS path on ModelAdmin's "choose a parent page" view
Prevent empty redirect by overnormalization
"Remove link" button in rich text editor didn't trigger "edit" event, leading to the change to sometimes not be persisted (Matt Westcott)
RichText values can now be correctly evaluated as booleans (Mike Dingjan, Bertrand Bordage)
wagtailforms no longer assumes an .html extension when determining the landing page template filename (kakulukia)
Fixed styling glitch on bi-colour icon + text buttons in Chrome (Janneke Janssen)
StreamField can now be used in an InlinePanel (Gagaro)
StreamField block renderings using templates no longer undergo double escaping when using Jinja2 (Aymeric Augustin)
RichText objects no longer undergo double escaping when using Jinja2 (Aymeric Augustin, Matt Westcott)
Saving a page by pressing enter key no longer triggers a "Changes may not be saved message" (Sean Muck, Matt Westcott)
RoutablePageMixin no longer breaks in the presence of instance-only attributes such as those generated by FileFields (Fábio Macêdo Mendes)
The --schema-only flag on update_index no longer expects an argument (Karl Hobley)
Added file handling to support custom user add/edit forms with images/files (Eraldo Energy)
Placeholder text in modeladmin search now uses the correct template variable (Adriaan Tijsseling)
Fixed bad SQL syntax for updating URL paths on Microsoft SQL Server (Jesse Legg)
Added workaround for Django 1.10 bug https://code.djangoproject.com/ticket/27037 causing forms with file upload fields to fail validation (Matt Westcott)
There are some changes in the wagtailforms.models.AbstractFormField model:
The choices field has been changed from a CharField to a TextField, to allow it to be of unlimited length;
The help text for the to_address field has been changed: it now gives more information on how to specify multiple addresses.
These changes require migration. If you are using the wagtailforms module in your project, you will need to run python manage.py makemigrations and python manage.py migrate after upgrading, to apply changes to your form page models.
The mixin class wagtail.wagtailadmin.taggable.TagSearchable, used internally by image and document models, has been deprecated. If you are using custom image or document models in your project, the migration(s) which created them will contain frozen references to wagtail.wagtailadmin.taggable.TagSearchable, which must now be removed. The line:
import wagtail.wagtailadmin.taggable
should be replaced by:
import wagtail.wagtailsearch.index
and the line:
bases=(models.Model, wagtail.wagtailadmin.taggable.TagSearchable),
should be updated to:
bases=(models.Model, wagtail.wagtailsearch.index.Indexed),
The render and render_basic methods on wagtail.wagtailcore.blocks.Block have been updated to accept an optional context keyword argument, a template context to use when rendering the block. If you have defined any custom StreamField blocks that override either of these methods, the method signature now needs to be updated to include this keyword argument:
class MyBlock(Block):
def render(self, value):
...
def render_basic(self, value):
...
should now become:
class MyBlock(Block):
def render(self, value, context=None):
...
def render_basic(self, value, context=None):
...
Fix: Removed alignment options (deprecated in HTML and not rendered by Wagtail) from TableBlock context menu (Moritz Pfeiffer)
include_block template tag for improved StreamField template inclusion (Matt Westcott, Mikalai Radchuk)FieldRowPanel now creates equal-width columns automatically if col* classnames are not specified (Chris Rogers)search_fields are defined on the model (Josh Schneier)wagtailforms.models.AbstractEmailForm now supports multiple email recipients (Serafeim Papastefanos)STATICFILES_STORAGE (Jonny Scholes)TableBlock context menu (Moritz Pfeiffer)RichText values can now be correctly evaluated as booleans (Mike Dingjan, Bertrand Bordage)--schema-only flag on update_index no longer expects an argument (Karl Hobley)Fix: Pin html5lib to version 0.999999 to prevent breakage caused by internal API changes (Liam Brenner)
July 18, 2016
Pin html5lib to version 0.999999 to prevent breakage caused by internal API changes (Liam Brenner)
Fixed regression in 1.5.1 on editing external links (Stephen Rice)
June 8, 2016
Fixed regression in 1.5.1 on editing external links (Stephen Rice)
Fix: When editing a document link in rich text, the document ID is no longer erroneously interpreted as a page ID (Stephen Rice)
June 7, 2016
When editing a document link in rich text, the document ID is no longer erroneously interpreted as a page ID (Stephen Rice)
Removing embedded media from rich text by mouse click action now gets correctly registered as a change to the field (Loic Teixeira)
Rich text editor is no longer broken in InlinePanels (Matt Westcott, Gagaro)
Rich text editor is no longer broken in settings (Matt Westcott)
Link tooltip now shows correct urls for newly inserted document links (Matt Westcott)
Now page chooser (in a rich text editor) opens up at the link's parent page, rather than at the page itself (Matt Westcott)
Reverted fix for explorer menu scrolling with page content, as it blocked access to menus that exceed screen height
Image listing in the image chooser no longer becomes unpaginated after an invalid upload form submission (Stephen Rice)
Confirmation message on the ModelAdmin delete view no longer errors if the model's string representation depends on the primary key (Yannick Chabbert)
Applied correct translation tags for 'permanent' / 'temporary' labels on redirects (Matt Westcott)
Eliminated the deprecated register.assignment_tag on Django 1.9 (Josh Schneier)
register_page_listing_buttons for adding action buttons to the page explorersettings template tag (Tim Heap)insert_global_admin_js for inserting custom JavaScript throughout the admin backend (Tom Dyson)www prefix (Matt Westcott)search_fields attribute on Page models (and other searchable models) has changed from a tuple to a list (Tim Heap)PasswordChangeForm when user changes their password, requiring the user to enter their current password (Matthijs Melissen)register.assignment_tag on Django 1.9 (Josh Schneier)--schema-only option to update_index management commandStreamField blocks (Benjamin Bach)settings.dev (Tomas Olander)WAGTAIL_APPEND_SLASH setting to determine whether page URLs end in a trailing slash (Andrew Tork Baker)StreamBlock blocks (Karl Hobley)get_upload_to method to AbstractRendition which, when overridden, allows control over where image renditions are stored (Rob Moggach and Matt Westcott)Document model replaced with get_document_model function in wagtail.contrib.wagtailmedusa and in wagtail.contrib.wagtailapimultipart/form-data where appropriate (Tim Heap)decorate_urlpatterns now uses functools.update_wrapper to keep view names and docstrings (Mario César)__ alias that prevented strings getting picked up for translation (Juha Yrjölä)TypeError (Bojan Mihelac)May 1, 2016
The action buttons on the page explorer have been reorganized to reduce clutter, and lesser-used actions have been moved to a "More" dropdown. A new hook register_page_listing_buttons has been added for adding custom action buttons to the page explorer.
Wagtail now includes an app wagtail.contrib.modeladmin (previously available separately as the wagtailmodeladmin package) which allows you to configure arbitrary Django models to be listed, added and edited through the Wagtail admin.
This feature was developed by Andy Babic.
TableBlock, a new StreamField block type for editing table-based content, is now available through the wagtail.contrib.table_block module.
See /reference/contrib/table_block for documentation. This feature was developed by Moritz Pfeiffer, David Seddon and Brad Busenius.
The user experience around inserting, editing and removing links inside rich text areas has been greatly improved: link destinations are shown as tooltips, and existing links can be edited as well as unlinked. This feature was developed by Loic Teixeira.
using_images_outside_wagtail
This view, which is used for requesting image thumbnails from an external app, has had some improvements made to it in this release.
A "redirect" action has been added which will redirect the user to where the resized image is hosted rather than serving it from the app. This may be beneficial for performance if the images are hosted externally (eg, S3)
It now takes an optional extra path component which can be used for appending a filename to the end of the URL
The key is now configurable on the view so you don't have to use your project's SECRET_KEY
It's been refactored into a class based view and you can now create multiple serve views with different image models and/or keys
It now supports serving image files using django-sendfile (Thanks to Yannick Chabbert for implementing this)
Password reset email now reminds the user of their username (Matt Westcott)
Added jinja2 support for the settings template tag (Tim Heap)
Added 'revisions' action to pages list (Roel Bruggink)
Added a hook insert_global_admin_js for inserting custom JavaScript throughout the admin backend (Tom Dyson)
Recognise instagram embed URLs with www prefix (Matt Westcott)
The type of the search_fields attribute on Page models (and other searchable models) has changed from a tuple to a list (see upgrade consideration below) (Tim Heap)
Use PasswordChangeForm when user changes their password, requiring the user to enter their current password (Matthijs Melissen)
Highlight current day in date picker (Jonas Lergell)
Eliminated the deprecated register.assignment_tag on Django 1.9 (Josh Schneier)
Increased size of Save button on site settings (Liam Brenner)
Optimised Site.find_for_request to only perform one database query (Matthew Downey)
Notification messages on creating / editing sites now include the site name if specified (Chris Rogers)
Added --schema-only option to update_index management command
Added meaningful default icons to StreamField blocks (Benjamin Bach)
Added title text to action buttons in the page explorer (Liam Brenner)
Changed project template to explicitly import development settings via settings.dev (Tomas Olander)
Improved L10N and I18N for revisions list (Roel Bruggink)
The multiple image uploader now displays details of server errors (Nigel Fletton)
Added WAGTAIL_APPEND_SLASH setting to determine whether page URLs end in a trailing slash - see append_slash (Andrew Tork Baker)
Added auto resizing text field, richtext field, and snippet chooser to styleguide (Liam Brenner)
Support field widget media inside StreamBlock blocks (Karl Hobley)
Spinner was added to Save button on site settings (Liam Brenner)
Added success message after logout from Admin (Liam Brenner)
Added get_upload_to method to AbstractRendition which, when overridden, allows control over where image renditions are stored (Rob Moggach and Matt Westcott)
Added a mechanism to customize the add / edit user forms for custom user models - see /advanced_topics/customization/custom_user_models (Nigel Fletton)
Added internal provision for swapping in alternative rich text editors (Karl Hobley)
The currently selected day is now highlighted only in the correct month in date pickers (Jonas Lergell)
Fixed crash when an image without a source file was resized with the "dynamic serve view"
Registered settings admin menu items now show active correctly (Matthew Downey)
Direct usage of Document model replaced with get_document_model function in wagtail.contrib.wagtailmedusa and in wagtail.contrib.wagtailapi
Failures on sending moderation notification emails now produce a warning, rather than crashing the admin page outright (Matt Fozard)
All admin forms that could potentially include file upload fields now specify multipart/form-data where appropriate (Tim Heap)
REM units in Wagtailuserbar caused incorrect spacing (Vincent Audebert)
Explorer menu no longer scrolls with page content (Vincent Audebert)
decorate_urlpatterns now uses functools.update_wrapper to keep view names and docstrings (Mario César)
StreamField block controls are no longer hidden by the StreamField menu when prepending a new block (Vincent Audebert)
Removed invalid use of __ alias that prevented strings getting picked up for translation (Juha Yrjölä)
Routable pages without a main view no longer raise a TypeError (Bojan Mihelac)
Fixed UnicodeEncodeError in wagtailforms when downloading a CSV for a form containing non-ASCII field labels on Python 2 (Mikalai Radchuk)
Server errors during search indexing on creating / updating / deleting a model are now logged, rather than causing the overall operation to fail (Karl Hobley)
Objects are now correctly removed from search indexes on deletion (Karl Hobley)
The Wagtail admin CSS has been refactored for maintainability, and buttons now require an explicit button class. (Previously, the styles were applied on all inputs of type "submit", "reset" or "button".) If you have created any apps that extend the Wagtail admin with new views / templates, you will need to add this class to all buttons.
On searchable models (eg, Page or custom Image models) the search_fields attribute should now be a list instead of a tuple.
For example, the following Page model:
class MyPage(Page):
...
search_fields = Page.search_fields + (
indexed.SearchField('body'),
)
Should be changed to:
class MyPage(Page):
...
search_fields = Page.search_fields + [
indexed.SearchField('body'),
]
To ease the burden on third-party modules, adding tuples to Page.search_fields will still work. But this backwards-compatibility fix will be removed in Wagtail 1.7.
Previously, if you used the Elasticsearch backend, configured with the URLS property like:
WAGTAILSEARCH_BACKENDS = {
'default': {
'BACKEND': 'wagtail.wagtailsearch.backends.elasticsearch',
'URLS': ['https://example.com/'],
}
}
Elasticsearch would not be configured to verify SSL certificates for HTTPS URLs. This has been changed so that SSL certificates are verified for HTTPS connections by default.
If you need the old behavior back, where SSL certificates are not verified for your HTTPS connection, you can configure the Elasticsearch backend with the HOSTS option, like so:
WAGTAILSEARCH_BACKENDS = {
'default': {
'BACKEND': 'wagtail.wagtailsearch.backends.elasticsearch',
'HOSTS': [{
'host': 'example.com'
'use_ssl': True,
'verify_certs': False,
}],
}
}
See the Elasticsearch-py documentation for more configuration options.
In previous releases, the project template's settings/__init__.py file was set up to import the development settings (settings/dev.py), so that these would be picked up as the default (i.e. whenever a settings module was not specified explicitly). However, in some setups this meant that the development settings were being inadvertently imported in production mode.
For this reason, the import in settings/__init__.py has now been removed, and commands must now specify myproject.settings.dev or myproject.settings.production as appropriate; the supporting scripts (such as manage.py) have been updated accordingly. As this is a change to the project template, existing projects are not affected; however, if you have any common scripts or configuration files that rely on importing myproject.settings as the settings module, these will need to be updated to work on projects created under Wagtail 1.5.
Eliminated the deprecated register.assignment_tag on Django 1.9 (Josh Schneier)
register_page_listing_buttons for adding action buttons to the page explorersettings template tag (Tim Heap)insert_global_admin_js for inserting custom JavaScript throughout the admin backend (Tom Dyson)www prefix (Matt Westcott)search_fields attribute on Page models (and other searchable models) has changed from a tuple to a list (Tim Heap)PasswordChangeForm when user changes their password, requiring the user to enter their current password (Matthijs Melissen)register.assignment_tag on Django 1.9 (Josh Schneier)--schema-only option to update_index management commandStreamField blocks (Benjamin Bach)settings.dev (Tomas Olander)WAGTAIL_APPEND_SLASH setting to determine whether page URLs end in a trailing slash (Andrew Tork Baker)StreamBlock blocks (Karl Hobley)get_upload_to method to AbstractRendition which, when overridden, allows control over where image renditions are stored (Rob Moggach and Matt Westcott)Document model replaced with get_document_model function in wagtail.contrib.wagtailmedusa and in wagtail.contrib.wagtailapimultipart/form-data where appropriate (Tim Heap)decorate_urlpatterns now uses functools.update_wrapper to keep view names and docstrings (Mario César)__ alias that prevented strings getting picked up for translation (Juha Yrjölä)TypeError (Bojan Mihelac)Fix: Pin html5lib to version 0.999999 to prevent breakage caused by internal API changes (Liam Brenner)
July 18, 2016
Pin html5lib to version 0.999999 to prevent breakage caused by internal API changes (Liam Brenner)
Fix: Paste / drag operations done entirely with the mouse are now correctly picked up as edits within the rich text editor (Matt Fozard)
May 19, 2016
Paste / drag operations done entirely with the mouse are now correctly picked up as edits within the rich text editor (Matt Fozard)
Logic for canceling the "unsaved changes" check on form submission has been fixed to work cross-browser (Stephen Rice)
The "unsaved changes" confirmation was erroneously shown on IE / Firefox when previewing a page with validation errors (Matt Westcott)
The up / down / delete controls on the "Promoted search results" form no longer trigger a form submission (Matt Westcott)
Opening preview window no longer performs user-agent sniffing, and now works correctly on IE11 (Matt Westcott)
Tree paths are now correctly assigned when previewing a newly-created page underneath a parent with deleted children (Matt Westcott)
Added BASE_URL setting back to project template
Clearing the search box in the page chooser now returns the user to the browse view (Matt Westcott)
The above fix also fixed an issue where Internet Explorer got stuck in the search view upon opening the page chooser (Matt Westcott)
New translation for Slovenian (Mitja Pagon)
wagtailuserbar template tag now gracefully handles situations where the request object is not in the template context (Matt Westcott)ALLOWED_HOSTS = ['*'] (Robert Rollins)MESSAGE_TAGS in project settings no longer causes messages in the Wagtail admin to lose their styling (Tim Heap)May 10, 2016
New translation for Slovenian (Mitja Pagon)
The wagtailuserbar template tag now gracefully handles situations where the request object is not in the template context (Matt Westcott)
Meta classes on StreamField blocks now handle multiple inheritance correctly (Tim Heap)
Now user can upload images / documents only into permitted collection from choosers
Keyboard shortcuts for save / preview on the page editor no longer incorrectly trigger the "unsaved changes" message (Jack Paine / Matt Westcott)
Redirects no longer fail when both a site-specific and generic redirect exist for the same URL path (Nick Smith, João Luiz Lorencetti)
Wagtail now checks that Group is registered with the Django admin before unregistering it (Jason Morrison)
Previewing inaccessible pages no longer fails with ALLOWED_HOSTS = ['*'] (Robert Rollins)
The submit button 'spinner' no longer activates if the form has client-side validation errors (Jack Paine, Matt Westcott)
Overriding MESSAGE_TAGS in project settings no longer causes messages in the Wagtail admin to lose their styling (Tim Heap)
Border added around explorer menu to stop it blending in with StreamField block listing; also fixes invisible explorer menu in Firefox 46 (Alex Gleason)
Fixed regression introduced in 1.4.2 which caused Wagtail to query the database during a system check (Tim Heap)
April 4, 2016
Fixed regression introduced in 1.4.2 which caused Wagtail to query the database during a system check (Tim Heap)
Fix: Streamfields no longer break on validation error
wagtail.wagtailadmin.wagtail_hooks no longer calls static during app load, so you can use ManifestStaticFilesStorage without calling the collectstatic commandPage edit handler has been specified using the edit_handler attribute (Tim Heap)March 1, 2016
Streamfields no longer break on validation error
Number of validation errors in each tab in the editor is now correctly reported again
Userbar now opens on devices with both touch and mouse (Josh Barr)
wagtail.wagtailadmin.wagtail_hooks no longer calls static during app load, so you can use ManifestStaticFilesStorage without calling the collectstatic command
Fixed crash on page save when a custom Page edit handler has been specified using the edit_handler attribute (Tim Heap)
Fix: Fixed erroneous rendering of up arrow icons (Rob Moorman)
March 17, 2016
Fixed erroneous rendering of up arrow icons (Rob Moorman)
Added support for viewing previous revisions of pages, and previewing or rolling back to earlier versions
Document model can now be overridden using the new WAGTAILDOCS_DOCUMENT_MODEL setting (Alex Gleason)edit_handler property (Mikalai Radchuk)insert_global_admin_css for inserting custom CSS throughout the admin backend (Tom Dyson)construct_explorer_page_queryset for customising the set of pages displayed in the page explorerPage model now has two new methods get_site() and get_url_parts() to aid with customising the page URL generation logicconstruct_homepage_summary_items hook) now better vertically spaced (Nicolas Kuttler)StreamBlock now has provision for throwing non-field-specific validation errorsPage.path field is now explicitly given the "C" collation on PostgreSQL to prevent tree ordering issues when using a database created with the Slovak localeChooserBlock now correctly handles models with primary keys other than id (alexpilot11)RedirectMiddleware when a middleware class before SiteMiddleware returns a response (Josh Schneier)username field (Adam Bolfik)username, first_name, last_name and email fields on the user model (Eirik Krogstad)March 16, 2016
Wagtail 1.4 is designated a Long Term Support (LTS) release. Long Term Support releases will continue to receive maintenance updates as necessary to address security and data-loss related issues, up until the next LTS release (typically a period of 8 months).
From the page editing interface, editors can now access a list of previous revisions of the page, and preview or roll back to any earlier revision.
Images and documents can now be organized into collections, set up by administrators through the Settings -> Collections menu item. User permissions can be set either globally (on the 'Root' collection) or on individual collections, allowing different user groups to keep their media items separated. Thank you to the University of South Wales for sponsoring this feature.
The Wagtail userbar (which gives editors quick access to the admin from the site frontend) has been redesigned, and no longer depends on an iframe. The new design allows more flexibility in label text, more configurable positioning to avoid overlapping with site navigation, and adds a new "Show in Explorer" option. This feature was developed by Thomas Winter and Gareth Price.
The page editor interface now produces a warning if the user attempts to navigate away while there are unsaved changes.
The "Add a document" interface now supports uploading multiple documents at once, in the same way as uploading images.
The Document model can now be overridden using the new WAGTAILDOCS_DOCUMENT_MODEL setting. This works in the same way that WAGTAILIMAGES_IMAGE_MODEL works for Image.
Wagtail no longer depends on the django-compressor library. While we highly recommend compressing and bundling the CSS and JavaScript on your sites, using django-compressor places additional installation and configuration demands on the developer, so this has now been made optional.
The page search interface now searches all fields instead of just the title (Kait Crawford)
Snippets now support a custom edit_handler property; this can be used to implement a tabbed interface, for example. See customizing_the_tabbed_interface (Mikalai Radchuk)
Date/time pickers now respect the locale's 'first day of week' setting (Peter Quade)
Refactored the way forms are constructed for the page editor, to allow custom forms to be used
Notification message on publish now indicates whether the page is being published now or scheduled for publication in future (Chris Rogers)
Server errors when uploading images / documents through the chooser modal are now reported back to the user (Nigel Fletton)
Added a hook insert_global_admin_css for inserting custom CSS throughout the admin backend (Tom Dyson)
Added a hook construct_explorer_page_queryset for customizing the set of pages displayed in the page explorer
Page models now perform field validation, including testing slugs for uniqueness within a parent page, at the model level on saving
Page slugs are now auto-generated at the model level on page creation if one has not been specified explicitly
The Page model now has two new methods get_site() and get_url_parts() to aid with customizing the page URL generation logic
Upgraded jQuery to 2.2.1 (Charlie Choiniere)
Multiple homepage summary items (construct_homepage_summary_items hook) now better vertically spaced (Nicolas Kuttler)
Email notifications can now be sent in HTML format. See email_notifications (Mike Dingjan)
StreamBlock now has provision for throwing non-field-specific validation errors
Wagtail now works with Willow 0.3, which supports auto-correcting the orientation of images based on EXIF data
New translations for Hungarian, Swedish (Sweden) and Turkish
Custom page managers no longer raise an error when used on an abstract model
Wagtail's migrations are now all reversible (Benjamin Bach)
Deleting a page content type now preserves existing pages as basic Page instances, to prevent tree corruption
The Page.path field is now explicitly given the "C" collation on PostgreSQL to prevent tree ordering issues when using a database created with the Slovak locale
Wagtail's compiled static assets are now put into the correct directory on Windows (Aarni Koskela)
ChooserBlock now correctly handles models with primary keys other than id (alexpilot11)
Fixed typo in Wistia oEmbed pattern (Josh Hurd)
Added more accurate help text for the Administrator flag on user accounts (Matt Fozard)
Tags added on the multiple image uploader are now saved correctly
Documents created by a user are no longer deleted when the user is deleted
Fixed a crash in RedirectMiddleware when a middleware class before SiteMiddleware returns a response (Josh Schneier)
Fixed error retrieving the moderator list on pages that are covered by multiple moderator permission records (Matt Fozard)
Ordering pages in the explorer by reverse 'last updated' time now puts pages with no revisions at the top
WagtailTestUtils now works correctly on custom user models without a username field (Adam Bolfik)
Logging in to the admin as a user with valid credentials but no admin access permission now displays an error message, rather than rejecting the user silently
StreamBlock HTML rendering now handles non-ASCII characters correctly on Python 2 (Mikalai Radchuk)
Fixed a bug preventing pages with a OneToOneField from being copied (Liam Brenner)
SASS compilation errors during Wagtail development no longer cause exit of Gulp process, instead throws error to console and continues (Thomas Winter)
Explorer page listing now uses specific page models, so that custom URL schemes defined on Page subclasses are respected
Made settings menu clickable again in Firefox 46.0a2 (Juha Kujala)
User management index view no longer assumes the presence of username, first_name, last_name and email fields on the user model (Eirik Krogstad)
As Wagtail no longer installs django-compressor automatically as a dependency, you may need to make changes to your site's configuration when upgrading. If your project is actively using django-compressor (that is, your site templates contain {% compress %} tags), you should ensure that your project's requirements explicitly include django-compressor, rather than indirectly relying on Wagtail to install it. If you are not actively using django-compressor on your site, you should update your settings file to remove the line 'compressor' from INSTALLED_APPS, and remove 'compressor.finders.CompressorFinder' from STATICFILES_FINDERS.
In previous releases, field validation on Page models was only applied at the form level, meaning that creating pages directly at the model level would bypass validation. For example, if NewsPage is a Page model with a required body field, then code such as:
news_page = NewsPage(title="Hello", slug='hello')
parent_page = NewsIndex.objects.get()
parent_page.add_child(instance=news_page)
would create a page that does not comply with the validation rules. This is no longer possible, as validation is now enforced at the model level on save() and save_revision(); as a result, code that creates pages programmatically (such as unit tests, and import scripts) may need to be updated to ensure that it creates valid pages.
Added support for viewing previous revisions of pages, and previewing or rolling back to earlier versions
Document model can now be overridden using the new WAGTAILDOCS_DOCUMENT_MODEL setting (Alex Gleason)edit_handler property (Mikalai Radchuk)insert_global_admin_css for inserting custom CSS throughout the admin backend (Tom Dyson)construct_explorer_page_queryset for customising the set of pages displayed in the page explorerPage model now has two new methods get_site() and get_url_parts() to aid with customising the page URL generation logicconstruct_homepage_summary_items hook) now better vertically spaced (Nicolas Kuttler)StreamBlock now has provision for throwing non-field-specific validation errorsPage.path field is now explicitly given the "C" collation on PostgreSQL to prevent tree ordering issues when using a database created with the Slovak localeChooserBlock now correctly handles models with primary keys other than id (alexpilot11)RedirectMiddleware when a middleware class before SiteMiddleware returns a response (Josh Schneier)username field (Adam Bolfik)username, first_name, last_name and email fields on the user model (Eirik Krogstad)Fix: Applied workaround for failing wagtailimages migration on Django 1.8.8 / 1.9.1 with Postgres (see https://code.djangoproject.com/ticket/26034)
January 5, 2016
Applied workaround for failing wagtailimages migration on Django 1.8.8 / 1.9.1 with Postgres (see Django issue #26034)
Support for indexing fields across relations in Elasticsearch
register_admin_search_area hook to register new areas (Ben Kerle)WagtailPageTests, a helper module to simplify writing tests for Wagtail sitessubpage_types and parent_page_types attributes of page modelsWAGTAIL_PASSWORD_RESET_ENABLED setting to allow password resets to be disabled independently of the password management interface (John Draper).alt attribute to image renditionssrc, width, height and alt attributes can now be overridden by attributes passed to the {% image %} tagPage methods can_exist_under, can_create_at, can_move_to for customising page type business ruleswagtailadmin.utils.send_mail now passes extra keyword arguments to Django's send_mail function (Matthew Downey)page_unpublish signal is now fired for each page that was unpublished by a call to PageQuerySet.unpublish()get_upload_to method to AbstractImage, to allow overriding the default image upload path (Ben Emery)site_name field to sites (Timo Rieber)request.is_preview variable for templates to distinguish between previewing and live (Denis Voskvitsov){% image %} tag (Christian Peters)get_by_natural_keyPage model) now properly respects the parent_page_types settingsubpage_types / parent_page_types business rules are now enforced when moving pagesMenuItem url parameter can now take a lazy URL (Adon Metcalfe, rayrayndwiga)December 23, 2015
Wagtail is now compatible with Django 1.9.
Fields on related objects can now be indexed in Elasticsearch using the new indexed.RelatedFields declaration type:
class Book(models.Model, index.Indexed):
...
search_fields = [
index.SearchField('title'),
index.FilterField('published_date'),
index.RelatedFields('author', [
index.SearchField('name'),
index.FilterField('date_of_birth'),
]),
]
# Search books where their author was born after 1950
# Both the book title and the author's name will be searched
>>> Book.objects.filter(author__date_of_birth__gt=date(1950, 1, 1)).search("Hello")
See: wagtailsearch_index_relatedfields
The search interface in the Wagtail admin now includes a toolbar to quickly switch between different search types - pages, images, documents and users. A new register_admin_search_area hook is provided for adding new search types to this toolbar.
Added WagtailPageTests, a helper module to simplify writing tests for Wagtail sites. See /advanced_topics/testing
Added system checks to check the subpage_types and parent_page_types attributes of page models
Added WAGTAIL_PASSWORD_RESET_ENABLED setting to allow password resets to be disabled independently of the password management interface (John Draper)
Submit for moderation notification emails now include the editor name (Denis Voskvitsov)
Updated fonts for more comprehensive Unicode support
Added .alt attribute to image renditions
The default src, width, height and alt attributes can now be overridden by attributes passed to the {% image %} tag
Added keyboard shortcuts for preview and save in the page editor
Added Page methods can_exist_under, can_create_at, can_move_to for customizing page type business rules
wagtailadmin.utils.send_mail now passes extra keyword arguments to Django's send_mail function (Matthew Downey)
page_unpublish signal is now fired for each page that was unpublished by a call to PageQuerySet.unpublish()
Add get_upload_to method to AbstractImage, to allow overriding the default image upload path (Ben Emery)
Notification emails are now sent per user (Matthew Downey)
Added the ability to override the default manager on Page models
Added an optional human-friendly site_name field to sites (Timo Rieber)
Added a system check to warn developers who use a custom Wagtail build but forgot to build the admin css
Added success message after updating image from the image upload view (Christian Peters)
Added a request.is_preview variable for templates to distinguish between previewing and live (Denis Voskvitsov)
'Pages' link on site stats dashboard now links to the site homepage when only one site exists, rather than the root level
Added support for chaining multiple image operations on the {% image %} tag (Christian Peters)
New translations for Arabic, Latvian and Slovak
Images and page revisions created by a user are no longer deleted when the user is deleted (Rich Atkinson)
HTTP cache purge now works again on Python 2 (Mitchel Cabuloy)
Locked pages can no longer be unpublished (Alex Bridge)
Site records now implement get_by_natural_key
Creating pages at the root level (and any other instances of the base Page model) now properly respects the parent_page_types setting
Settings menu now opens correctly from the page editor and styleguide views
subpage_types / parent_page_types business rules are now enforced when moving pages
Multi-word tags on images and documents are now correctly preserved as a single tag (LKozlowski)
Changed verbose names to start with lower case where necessary (Maris Serzans)
Invalid images no longer crash the image listing (Maris Serzans)
MenuItem url parameter can now take a lazy URL (Adon Metcalfe, rayrayndwiga)
Added missing translation tag to InlinePanel 'Add' button (jnns)
Added missing translation tag to 'Signing in...' button text (Eugene MechanisM)
Restored correct highlighting behavior of rich text toolbar buttons
Rendering a missing image through ImageChooserBlock no longer breaks the whole page (Christian Peters)
Filtering by popular tag in the image chooser now works when using the database search backend
Due to a change in the way template tags are imported in Django 1.9, it has been necessary to move the Jinja2 template tag modules from "templatetags" to a new location, "jinja2tags". The correct configuration settings to enable Jinja2 templates are now as follows:
TEMPLATES = [
# ...
{
'BACKEND': 'django.template.backends.jinja2.Jinja2',
'APP_DIRS': True,
'OPTIONS': {
'extensions': [
'wagtail.core.jinja2tags.core',
'wagtail.wagtailadmin.jinja2tags.userbar',
'wagtail.wagtailimages.jinja2tags.images',
],
},
}
]
See: /reference/jinja2
The following internal functions and methods in wagtail.wagtailcore.models, which return a list of ContentType objects, have been deprecated. Any uses of these in your code should be replaced by the corresponding new function which returns a list of model classes instead:
get_page_types() - replaced by get_page_models()
Page.clean_subpage_types() - replaced by Page.clean_subpage_models()
Page.clean_parent_page_types() - replaced by Page.clean_parent_page_models()
Page.allowed_parent_page_types() - replaced by Page.allowed_parent_page_models()
Page.allowed_subpage_types() - replaced by Page.allowed_subpage_models()
In addition, note that these methods now return page types that are marked as is_creatable = False, including the base Page class. (Abstract models are not included, as before.)
Support for indexing fields across relations in Elasticsearch
register_admin_search_area hook to register new areas (Ben Kerle)WagtailPageTests, a helper module to simplify writing tests for Wagtail sitessubpage_types and parent_page_types attributes of page modelsWAGTAIL_PASSWORD_RESET_ENABLED setting to allow password resets to be disabled independently of the password management interface (John Draper).alt attribute to image renditionssrc, width, height and alt attributes can now be overridden by attributes passed to the {% image %} tagPage methods can_exist_under, can_create_at, can_move_to for customising page type business ruleswagtailadmin.utils.send_mail now passes extra keyword arguments to Django's send_mail function (Matthew Downey)page_unpublish signal is now fired for each page that was unpublished by a call to PageQuerySet.unpublish()get_upload_to method to AbstractImage, to allow overriding the default image upload path (Ben Emery)site_name field to sites (Timo Rieber)request.is_preview variable for templates to distinguish between previewing and live (Denis Voskvitsov){% image %} tag (Christian Peters)get_by_natural_keyPage model) now properly respects the parent_page_types settingsubpage_types / parent_page_types business rules are now enforced when moving pagesMenuItem url parameter can now take a lazy URL (Adon Metcalfe, rayrayndwiga)Fix: Project template no longer raises a deprecation warning (Maximilian Stauss)
wagtail.contrib.settings, a module to allow administrators to edit site-specific settingssearch method on their QuerySetsoperator argument to determine whether multiple terms are ORed or ANDed togetherorder_by_relevance argument, which can be set to False to preserve the original QuerySet orderingmax_num and min_num arguments to limit the number of inline itemsmax_num is reached (Salvador Faria)get_context method for passing additional variables to the block templatefirst_published_at and latest_revision_created_at fields on page models are now available as filter fields on search queriespage variable to the template (e.g. because they override the serve method)PageManager.sibling_of(page) and PageManager.not_sibling_of(page) now default to inclusive (i.e. page is considered a sibling of itself), for consistency with other sibling methods_ query parameter used by jQuery for cache-bustingNovember 12, 2015
Wagtail now includes a contrib module (previously available as the wagtailsettings package) to allow administrators to edit site-specific settings.
See: /reference/contrib/settings
The core templatetags (pageurl, slugurl, image, richtext and wagtailuserbar) are now compatible with Jinja2 so it's now possible to use Jinja2 as the template engine for your Wagtail site.
Note that the variable name self is reserved in Jinja2, and so Wagtail now provides alternative variable names where self was previously used: page to refer to page objects, and value to refer to StreamField blocks. All code examples in this documentation have now been updated to use the new variable names, for compatibility with Jinja2; however, users of the default Django template engine can continue to use self.
See: /reference/jinja2
You can now create redirects for a particular site using the admin interface.
Wagtail's image and document models now provide a search method on their QuerySets, making it easy to perform searches on filtered data sets. In addition, search methods now accept two new keyword arguments:
operator, to determine whether multiple search terms will be treated as 'or' (any term may match) or 'and' (all terms must match);
order_by_relevance, set to True (the default) to order by relevance or False to preserve the QuerySet's original ordering.
See: wagtailsearch_searching
Inline panels now accept the optional parameters max_num and min_num, to specify the maximum / minimum number of child items that must exist for the page to be valid.
See: inline_panels
StreamField blocks now provide a get_context method that can be overridden to pass additional variables to the block's template.
The Wagtail API now incorporates the browsable front-end provided by Django REST Framework. Note that this must be enabled by adding 'rest_framework' to your project's INSTALLED_APPS setting.
Wagtail now supports Python 3.5 when run in conjunction with Django 1.8.6 or later.
WagtailRedirectMiddleware can now ignore the query string if no redirect exactly matches it
Order of URL parameters now ignored by redirect middleware
Added SQL Server compatibility to image migration
Added class attributes to Wagtail rich text editor buttons to aid custom styling
Simplified body_class in default homepage template
page_published signal now called with the revision object that was published
Added a favicon to the admin interface, customizable by overriding the branding_favicon block (see custom_branding).
Added spinner animations to long-running form submissions
The EMBEDLY_KEY setting has been renamed to WAGTAILEMBEDS_EMBEDLY_KEY
StreamField blocks are now added automatically, without showing the block types menu, if only one block type exists (Alex Gleason)
The first_published_at and latest_revision_created_at fields on page models are now available as filter fields on search queries
Wagtail admin now standardizes on a single thumbnail image size, to reduce the overhead of creating multiple renditions
Rich text fields now strip out HTML comments
Page editor form now sets enctype="multipart/form-data" as appropriate, allowing FileField to be used on page models (Petr Vacha)
Explorer navigation menu on an empty page tree now takes you to the root level, rather than doing nothing
Added animation and fixed display issues when focusing a rich text field (Alex Gleason)
Added a system check to warn if Pillow is compiled without JPEG / PNG support
Page chooser now prevents users from selecting the root node where this would be invalid
New translations for Dutch (Netherlands), Georgian, Swedish and Turkish (Turkey)
Page slugs are no longer auto-updated from the page title if the page is already published
Deleting a page permission from the groups admin UI does not immediately submit the form
Wagtail userbar is shown on pages that do not pass a page variable to the template (e.g. because they override the serve method)
request.site now set correctly on page preview when the page is not in the default site
Project template no longer raises a deprecation warning (Maximilian Stauss)
PageManager.sibling_of(page) and PageManager.not_sibling_of(page) now default to inclusive (i.e. page is considered a sibling of itself), for consistency with other sibling methods
The "view live" button displayed after publishing a page now correctly reflects any changes made to the page slug (Ryan Pineo)
API endpoints now accept and ignore the _ query parameter used by jQuery for cache-busting
Page slugs are no longer cut off when Unicode characters are expanded into multiple characters (Sævar Öfjörð Magnússon)
Searching a specific page model while filtering it by either ID or tree position no longer raises an error (Ashia Zawaduk)
Scrolling an over-long explorer menu no longer causes white background to show through (Alex Gleason)
Removed jitter when hovering over StreamField blocks (Alex Gleason)
Non-ASCII email addresses no longer throw errors when generating Gravatar URLs (Denis Voskvitsov, Kyle Stratis)
Dropdown for ForeignKey s are now styled consistently (Ashia Zawaduk)
Date choosers now appear on top of StreamField menus (Sergey Nikitin)
Fixed a migration error that was raised when block-updating from 0.8 to 1.1+
wagtail.models.AbstractPage.copy no longer breaks on models with a ClusterTaggableManager or ManyToManyField
Validation errors when inserting an embed into a rich text area are now reported back to the editor
In previous versions of Wagtail, the sibling_of and not_sibling_of methods behaved inconsistently depending on whether they were called on a manager (e.g. Page.objects.sibling_of(some_page) or EventPage.objects.sibling_of(some_page)) or a QuerySet (e.g. Page.objects.all().sibling_of(some_page) or EventPage.objects.live().sibling_of(some_page)).
Previously, the manager methods behaved as exclusive by default; that is, they did not count the passed-in page object as a sibling of itself:
>>> event_1 = EventPage.objects.get(title='Event 1')
>>> EventPage.objects.sibling_of(event_1)
[<EventPage: Event 2>] # OLD behavior: Event 1 is not considered a sibling of itself
This has now been changed to be inclusive by default; that is, the page is counted as a sibling of itself:
>>> event_1 = EventPage.objects.get(title='Event 1')
>>> EventPage.objects.sibling_of(event_1)
[<EventPage: Event 1>, <EventPage: Event 2>] # NEW behavior: Event 1 is considered a sibling of itself
If the call to sibling_of or not_sibling_of is chained after another QuerySet method - such as all(), filter() or live() - behaviour is unchanged; this behaves as inclusive, as it did in previous versions:
>>> event_1 = EventPage.objects.get(title='Event 1')
>>> EventPage.objects.all().sibling_of(event_1)
[<EventPage: Event 1>, <EventPage: Event 2>] # OLD and NEW behaviour
If your project includes queries that rely on the old (exclusive) behavior, this behavior can be restored by adding the keyword argument inclusive=False:
>>> event_1 = EventPage.objects.get(title='Event 1')
>>> EventPage.objects.sibling_of(event_1, inclusive=False)
[<EventPage: Event 2>] # passing inclusive=False restores the OLD behaviour
The Image.search and Document.search methods have been deprecated in favor of the new QuerySet-based search mechanism - see wagtailsearch_images_documents_custom_models. Code using the old search methods should be updated to search on QuerySets instead; for example:
Image.search("Hello", filters={'uploaded_by_user': user})
can be rewritten as:
Image.objects.filter(uploaded_by_user=user).search("Hello")
If you have the Wagtail API (wagtail.contrib.wagtailapi) enabled, you must now add 'rest_framework' to your project's INSTALLED_APPS setting. In the current version the API will continue to function without this app, but the browsable front-end will not be available; this ability will be dropped in a future release.
If you have any application code that makes direct updates to page data, at the model or database level, be aware that the way these edits are reflected in the page editor has changed.
Previously, the get_latest_revision_as_page method - used by the page editor to return the current page revision for editing - always retrieved data from the page's revision history. Now, it will only do so if the page has unpublished changes (i.e. the page is in live + draft state) - pages that have received no draft edits since being published will return the page's live data instead.
As a result, any changes made directly to a live page object will be immediately reflected in the editor without needing to update the latest revision record (but note, the old behavior is still used for pages in live + draft state).
Fix: Project template no longer raises a deprecation warning (Maximilian Stauss)
wagtail.contrib.settings, a module to allow administrators to edit site-specific settingssearch method on their QuerySetsoperator argument to determine whether multiple terms are ORed or ANDed togetherorder_by_relevance argument, which can be set to False to preserve the original QuerySet orderingmax_num and min_num arguments to limit the number of inline itemsmax_num is reached (Salvador Faria)get_context method for passing additional variables to the block templatefirst_published_at and latest_revision_created_at fields on page models are now available as filter fields on search queriespage variable to the template (e.g. because they override the serve method)PageManager.sibling_of(page) and PageManager.not_sibling_of(page) now default to inclusive (i.e. page is considered a sibling of itself), for consistency with other sibling methods_ query parameter used by jQuery for cache-bustingspecific() method on PageQuerySet
Major features:
Minor features:
{% image %} tag now supports filters on the image variable, e.g. {% image primary_img|default:secondary_img width-500 %}wagtail.wagtailsearch.backends.elasticsearch), rather than a specific class (wagtail.wagtailsearch.backends.elasticsearch.ElasticSearch)descendant_of filter to the APIupdate_index task now indexes objects in batches of 1000, to indicate progress and avoid excessive memory usePageChooserPanel now supports passing a list (or tuple) of accepted page typesSnippetChooserPanel can now be omitted, or passed as a model name string rather than a model classself template variable to accommodate Jinja as a templating engine: page for pages, field_panel for field panels / edit handlers, and value for blocksis_creatable; pages that are abstract Django models are automatically made non-creatableBug fixes:
wagtailimages module is now compatible with remote storage backends that do not allow reopening closed filesid fieldwagtailfrontendcache module's HTTP backend has been rewritten to reliably direct requests to the configured cache hostnamesearch operations when using the database search backend now correctly preserves additional properties of the original query, such as prefetch_related / select_relatedget_context methodspecific() method on PageQuerySet, to return pages as their most specific typeATOMIC_REBUILD flag to keep the existing index available while the update_index task is runningwagtail.wagtailsearch.index.Indexed now appear as searchable within the Wagtail admin{% image %} tag now supports filters on the image variable, e.g. {% image primary_img|default:secondary_img width-500 %}wagtail.wagtailsearch.backends.elasticsearch), rather than a specific class (wagtail.wagtailsearch.backends.elasticsearch.ElasticSearch)descendant_of filter to the API (Michael Fillier)update_index task now indexes objects in batches of 1000, to indicate progress and avoid excessive memory usePageChooserPanel now supports passing a list (or tuple) of accepted page typesSnippetChooserPanel can now be omitted, or passed as a model name string rather than a model class (Joss Ingram)self template variable to accommodate Jinja as a templating engine: page for pages, field_panel for field panels / edit handlers, and value for blocksis_creatable; pages that are abstract Django models are automatically made non-creatablewagtailfrontendcache module's HTTP backend has been rewritten to reliably direct requests to the configured cache hostnameZeroDivisionError or "tile cannot extend outside image"search operations when using the database search backend now correctly preserves additional properties of the original query, such as prefetch_related / select_relatedget_context method (Christoph Lipp)September 15, 2015
Usually, an operation that retrieves a QuerySet of pages (such as homepage.get_children()) will return them as basic Page instances, which only include the core page data such as title. The specific() method (e.g. homepage.get_children().specific()) now allows them to be retrieved as their most specific type, using the minimum number of queries.
Previously, this was implemented in wagtail.wagtailsearch but now has been moved into a separate module: wagtail.contrib.wagtailsearchpromotions
The Elasticsearch search backend now accepts an experimental ATOMIC_REBUILD flag which ensures that the existing search index continues to be available while the update_index task is running. See wagtailsearch_backends_atomic_rebuild.
The wagtailapi module is now built on Django REST Framework and it now also has a library of serialisers that you can use in your own REST Framework based APIs. No user-facing changes have been made.
We hope to support more REST framework features, such as a browsable API, in future releases.
Several inconsistencies around permissions in the admin interface were fixed in this release:
Removed all permissions for "User profile" (not used)
Removed "delete" permission for Images and documents (not used)
Users can now access images and documents when they only have the "change" permission (previously required "add" permission as well)
Permissions for Users now taken from custom user model, if set (previously always used permissions on Django's builtin User model)
Groups and Users now respond consistently to their respective "add", "change" and "delete" permissions
Snippets that inherit from wagtail.wagtailsearch.index.Indexed are now given a search box on the snippet chooser and listing pages. See wagtailsnippets_making_snippets_searchable.
Implemented deletion of form submissions
Implemented pagination in the page chooser modal
Changed INSTALLED_APPS in project template to list apps in precedence order
The {% image %} tag now supports filters on the image variable, e.g. {% image primary_img|default:secondary_img width-500 %}
Moved the style guide menu item into the Settings sub-menu
Search backends can now be specified by module (e.g. wagtail.wagtailsearch.backends.elasticsearch), rather than a specific class (wagtail.wagtailsearch.backends.elasticsearch.ElasticSearch)
Added descendant_of filter to the API
Added optional directory argument to "wagtail start" command
Non-superusers can now view/edit/delete sites if they have the correct permissions
Image file size is now stored in the database, to avoid unnecessary filesystem lookups
Page URL lookups hit the cache/database less often
Updated URLs within the admin backend to use namespaces
The update_index task now indexes objects in batches of 1000, to indicate progress and avoid excessive memory use
Added database indexes on PageRevision and Image to improve performance on large sites
Search in page chooser now uses Wagtail's search framework, to order results by relevance
PageChooserPanel now supports passing a list (or tuple) of accepted page types
The snippet type parameter of SnippetChooserPanel can now be omitted, or passed as a model name string rather than a model class
Added aliases for the self template variable to accommodate Jinja as a templating engine: page for pages, field_panel for field panels / edit handlers, and value for blocks
Added signposting text to the explorer to steer editors away from creating pages at the root level unless they are setting up new sites
"Clear choice" and "Edit this page" buttons are no longer shown on the page field of the group page permissions form
Altered styling of stream controls to be more like all other buttons
Added ability to mark page models as not available for creation using the flag is_creatable; pages that are abstract Django models are automatically made non-creatable
New translations for Norwegian Bokmål and Icelandic
Text areas in the non-default tab of the page editor now resize to the correct height
Tabs in "insert link" modal in the rich text editor no longer disappear (Tim Heap)
H2 elements in rich text fields were accidentally given a click() binding when put insite a collapsible multi field panel
The wagtailimages module is now compatible with remote storage backends that do not allow reopening closed files
Search no longer crashes when auto-indexing a model that doesn't have an id field
The wagtailfrontendcache module's HTTP backend has been rewritten to reliably direct requests to the configured cache hostname
Resizing single pixel images with the "fill" filter no longer raises ZeroDivisionError or "tile cannot extend outside image"
The QuerySet returned from search operations when using the database search backend now correctly preserves additional properties of the original query, such as prefetch_related / select_related
Responses from the external image URL generator are correctly marked as streaming and will no longer fail when used with Django's cache middleware
Page copy now works with pages that use multiple inheritance
Form builder pages now pick up template variables defined in the get_context method
When copying a page, IDs of child objects within page revision records were not remapped to the new objects; this would cause those objects to be lost from the original page when editing the new one
Newly added redirects now take effect on all sites, rather than just the site that the Wagtail admin backend was accessed through
Add user form no longer throws a hard error on validation failure
This feature has moved into a contrib module so is no longer enabled by default.
To re-enable it, add wagtail.contrib.wagtailsearchpromotions to your INSTALLED_APPS:
INSTALLED_APPS = [
...
'wagtail.contrib.wagtailsearchpromotions',
...
If you have references to the wagtail.wagtailsearch.models.EditorsPick model in your project, you will need to update these to point to the wagtail.contrib.wagtailsearchpromotions.models.SearchPromotion model instead.
If you created your project using the wagtail start command with Wagtail 1.0, you will probably have references to this model in the search/views.py file.
Previous versions of Wagtail provided an undocumented is_abstract flag on page models - not to be confused with Django's abstract Meta flag - to indicate that it should not be included in the list of available page types for creation. (Typically this would be used on model classes that were designed to be subclassed to create new page types, rather than used directly.) To avoid confusion with Django's distinct concept of abstract models, this has now been replaced by a new flag, is_creatable.
If you have used is_abstract = True on any of your models, you should now change this to is_creatable = False.
It is not necessary to include this flag if the model is abstract in the Django sense (i.e. it has abstract = True in the model's Meta class), since it would never be valid to create pages of that type.
One column per quarter.