Hopiu/wagtail
1
0
Fork 0
mirror of https://github.com/Hopiu/wagtail.git synced 2026-03-16 22:10:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update docs with new locations of wagtail.admin.utils definitions

Browse source
This commit is contained in:
Matt Westcott 2019-08-15 19:40:43 +01:00 committed by Matt Westcott
parent 3a44de4d2b
commit 227221f7fb
2 changed files with 49 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/reference/contrib/forms/customisation.rst
View file

@ -716,7 +716,7 @@ If you want to change the content of the email that is sent when a form submits
To do this, you need to:
* Ensure you have your form model defined that extends ``wagtail.contrib.forms.models.AbstractEmailForm``.
* In your models.py file, import the ``wagtail.admin.utils.send_mail`` function.
* In your models.py file, import the ``wagtail.admin.mail.send_mail`` function.
* Override the ``send_mail`` method in your page model.
Example:
@ -725,7 +725,7 @@ Example:
from datetime import date
# ... additional wagtail imports
from wagtail.admin.utils import send_mail
from wagtail.admin.mail import send_mail
from wagtail.contrib.forms.models import AbstractEmailForm
@ -763,6 +763,6 @@ Example:
# Content is joined with a new line to separate each text line
content = '\n'.join(content)
# wagtail.wagtailadmin.utils - send_mail function is called
# wagtail.admin.mail - send_mail function is called
# This function extends the Django default send_mail function
send_mail(subject, content, addresses, self.from_address)

46
docs/releases/2.7.rst
View file

@ -55,3 +55,49 @@ Upgrade considerations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The internal ``Page.dummy_request`` method (which generates an HTTP request object simulating a real page request, for use in previews) has been deprecated, as it did not correctly handle errors generated during middleware processing. Any code that calls this method to render page previews should be updated to use the new method ``Page.make_preview_request(original_request=None, preview_mode=None)``, which builds the request and calls ``Page.serve_preview`` as a single operation.
``wagtail.admin.utils`` and ``wagtail.admin.decorators`` modules deprecated
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The modules ``wagtail.admin.utils`` and ``wagtail.admin.decorators`` have been deprecated. The helper functions defined here exist primarily for Wagtail's internal use; however, some of them (particularly ``send_mail`` and ``permission_required``) may be found in user code, and import lines will need to be updated. The new locations for these definitions are as follows:
+---------------------------------+--------------------------+--------------------------+
| Definition | Old location | New location |
+=================================+==========================+==========================+
| any_permission_required | wagtail.admin.utils | wagtail.admin.auth |
+---------------------------------+--------------------------+--------------------------+
| permission_denied | wagtail.admin.utils | wagtail.admin.auth |
+---------------------------------+--------------------------+--------------------------+
| permission_required | wagtail.admin.utils | wagtail.admin.auth |
+---------------------------------+--------------------------+--------------------------+
| PermissionPolicyChecker | wagtail.admin.utils | wagtail.admin.auth |
+---------------------------------+--------------------------+--------------------------+
| user_has_any_page_permission | wagtail.admin.utils | wagtail.admin.auth |
+---------------------------------+--------------------------+--------------------------+
| user_passes_test | wagtail.admin.utils | wagtail.admin.auth |
+---------------------------------+--------------------------+--------------------------+
| users_with_page_permission | wagtail.admin.utils | wagtail.admin.auth |
+---------------------------------+--------------------------+--------------------------+
| reject_request | wagtail.admin.decorators | wagtail.admin.auth |
+---------------------------------+--------------------------+--------------------------+
| require_admin_access | wagtail.admin.decorators | wagtail.admin.auth |
+---------------------------------+--------------------------+--------------------------+
| get_available_admin_languages | wagtail.admin.utils | wagtail.admin.locale |
+---------------------------------+--------------------------+--------------------------+
| get_available_admin_time_zones | wagtail.admin.utils | wagtail.admin.locale |
+---------------------------------+--------------------------+--------------------------+
| get_js_translation_strings | wagtail.admin.utils | wagtail.admin.locale |
+---------------------------------+--------------------------+--------------------------+
| WAGTAILADMIN_PROVIDED_LANGUAGES | wagtail.admin.utils | wagtail.admin.locale |
+---------------------------------+--------------------------+--------------------------+
| send_mail | wagtail.admin.utils | wagtail.admin.mail |
+---------------------------------+--------------------------+--------------------------+
| send_notification | wagtail.admin.utils | wagtail.admin.mail |
+---------------------------------+--------------------------+--------------------------+
| get_object_usage | wagtail.admin.utils | wagtail.admin.models |
+---------------------------------+--------------------------+--------------------------+
| popular_tags_for_model | wagtail.admin.utils | wagtail.admin.models |
+---------------------------------+--------------------------+--------------------------+
| get_site_for_user | wagtail.admin.utils | wagtail.admin.navigation |
+---------------------------------+--------------------------+--------------------------+