2023-07-18 16:14:16 +00:00
# Wagtail 5.2 release notes - IN DEVELOPMENT
_Unreleased_
```{contents}
---
local:
depth: 1
---
```
## What's new
### Other features
2022-11-03 17:35:17 +00:00
* Add [`wagtailcache` ](wagtailcache ) and [`wagtailpagecache` ](wagtailpagecache ) template tags to ensure previewing Pages or Snippets will not be cached (Jake Howard)
2023-07-12 09:21:59 +00:00
* Always set help text element ID for form fields with help text in `field.html` template (Sage Abdullah)
2023-08-16 10:40:28 +00:00
* Move `SnippetViewSet` menu registration mechanism to base `ViewSet` class (Sage Abdullah)
* Enable reference index tracking for models registered with `ModelViewSet` (Sage Abdullah)
2023-08-18 17:28:20 +00:00
* When copying a page or creating an alias, copy its view restrictions to the destination (Sandeep Choudhary, Suyash Singh)
2023-07-08 04:30:20 +00:00
* Support pickling of StreamField values (pySilver)
2023-08-22 16:14:44 +00:00
* Move `SnippetViewSet` template override mechanism to `ModelViewSet` (Sage Abdullah)
* Move `SnippetViewSet.list_display` to `ModelViewSet` (Sage Abdullah)
2023-08-23 20:51:35 +00:00
* Remove `wagtail.publish` log action on aliases when they are created from live source pages or the source page is published (Dan Braghis)
* Remove `wagtail.unpublish` log action on aliases when source page is unpublished (Dan Braghis)
2023-08-24 10:02:47 +00:00
* Add compare buttons to workflow dashboard panel (Matt Westcott)
2023-08-30 10:15:25 +00:00
* Add the ability to use filters and to export listings in generic `IndexView` (Sage Abdullah)
* Move `list_filter` , `filterset_class` , `search_fields` , `search_backend_name` , `list_export` , `export_filename` , `list_per_page` , and `ordering` from `SnippetViewSet` to `ModelViewSet` (Sage Abdullah)
* Add default header titles to generic `IndexView` and `CreateView` (Sage Abdullah)
2023-08-30 15:11:11 +00:00
* Allow overriding `IndexView.export_headings` via `ModelViewSet` (Christer Jensen, Sage Abdullah)
* Change spreadsheet export headings to match listing view column headings (Christer Jensen, Sage Abdullah)
2023-09-04 17:45:39 +00:00
* Support specifying a `get_object_list` method on `ChooserViewSet` (Matt Westcott)
2023-07-18 16:14:16 +00:00
### Bug fixes
2023-07-27 11:37:48 +00:00
* Ensure that StreamField's `FieldBlock` s correctly set the `required` and `aria-describedby` attributes (Storm Heg)
2023-08-23 15:22:12 +00:00
* Avoid an error when the moderation panel (admin dashboard) contains both snippets and private pages (Matt Westcott)
2023-08-23 21:40:04 +00:00
* When deleting collections, ensure the collection name is correctly shown in the success message (LB (Ben) Johnston)
2023-08-30 15:11:11 +00:00
* Fix numbers, booleans, and `None` from being exported as strings (Christer Jensen)
2023-08-30 22:17:21 +00:00
* Filter out comments on Page editing counts that do not correspond to a valid field / block path on the page such as when a field has been removed (Matt Westcott)
2023-07-18 16:14:16 +00:00
### Documentation
2023-08-18 16:45:31 +00:00
* Document `WAGTAILADMIN_BASE_URL` on "Integrating Wagtail into a Django project" page (Shreshth Srivastava)
2023-08-19 10:31:43 +00:00
* Replace incorrect screenshot for authors listing on tutorial (Shreshth Srivastava)
2023-07-18 16:14:16 +00:00
### Maintenance
2023-07-18 13:19:09 +00:00
* Fix snippet search test to work on non-fallback database backends (Matt Westcott)
2023-08-02 11:01:56 +00:00
* Update Eslint, Prettier & Jest npm packages (LB (Ben) Johnston)
2023-08-01 22:24:26 +00:00
* Add npm scripts for TypeScript checks and formatting SCSS files (LB (Ben) Johnston)
2023-08-02 14:45:14 +00:00
* Run tests in parallel in some of the CI setup (Sage Abdullah)
2023-07-28 09:12:00 +00:00
* Remove unused WorkflowStatus view, urlpattern, and workflow-status.js (Storm Heg)
2023-07-27 11:37:48 +00:00
* Add support for options/attrs in Telepath widgets so that attrs render on the created DOM (Storm Heg)
2023-08-05 00:06:31 +00:00
* Update pre-commit hooks to be in sync with latest changes to Eslint & Prettier for client-side changes (Storm Heg)
2023-08-17 16:19:53 +00:00
* Add `WagtailTestUtils.get_soup()` method for testing HTML content (Storm Heg, Sage Abdullah)
2023-08-15 00:33:16 +00:00
* Allow `ViewSet` subclasses to customise `url_prefix` and `url_namespace` logic (Matt Westcott)
2023-08-16 10:40:28 +00:00
* Simplify `SnippetViewSet` registration code (Sage Abdullah)
2023-08-22 16:14:44 +00:00
* Rename groups `IndexView.results_template_name` to `results.html` (Sage Abdullah)
2023-06-27 11:02:00 +00:00
* Migrate form submission listing checkbox toggling to the shared `w-bulk` Stimulus implementation (LB (Ben) Johnston)
2023-09-04 15:13:11 +00:00
* Allow viewsets to define a common set of view kwargs (Matt Westcott)
2023-07-18 16:14:16 +00:00
2023-08-01 11:32:56 +00:00
## Upgrade considerations - changes affecting all projects
## Upgrade considerations - deprecation of old functionality
## Upgrade considerations - changes affecting Wagtail customisations
2023-08-16 10:22:49 +00:00
### `ModelViewSet` automatically registers the model to the reference index
Models that are registered with a `ModelViewSet` now have reference index tracking enabled by default. This means that you no longer need to call `ReferenceIndex.register_model()` in your app's `ready()` method for such models. If this is undesired, you can disable it by setting {attr}`~wagtail.admin.viewsets.model.ModelViewSet.add_to_reference_index` to `False` on the `ModelViewSet` subclass. For more details, see [](managing_the_reference_index).
2023-08-22 15:25:26 +00:00
### Groups `IndexView.results_template_name` renamed from `results.html` to `index_results.html`
The `IndexView` 's `results_template_name` attribute in the `GroupViewSet` has been renamed from `wagtailusers/groups/results.html` to `wagtailusers/groups/index_results.html` for consistency with the other viewsets. If you have customised or extended the template, e.g. for [](customising_group_views), you will need to rename it to match the new name.
