Fixed #21591 -- Added documentation about contrib.messages.get_messages.

Refs https://code.djangoproject.com/ticket/21591
Thanks to track user merb for the report.
This commit is contained in:
Rémy HUBSCHER 2013-12-12 11:45:27 +01:00 committed by Baptiste Mispelon
parent 9922ed46e2
commit 24fcca6bdd
1 changed files with 21 additions and 1 deletions

View File

@ -177,8 +177,9 @@ used tags (which are usually represented as HTML classes for the message)::
Displaying messages
-------------------
.. function:: get_messages(request)
In your template, use something like::
**In your template**, use something like::
{% if messages %}
<ul class="messages">
@ -212,6 +213,25 @@ is a mapping of the message level names to their numeric value::
</ul>
{% endif %}
**Outside of templates**, you can use
:func:`~django.contrib.messages.get_messages`::
from django.contrib.messages import get_messages
storage = get_messages(request)
for message in storage:
do_something_with_the_message(message)
For instance, you can fetch all the messages to return them in a
:ref:`JSONResponseMixin <jsonresponsemixin-example>` instead of a
:class:`~django.views.generic.base.TemplateResponseMixin`.
:func:`~django.contrib.messages.get_messages` will return an
instance of the configured storage backend.
The ``Message`` class
---------------------