mirrors/wagtail
mirrors/wagtail
0
0
Fork 0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
Code Issues Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Andy Babic 2020-04-03 16:35:23 +01:00
parent a574c336cf
commit 18118f54b6
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/reference/contrib/settings.rst
View File

@ -108,17 +108,20 @@ Settings are designed to be used both in Python code, and in templates.
Using in Python
---------------
If access to a setting is required in the code, the :func:`~wagtail.contrib.settings.models.BaseSetting.for_site` method will retrieve the setting for the supplied site:
If you require access to a setting in a view, the :func:`~wagtail.contrib.settings.models.BaseSetting.for_request` method allows you to retrieve the relevant settings for the current request:
.. code-block:: python
from wagtail.core.models import Site
def view(request):
site = Site.find_for_request(request)
social_media_settings = SocialMediaSettings.for_site(site)
social_media_settings = SocialMediaSettings.for_request(request)
...
In places where the request is unavailable, but you know the ``Site`` you wish to retrieve settings for, you can use :func:`~wagtail.contrib.settings.models.BaseSetting.for_site` instead:
.. code-block:: python
social_media_settings = SocialMediaSettings.for_site(user.origin_site)
Using in Django templates
-------------------------