Skip to content

Fixed #22226 -- Clarified quoting when reversing admin URLs. #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hbrooks wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −4
Open

Fixed #22226 -- Clarified quoting when reversing admin URLs. #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions docs/ref/contrib/admin/index.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3440,8 +3440,14 @@ call:
.. code-block:: pycon

>>> from django.urls import reverse
>>> from django.contrib.admin.utils import quote
>>> c = Choice.objects.get(...)
>>> change_url = reverse("admin:polls_choice_change", args=(c.id,))
>>> change_url = reverse("admin:polls_choice_change", args=(quote(c.pk),))

Admin URLs that take an ``object_id`` expect the primary key to be escaped with
``django.contrib.admin.utils.quote()``; otherwise reversing can produce URLs
that the admin fails to resolve when the key contains characters such as ``_``,
``/``, or ``:``.

This will find the first registered instance of the admin application
(whatever the instance name), and resolve to the view for changing
Expand All @@ -3454,7 +3460,9 @@ if you specifically wanted the admin view from the admin instance named

.. code-block:: pycon

>>> change_url = reverse("admin:polls_choice_change", args=(c.id,), current_app="custom")
>>> change_url = reverse(
... "admin:polls_choice_change", args=(quote(c.pk),), current_app="custom"
... )

For more details, see the documentation on :ref:`reversing namespaced URLs
<topics-http-reversing-url-namespaces>`.
Expand All @@ -3466,12 +3474,14 @@ To allow easier reversing of the admin urls in templates, Django provides an

{% load admin_urls %}
<a href="{% url opts|admin_urlname:'add' %}">Add user</a>
<a href="{% url opts|admin_urlname:'delete' user.pk %}">Delete this user</a>
<a href="{% url opts|admin_urlname:'delete' user.pk|admin_urlquote %}">Delete this user</a>

The action in the examples above match the last part of the URL names for
:class:`ModelAdmin` instances described above. The ``opts`` variable can be any
object which has an ``app_label`` and ``model_name`` attributes and is usually
supplied by the admin views for the current model.
supplied by the admin views for the current model. The ``admin_urlquote``
filter is the template equivalent of ``quote()`` above and must be applied to
primary key values used as ``object_id``.

The ``display`` decorator
=========================
Expand Down