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.
Implemented the specific() method on PageQuerySet, to return pages as their most specific type
specific() 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 hostnamesearch 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)Your coding agent can read these notes before it upgrades. Set up the MCP server →
StreamField, a model field for freeform page content
Major features:
Minor features:
django.contrib.auth.admin.login will no longer lead to Wagtails login view (making it easier to have front end views)LOGIN_URL and LOGIN_REDIRECT_URL settingsdocument_served signal now correctly passes the Document class as sender and the document as instancefirst_published_atregister_rich_text_embed_handler and register_rich_text_link_handler for customising link / embed handling within rich text fieldsconstruct_homepage_summary_items for customising the site summary panel on the admin homepageconstruct_wagtail_edit_bird hook to construct_wagtail_userbarAUTO_UPDATE flag to search backend settings to enable/disable automatically updating the search index on model changeswith_metaclass is now imported from Django's bundled copy of the six library, to avoid errors on Mac OS X from an outdated system copy of the library being importedJuly 16, 2015
StreamField provides an editing model for freeform content such as blog posts and news stories, allowing diverse content types such as text, images, headings, video and more specialized types such as maps and charts to be mixed in any order. See streamfield_topic.
When installed, the new Wagtail API module provides a RESTful web API to your Wagtail site. You can use this for accessing your raw field content for your sites pages, images and documents in JSON format.
Wagtail now officially supports MySQL as a database backend.
Wagtail now officially supports running under Django 1.8.
The built-in project template is more like the Django built-in one with several Wagtail-specific additions. It includes bare minimum settings and two apps (home and search).
Dropped Django 1.6 support
Dropped Python 2.6 and 3.2 support
Dropped Elasticsearch 0.90.x support
Removed dependency on libsass
Users without usernames can now be created and edited in the admin interface
Added new translations for Croatian and Finnish
The Page model now records the date/time that a page was first published, as the field first_published_at
Increased the maximum length of a page slug from 50 to 255 characters
Added hooks register_rich_text_embed_handler and register_rich_text_link_handler for customizing link / embed handling within rich text fields
Page URL paths can now be longer than 255 characters
UI
Improvements to the layout of the left-hand menu footer
Menu items of custom apps are now highlighted when being used
Added thousands separator for counters on dashboard
Added contextual links to admin notification messages
When copying pages, it is now possible to specify a place to copy to
Added pagination to the snippets listing and chooser
Page / document / image / snippet choosers now include a link to edit the chosen item
Plain text fields in the page editor now use auto-expanding text areas
Added "Add child page" button to admin userbar
Added update notifications (See: update_notifications)
Page editor
JavaScript includes in the admin backend have been moved to the HTML header, to accommodate form widgets that render inline scripts that depend on libraries such as jQuery
The external link chooser in rich text areas now accepts URLs of the form '/some/local/path', to allow linking to non-Wagtail-controlled URLs within the local site
Bare text entered in rich text areas is now automatically wrapped in a paragraph element
Edit handlers API
FieldPanel now accepts an optional widget parameter to override the field's default form widget
Page model fields without a FieldPanel are no longer displayed in the form
No longer need to specify the base model on InlinePanel definitions
Page classes can specify an edit_handler property to override the default Content / Promote / Settings tabbed interface. See customizing_the_tabbed_interface.
Other admin changes
SCSS files in wagtailadmin now use absolute imports, to permit overriding by user stylesheets
Removed the dependency on LOGIN_URL and LOGIN_REDIRECT_URL settings
Password reset view names namespaced to wagtailadmin
Removed the need to add permission check on admin views (now automated)
Reversing django.contrib.auth.admin.login will no longer lead to Wagtails login view (making it easier to have frontend login views)
Added cache-control headers to all admin views. This allows Varnish/Squid/CDN to run on vanilla settings in front of a Wagtail site
Date / time pickers now consistently use times without seconds, to prevent JavaScript behaviour glitches when focusing / unfocusing fields
Added hook construct_homepage_summary_items for customizing the site summary panel on the admin homepage
Renamed the construct_wagtail_edit_bird hook to construct_wagtail_userbar
'static' template tags are now used throughout the admin templates, in place of STATIC_URL
Support for django-sendfile added
Documents now served with correct mime-type
Support for If-Modified-Since HTTP header
Search view accepts "page" GET parameter in line with pagination
Added wagtailsearch_backends_auto_update flag to search backend settings to enable/disable automatically updating the search index on model changes
Added a new decorator-based syntax for RoutablePage, compatible with Django 1.8
The document_served signal now correctly passes the Document class as sender and the document as instance
Image edit page no longer throws OSError when the original image is missing
Collapsible blocks stay open on any form error
Document upload modal no longer switches tabs on form errors
with_metaclass is now imported from Django's bundled copy of the six library, to avoid errors on Mac OS X from an outdated system copy of the library being imported
This release drops support for Django 1.6, Python 2.6/3.2 and Elasticsearch 0.90.x. Please make sure these are updated before upgrading.
If you are upgrading from Elasticsearch 0.90.x, you may also need to update the elasticsearch pip package to a version greater than 1.0 as well.
Starting from Wagtail 1.0, the admin dashboard will (for admin users only) perform a check to see if newer releases are available. This also provides the Wagtail team with the hostname of your Wagtail site. If you’d rather not receive update notifications, or if you’d like your site to remain unknown, you can disable it by adding this line to your settings file:
WAGTAIL_ENABLE_UPDATE_CHECK = False
In previous versions of Wagtail, inline child blocks on a page or snippet were defined using a declaration like:
InlinePanel(HomePage, 'carousel_items', label="Carousel items")
It is no longer necessary to pass the base model as a parameter, so this declaration should be changed to:
InlinePanel('carousel_items', label="Carousel items")
The old format is now deprecated; all existing InlinePanel declarations should be updated to the new format.
Django 1.8 now requires that all the fields in a ModelForm must be defined in its Meta.fields attribute.
As Wagtail uses Django's ModelForm for creating image model forms, we've added a new attribute called admin_form_fields that should be set to a tuple of field names on the image model.
See custom_image_model for an example.
If you are upgrading from an older version of Wagtail, you probably want to remove these from your project settings.
Previously, these two settings needed to be set to wagtailadmin_login and wagtailadmin_dashboard respectively or Wagtail would become very tricky to log in to. This is no longer the case and Wagtail should work fine without them.
In previous versions of Wagtail, page types that used routable_page_mixin had endpoints configured by setting their subpage_urls attribute to a list of urls with view names. This will not work on Django 1.8 as view names can no longer be passed into a url (see: https://docs.djangoproject.com/en/stable/releases/1.8/#django-conf-urls-patterns).
Wagtail 1.0 introduces a new syntax where each view function is annotated with a @route decorator - see routable_page_mixin.
The old subpage_urls convention will continue to work on Django versions before 1.8, but this is now deprecated; all existing RoutablePage definitions should be updated to the decorator-based convention.
If you were previously using the external wagtailapi module (which has now become wagtail.contrib.wagtailapi). Please be aware of the following backwards-incompatible changes:
1. Representation of foreign keys has changed
Foreign keys were previously represented by just the value of their primary key. For example:
"feed_image": 1
This has now been changed to add some meta information:
"feed_image": {
"id": 1,
"meta": {
"type": "wagtailimages.Image",
"detail_url": "https://api.example.com/api/v1/images/1/"
}
}
2. On the page detail view, the "parent" field has been moved out of meta
Previously, there was a "parent" field in the "meta" section on the page detail view:
{
"id": 10,
"meta": {
"type": "demo.BlogPage",
"parent": 2
},
...
}
This has now been moved to the top level. Also, the above change to how foreign keys are represented applies to this field too:
{
"id": 10,
"meta": {
"type": "demo.BlogPage"
},
"parent": {
"id": 2,
"meta": {
"type": "demo.BlogIndexPage"
}
}
...
}
Previously, Wagtail would try to use Celery whenever the djcelery module was installed, even if Celery wasn't set up. This could cause a very hard to track down problem where notification emails would not be sent so this functionality has now been removed.
If you would like to keep using Celery for sending notification emails, have a look at: django-celery-email
It was previously possible to reverse the Wagtail login view using django.contrib.auth.views.login. This is no longer possible. Update any references to wagtailadmin_login.
Password reset view name has changed from password_reset to wagtailadmin_password_reset.
To improve compatibility with third-party form widgets, pages within the Wagtail admin backend now output their JavaScript includes in the HTML header, rather than at the end of the page. If your project extends the admin backend (through the register_admin_menu_item hook, for example) you will need to ensure that all associated JavaScript code runs correctly from the new location. In particular, any code that accesses HTML elements will need to be contained in an 'onload' handler (e.g. jQuery's $(document).ready()).
While it is not an official Wagtail API, it has been possible for Wagtail site implementers to define their own EditHandler subclasses for use in panel definitions, to customize the behavior of the page / snippet editing forms. If you have made use of this facility, you will need to update your custom EditHandlers, as this mechanism has been refactored (to allow EditHandler classes to keep a persistent reference to their corresponding model). If you have only used Wagtail's built-in panel types (FieldPanel, InlinePanel, PageChooserPanel and so on), you are unaffected by this change.
Previously, functions like FieldPanel acted as 'factory' functions, where a call such as FieldPanel('title') constructed and returned an EditHandler subclass tailored to work on a 'title' field. These functions now return an object with a bind_to_model method instead; the EditHandler subclass can be obtained by calling this with the model class as a parameter. As a guide to updating your custom EditHandler code, you may wish to refer to the relevant change to the Wagtail codebase.
If you have added your own custom admin views to the Wagtail admin (e.g. through the register_admin_urls hook), you may have used one of the following template includes to incorporate a chooser element for pages, documents, images or snippets into your forms:
wagtailadmin/edit_handlers/chooser_panel.html
wagtailadmin/edit_handlers/page_chooser_panel.html
wagtaildocs/edit_handlers/document_chooser_panel.html
wagtailimages/edit_handlers/image_chooser_panel.html
wagtailsnippets/edit_handlers/snippet_chooser_panel.html
All of these templates are now deprecated. Wagtail now provides a set of Django form widgets for this purpose - AdminPageChooser, AdminDocumentChooser, AdminImageChooser and AdminSnippetChooser - which can be used in place of the HiddenInput widget that these form fields were previously using. The field can then be rendered using the regular wagtailadmin/shared/field.html or wagtailadmin/shared/field_as_li.html template.
Previously, the document_served signal (which is fired whenever a user downloads a document) passed the document instance as the sender. This has now been changed to correspond the behaviour of Django's built-in signals; sender is now the Document class, and the document instance is passed as the argument instance. Any existing signal listeners that expect to receive the document instance in sender must now be updated to check the instance argument instead.
Previously, the forms for creating and editing images followed Django's default behavior of showing all fields defined on the model; this would include any custom fields specific to your project that you defined by subclassing AbstractImage and setting WAGTAILIMAGES_IMAGE_MODEL. This behavior is risky as it may lead to fields being unintentionally exposed to the user, and so Django has deprecated this, for removal in Django 1.8. Accordingly, if you create your own custom subclass of AbstractImage, you must now provide an admin_form_fields property, listing the fields that should appear on the image creation / editing form - for example:
from wagtail.wagtailimages.models import AbstractImage, Image
class MyImage(AbstractImage):
photographer = models.CharField(max_length=255)
has_legal_approval = models.BooleanField()
admin_form_fields = Image.admin_form_fields + ['photographer']
Previously you could customize the Wagtail userbar using the construct_wagtail_edit_bird hook. The hook has been renamed to construct_wagtail_userbar.
The old hook is now deprecated; all existing construct_wagtail_edit_bird declarations should be updated to the new hook.
The IMAGE_COMPRESSION_QUALITY setting, which determines the quality of saved JPEG images as a value from 1 to 100, has been renamed to WAGTAILIMAGES_JPEG_QUALITY. If you have used this setting, please update your settings file accordingly.
Adjusted deprecation warnings for features deprecated in 1.0, to indicate that they will be removed in 1.2
Changes since 1.0rc1:
Users without usernames can now be created and edited in the admin interface (Tim Heap)
Changes since Beta 2:
AUTO_UPDATE flag to search backend settings to enable/disable automatically updating the search index on model changeswith_metaclass is now imported from Django's bundled copy of the six library, to avoid errors on Mac OS X from an outdated system copy of the library being importedAdded Wagtail API, a module for creating a RESTful API for your content
Changes since Beta 1:
construct_homepage_summary_items for customising the site summary panel on the admin homepageconstruct_wagtail_edit_bird hook to construct_wagtail_userbarAdded StreamField, a model field for freeform page content
django.contrib.auth.admin.login will no longer lead to Wagtails login view (making it easier to have front end views)LOGIN_URL and LOGIN_REDIRECT_URL settingsdocument_served signal now correctly passes the Document class as sender and the document as instancefirst_published_atregister_rich_text_embed_handler and register_rich_text_link_handler for customising link / embed handling within rich text fields(re-release of 0.8.9 due to packaging issues)
(re-release of 0.8.9 due to packaging issues)
September 16, 2015
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
Search no longer crashes when auto-indexing a model that doesn't have an id field (Scot Hacker)
Resizing single pixel images with the "fill" filter no longer raises ZeroDivisionError or "tile cannot extend outside image"
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
Fix: Formbuilder no longer raises TypeError when submitting unchecked boolean field
June 18, 2015
Form builder no longer raises a TypeError when submitting unchecked boolean field
Image upload form no longer breaks when using i10n thousand separators
Multiple image uploader now escapes HTML in filenames
Retrieving an individual item from a sliced BaseSearchResults object now properly takes the slice offset into account
Removed dependency on unicodecsv which fixes a crash on Python 3
Submitting unicode text in form builder form no longer crashes with UnicodeEncodeError on Python 2
Creating a proxy model from a Page class no longer crashes in the system check
Unrecognised embed URLs passed to the |embed filter no longer cause the whole page to crash with an EmbedNotFoundException
Underscores no longer get stripped from page slugs
Fix: wagtailfrontendcache no longer tries to purge pages that are not in a site
April 29, 2015
wagtailfrontendcache no longer tries to purge pages that are not in a site
The contents of <div> elements in the rich text editor were not being whitelisted
Due to the above issue, embeds/images in a rich text field would sometimes be saved into the database in their editor representation
RoutablePage now prevents subpage_urls from being defined as a property, which would cause a memory leak
Added validation to prevent pages being created with only whitespace characters in their title fields
Users are no longer logged out on changing password when SessionAuthenticationMiddleware (added in Django 1.7) is in use
Added a workaround for a Python / Django issue that prevented documents with certain non-ASCII filenames from being served
Translations updated, including new translations for Czech, Italian and Japanese
March 10, 2015
Translations updated, including new translations for Czech, Italian and Japanese
The "fixtree" command can now delete orphaned pages
django-taggit library updated to 0.12.3, to fix a bug with migrations on SQLite on Django 1.7.2 and above (https://github.com/alex/django-taggit/issues/285)
Fixed a bug that caused children of a deleted page to not be deleted if they had a different type
This release fixes a bug with page deletion introduced in 0.8, where deleting a page with child pages will result in those child pages being left behind in the database (unless the child pages are of the same type as the parent). This may cause errors later on when creating new pages in the same position. To identify and delete these orphaned pages, it is recommended that you run the following command (from the project root) after upgrading to 0.8.6:
$ ./manage.py fixtree
This will output a list of any orphaned pages found, and request confirmation before deleting them.
Since this now makes fixtree an interactive command, a ./manage.py fixtree --noinput option has been added to restore the previous non-interactive behavior. With this option enabled, deleting orphaned pages is always skipped.
Fix: On adding a new page, the available page types are ordered by the displayed verbose name
BASE_URL setting for the reset URLFebruary 17, 2015
On adding a new page, the available page types are ordered by the displayed verbose name
Active admin submenus were not properly closed when activating another
get_sitemap_urls is now called on the specific page class so it can now be overridden
(Firefox and IE) Fixed preview window hanging and not refocusing when "Preview" button is clicked again
Storage backends that return raw ContentFile objects are now handled correctly when resizing images
Punctuation characters are no longer stripped when performing search queries
When adding tags where there were none before, it is now possible to save a single tag with multiple words in it
richtext template tag no longer raises TypeError if None is passed into it
Serving documents now uses a streaming HTTP response and will no longer break Django's cache middleware
User admin area no longer fails in the presence of negative user IDs (as used by django-guardian's default settings)
Password reset emails now use the BASE_URL setting for the reset URL
BASE_URL is now included in the project template's default settings file
Fix: It is no longer possible to have the explorer and settings menu open at the same time
December 4, 2014
It is no longer possible to have the explorer and settings menu open at the same time
Page IDs in page revisions were not updated on page copy, causing subsequent edits to be committed to the original page instead
Copying a page now creates a new page revision, ensuring that changes to the title/slug are correctly reflected in the editor (and also ensuring that the user performing the copy is logged)
Prevent a race condition when creating Filter objects
On adding a new page, the available page types are ordered by the displayed verbose name
Removes a 0.9 feature that found its way into the 0.8 branch ahead of its time.
Removes a 0.9 feature that found its way into the 0.8 branch ahead of its time.
November 18, 2014
Added missing jQuery UI sprite files, causing collectstatic to throw errors (most reported on Heroku)
Page system check for on_delete actions of ForeignKeys was throwing false positives when page class descends from an abstract class (Alejandro Giacometti)
Page system check for on_delete actions of ForeignKeys now only raises warnings, not errors
Fixed a regression where form builder submissions containing a number field would fail with a JSON serialization error
Resizing an image with a focal point equal to the image size would result in a divide-by-zero error
Focal point indicator would sometimes be positioned incorrectly for small or thin images
Fix: Focal point chooser background color changed to grey to make working with transparent images easier
Elasticsearch configuration now supports specifying HTTP authentication parameters as part of the URL, and defaults to ports 80 (HTTP) and 443 (HTTPS) if port number not specified
Fixed a TypeError when previewing pages that use RoutablePageMixin
Rendering image with missing file in rich text no longer crashes the entire page
IOErrors thrown by underlying image libraries that are not reporting a missing image file are no longer caught
Fix: Minimum Pillow version bumped to 2.6.1 to work around a crash when using images with transparency
Fix: Images with transparency are now handled better when being used in feature detection
In previous versions, an Elasticsearch connection URL in WAGTAILSEARCH_BACKENDS without an explicit port number (e.g. http://localhost/) would be treated as port 9200 (the Elasticsearch default) whereas the correct behavior would be to use the default http/https port of 80/443. This behavior has now been fixed, so sites running Elasticsearch on port 9200 must now specify this explicitly - e.g. http://localhost:9200. (Projects using the default settings, or the settings given in the Wagtail documentation, are unaffected.)
Added missing jQuery UI sprite files, causing collectstatic to throw errors (most reported on Heroku)
Fixed a regression where images would fail to save when feature detection is active
November 5, 2014
Fixed a regression where images would fail to save when feature detection is active
Added logging for page operations
wagtail.wagtailsearch and wagtail.contrib.wagtailfrontendcache are now automatically registered when using Django 1.7 or above. (Tim Heap)November 5, 2014
Wagtail 0.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).
Page operations (creation, publishing, copying etc) are now logged via Python's logging framework; to configure this, add a logger entry for 'wagtail' or 'wagtail.core' to the LOGGING setup in your settings file.
The save button on the page edit page now redirects the user back to the edit page instead of the explorer
Signal handlers for wagtail.wagtailsearch and wagtail.contrib.wagtailfrontendcache are now automatically registered when using Django 1.7 or above.
Added a Django 1.7 system check to ensure that foreign keys from Page models are set to on_delete=SET_NULL, to prevent inadvertent (and tree-breaking) page deletions
Improved error reporting on image upload, including ability to set a maximum file size via a new setting WAGTAILIMAGES_MAX_UPLOAD_SIZE
The external image URL generator now keeps persistent image renditions, rather than regenerating them on each request, so it no longer requires a front-end cache.
Added Dutch translation
Replaced references of .username with .get_username() on users for better custom user model support
Unpinned dependency versions for six and requests to help prevent dependency conflicts
Fixed TypeError when getting embed HTML with oembed on Python 3
Made HTML whitelisting in rich text fields more robust at catching disallowed URL schemes such as jav\tascript:
created_at timestamps on page revisions were not being preserved on page copy, causing revisions to get out of sequence
When copying pages recursively, revisions of subpages were being copied regardless of the copy_revisions flag
Updated the migration dependencies within the project template to ensure that Wagtail's own migrations consistently apply first
The cache of site root paths is now cleared when a site is deleted
Search indexing now prevents pages from being indexed multiple times, as both the base Page model and the specific subclass
Search indexing now avoids trying to index abstract models
Fixed references to "username" in login form help text for better custom user model support
Later items in a model's search_field list now consistently override earlier items, allowing subclasses to redefine rules from the parent
Image uploader now accepts JPEG images that PIL reports as being in MPO format
Multiple checkbox fields on form-builder forms did not correctly save multiple values
Editing a page's slug and saving it without publishing could sometimes cause the URL paths of child pages to be corrupted
latest_revision_created_at was being cleared on page publish, causing the page to drop to the bottom of explorer listings
Searches on partial_match fields were wrongly applying prefix analysis to the search query as well as the document (causing e.g. a query for "water" to match against "wagtail")
This release fixes a bug in Wagtail 0.7 where editing a parent page's slug could cause the URL paths of child pages to become corrupted. To ensure that your database does not contain any corrupted URL paths, it is recommended that you run ./manage.py set_url_paths after upgrading.
Signal handlers for the wagtailsearch core app and wagtailfrontendcache contrib app are automatically registered when using Django 1.7. Calls to register_signal_handlers from your urls.py can be removed.
When using the database backend, calling search (either through Page.objects.search() or on the backend directly) will now return a SearchResults object rather than a Django QuerySet to make the database backend work more like the Elasticsearch backend.
This change shouldn't affect most people as SearchResults behaves very similarly to QuerySet. But it may cause issues if you are calling QuerySet specific methods after calling .search(). Eg: Page.objects.search("Hello").filter(foo="Bar") (in this case, .filter() should be moved before .search() and it would work as before).
If your project is running on Django 1.7, and you have defined a custom image model (by extending the wagtailimages.AbstractImage class), the migration that creates this model will probably have a reference to wagtail.wagtailimages.utils.validators.validate_image_format. This module has now been removed, which will cause manage.py migrate to fail with an ImportError (even if the migration has already been applied). You will need to edit the migration file to remove the line:
import wagtail.wagtailimages.utils.validators
and the validators attribute of the 'file' field - that is, the line:
('file', models.ImageField(upload_to=wagtail.wagtailimages.models.get_upload_to,
width_field='width', height_field='height',
validators=[wagtail.wagtailimages.utils.validators.validate_image_format],
verbose_name='File')),
should become:
('file', models.ImageField(upload_to=wagtail.wagtailimages.models.get_upload_to,
width_field='width', height_field='height', verbose_name='File')),
Added interface for choosing focal point on images
October 9, 2014
When editing images, users can now specify a 'focal point' region that cropped versions of the image will be centered on. Previously the focal point could only be set automatically, through image feature detection.
The main navigation menu has been reorganized, placing site configuration options in a 'Settings' submenu. This includes two new items, which were previously only available through the Django admin backend: 'Groups', for setting up user groups with a specific set of permissions, and 'Sites', for managing the list of sites served by this Wagtail instance.
Moderators and administrators now can lock a page, preventing further edits from being made to that page until it is unlocked again.
The content_type template filter has been removed from the project template, as the same thing can be accomplished with self.get_verbose_name|slugify.
Page copy operations now also copy the page revision history.
Page models now support a parent_page_types property in addition to subpage types, to restrict the types of page they can be created under.
register_snippet can now be invoked as a decorator.
The project template (used when running wagtail start) has been updated to Django 1.7.
The 'boost' applied to the title field on searches has been reduced from 100 to 2.
The type method of PageQuerySet (used to filter the QuerySet to a specific page type) now includes subclasses of the given page type.
The update_index management command now updates all backends listed in WAGTAILSEARCH_BACKENDS, or a specific one passed on the command line, rather than just the default backend.
The 'fill' image resize method now supports an additional parameter defining the closeness of the crop. See image_tag
Added support for invalidating Cloudflare caches. See frontend_cache_purging
Pages in the explorer can now be ordered by last updated time.
The 'wagtail start' command now works on Windows and other environments where the django-admin.py executable is not readily accessible.
The external image URL generator no longer stores generated images in Django's cache; this was an unintentional side-effect of setting cache control headers.
The Elasticsearch backend can now search QuerySets that have been filtered with an 'in' clause of a non-list type (such as a ValuesListQuerySet).
Logic around the has_unpublished_changes flag has been fixed, to prevent issues with the 'View draft' button failing to show in some cases.
It is now easier to move pages to the beginning and end of their section
Image rendering no longer creates erroneous duplicate Rendition records when the focal point is blank.
The Sites administration interface is contained within a new app, wagtailsites. To enable this on an existing Wagtail project, add the line:
'wagtail.wagtailsites',
to the INSTALLED_APPS list in your project's settings file.
Wagtail's search interface applies a 'boost' value to give extra weighting to matches on the title field. The original boost value of 100 was found to be excessive, and in Wagtail 0.7 this has been reduced to 2. If you have used comparable boost values on other fields, to give them similar weighting to title, you may now wish to reduce these accordingly. See wagtailsearch_indexing.
The page locking mechanism adds a locked field to wagtailcore.Page, defaulting to False. Any application code working with Page objects should be unaffected, but any code that creates page records using direct SQL, or within existing South migrations using South's frozen ORM, will fail as this code will be unaware of the new database column. To fix a South migration that fails in this way, add the following line to the 'wagtailcore.page' entry at the bottom of the migration file:
'locked': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
The focal_point_key field on wagtailimages.Rendition has been changed to null=False, to fix an issue with duplicate renditions being created. If you have defined a custom Rendition model in your project (by extending the wagtailimages.AbstractRendition class), you will need to apply a migration to make the corresponding change on your custom model. Unfortunately, neither South nor Django 1.7's migration system can generate this automatically - you will need to customize the migration produced by ./manage.py schemamigration / ./manage.py makemigrations, using the wagtailimages migration as a guide:
https://github.com/wagtail/wagtail/blob/stable/0.7.x/wagtail/wagtailimages/south_migrations/0004_auto__chg_field_rendition_focal_point_key.py (for South / Django 1.6)
https://github.com/wagtail/wagtail/blob/stable/0.7.x/wagtail/wagtailimages/migrations/0004_make_focal_point_key_not_nullable.py (for Django 1.7)
Added 'wagtail start' command and project template
September 11, 2014
Wagtail now has a basic project template built in to make starting new projects much easier.
To use it, install wagtail onto your machine and run wagtail start project_name.
Wagtail can now be used with Django 1.7.
A new template tag has been added for reversing URLs inside routable pages. See routablepageurl_template_tag.
RoutablePage can now be used as a mixin. See routable_page_mixin.
MenuItems can now have bundled JavaScript
Added the register_admin_menu_item hook for registering menu items at startup. See admin_hooks
Added a version indicator into the admin interface (hover over the wagtail to see it)
Added Russian translation
Page URL generation now returns correct URLs for sites that have the main 'serve' view rooted somewhere other than '/'.
Search results in the page chooser now respect the page_type parameter on PageChooserPanel.
Rendition filenames are now prevented from going over 60 chars, even with a large focal_point_key.
Child relations that are defined on a model's superclass (such as the base Page model) are now picked up correctly by the page editing form, page copy operations and the replace_text management command.
Tags on images and documents are now committed to the search index immediately on saving.
See: 04_deprecated_features
If you have an import in your urls.py file like from wagtail.wagtailsearch import register_signal_handlers, this must now be changed to from wagtail.wagtailsearch.signal_handlers import register_signal_handlers
The wagtail.wagtailsearch.indexed module has been renamed to wagtail.wagtailsearch.index
Added support for face and feature detection on images using the OpenCV library
August 1, 2014
The image uploader UI has been improved to allow multiple images to be uploaded at once.
Wagtail can now apply face and feature detection on images using OpenCV, and use this to intelligently crop images.
image_feature_detection
In normal use, Wagtail will generate resized versions of images at the point that they are referenced on a template, which means that those images are not easily accessible for use outside of Wagtail, such as displaying them on external sites. Wagtail now provides a way to obtain URLs to your images, at any size.
using_images_outside_wagtail
A RoutablePage model has been added to allow embedding Django-style URL routing within a page.
routable_page_mixin
It's now easier to find where a particular image, document or snippet is being used on your site.
Set the WAGTAIL_USAGE_COUNT_ENABLED setting to True and an icon will appear on the edit page showing you which pages they have been used on.
The explorer interface now offers the ability to copy pages, with or without subpages.
Hooks can now be defined using decorator syntax:
@hooks.register('construct_main_menu')
def construct_main_menu(request, menu_items):
menu_items.append(
MenuItem('Kittens!', '/kittens/', classnames='icon icon-folder-inverse', order=1000)
)
The lxml library (used for whitelisting and rewriting of rich text fields) has been replaced with the pure-python html5lib library, to simplify installation.
A page_unpublished signal has been added.
Explorer nav now rendered separately and fetched with AJAX when needed.
This improves the general performance of the admin interface for large sites.
Updates to tag fields are now properly committed to the database when publishing directly from the page edit interface.
If you created a Wagtail project before the release of Wagtail 0.3, it is likely to contain the following entries in its urls.py:
# TODO: some way of getting wagtailimages to register itself within wagtailadmin so that we
# don't have to define it separately here
url(r'^admin/images/', include(wagtailimages_urls)),
url(r'^admin/embeds/', include(wagtailembeds_urls)),
url(r'^admin/documents/', include(wagtaildocs_admin_urls)),
url(r'^admin/snippets/', include(wagtailsnippets_urls)),
url(r'^admin/search/', include(wagtailsearch_admin_urls)),
url(r'^admin/users/', include(wagtailusers_urls)),
url(r'^admin/redirects/', include(wagtailredirects_urls)),
These entries (and the corresponding from wagtail.wagtail* import ... lines) need to be removed from urls.py. (The entry for /admin/ should be left in, however.)
Since Wagtail 0.3, the wagtailadmin module automatically takes care of registering these URL subpaths, so these entries are redundant, and these urlconf modules are not guaranteed to remain stable and backwards-compatible in the future. Leaving these entries in place will now cause an ImproperlyConfigured exception to be thrown.
Several new fields have been added to the Image and Rendition models to support image_feature_detection. These will be added to the database when you run ./manage.py migrate. If you have defined a custom image model (by extending the wagtailimages.AbstractImage and wagtailimages.AbstractRendition classes and specifying WAGTAILIMAGES_IMAGE_MODEL in settings), the change needs to be applied to that model's database table too. Running the command:
$ ./manage.py schemamigration myapp --auto add_image_focal_point_fields
(with 'myapp' replaced with your app name) will generate the necessary migration file.
In preparation for Django 1.7 support in a future release, Wagtail now depends on South 1.0, and its migration files have been moved from migrations to south_migrations. Older versions of South will fail to find the migrations in the new location.
If your project's requirements file (most commonly requirements.txt or requirements/base.txt) references a specific older version of South, this must be updated to South 1.0.
ElasticSearch backend now respects the backward-compatible URLS configuration setting, in addition to HOSTS
July 14, 2014
Elasticsearch backend now respects the backward-compatible URLS configuration setting, in addition to HOSTS
Documentation fixes
ElasticUtils/pyelasticsearch swapped for elasticsearch-py
search method to PageQuerySetget_indexed_objects allowing developers to customise which objects get added to the search indexmatch instead of query_string queriesJuly 10, 2014
Wagtail now supports password protecting pages on the frontend, allowing sections of your website to be made private.
private_pages
Wagtail now supports Python 3.2, 3.3 and 3.4.
Editors can now schedule pages to be published or unpublished at specified times.
A new management command has been added (publish_scheduled_pages) to publish pages that have been scheduled by an editor.
It's now possible to perform searches with Elasticsearch on PageQuerySet objects:
>>> from wagtail.core.models import Page
>>> Page.objects.live().descendant_of(events_index).search("Hello")
[<Page: Event 1>, <Page: Event 2>]
A new module has been added (wagtail.contrib.wagtailsitemaps) which produces XML sitemaps for Wagtail sites.
sitemap_generation
A new module has been added (wagtail.contrib.wagtailfrontendcache) which invalidates pages in a frontend cache when they are updated or deleted in Wagtail.
frontend_cache_purging
Users can now decide which notifications they receive from Wagtail using a new "Notification preferences" section located in the account settings.
Any extra arguments given to Page.serve are now passed through to get_context and get_template
Added in_menu and not_in_menu methods to PageQuerySet
Added search method to PageQuerySet
Added get_next_siblings and get_prev_siblings to Page
Added page_published signal
Added copy method to Page to allow copying of pages
Added construct_whitelister_element_rules hook for customizing the HTML whitelist used when saving RichText fields
Support for setting a subpage_types property on Page models, to define which page types are allowed as subpages
Removed the "More" section from the menu
Added pagination to page listings
Added a new datetime picker widget
Updated hallo.js to version 1.0.4
Aesthetic improvements to preview experience
Login screen redirects to dashboard if user is already logged in
Snippets are now ordered alphabetically
Added init_new_page signal
Added a new way to configure searchable/filterable fields on models
Added get_indexed_objects allowing developers to customize which objects get added to the search index
Major refactor of Elasticsearch backend
Use match instead of query_string queries
Fields are now indexed in Elasticsearch with their correct type
Filter fields are no longer included in _all
Fields with partial matching are now indexed together into _partials
Added original as a resizing rule supported by the {% image %} tag
image tag now accepts extra keyword arguments to be output as attributes on the img tag
Added an attrs property to image rendition objects to output src, width, height and alt attributes all in one go
Added styleguide, for Wagtail developers
Animated GIFs are now coalesced before resizing
The Wand backend clones images before modifying them
The admin breadcrumb is now positioned correctly on mobile
The page chooser breadcrumb now updates the chooser modal instead of linking to Explorer
Embeds - fixed crash when no HTML field is sent back from the embed provider
Multiple sites with same hostname but different ports are now allowed
It is no longer possible to create multiple sites with is_default_site = True
If you are using the Elasticsearch backend, you must install the elasticsearch module into your environment.
Note
If you are using an older version of Elasticsearch (< 1.0) you must install elasticsearch version 0.4.x.
The scheduled publishing mechanism adds an expired field to wagtailcore.Page, defaulting to False. Any application code working with Page objects should be unaffected, but any code that creates page records using direct SQL, or within existing South migrations using South's frozen ORM, will fail as this code will be unaware of the expired database column. To fix a South migration that fails in this way, add the following line to the 'wagtailcore.page' entry at the bottom of the migration file:
'expired': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
The following template tag libraries have been renamed:
pageurl => wagtailcore_tags
rich_text => wagtailcore_tags
embed_filters => wagtailembeds_tags
image_tags => wagtailimages_tags
The old names will continue to work, but output a DeprecationWarning - you are advised to update any {% load %} tags in your templates to refer to the new names.
indexed_fields is now deprecated and has been replaced by a new search field configuration format called search_fields. See wagtailsearch_indexing for how to define a search_fields property on your models.
Previously, the route method called serve and returned an HttpResponse object. This has now been split up so serve is called separately and route must now return a RouteResult object.
If you are overriding Page.route on any of your page models, you will need to update the method to return a RouteResult object. The old method of returning an HttpResponse will continue to work, but this will throw a DeprecationWarning and bypass the before_serve_page hook, which means in particular that private_pages will not work on those page types. See overriding_route_method.
If you use any wagtail_hooks.py files in your project, you may have an import like: from wagtail.wagtailadmin import hooks
Change this to: from wagtail.core import hooks
Page.show_as_mode replaced with Page.serve_preview
Page.get_page_modes method replaced with Page.preview_modes property
Page.get_other_siblings replaced with Page.get_siblings(inclusive=False)
Fix: When constructing dummy requests for pages with no routable URL, fall back on a hostname from ALLOWED_HOSTS and finally 'localhost', to avoid 'In
Added toolbar to allow logged-in users to add and edit pages from the site front-end
Internationalisation of the admin backend
* Initial release.
One column per quarter.