diff options
Diffstat (limited to 'docs/ref')
| -rw-r--r-- | docs/ref/class-based-views.txt | 23 |
1 files changed, 19 insertions, 4 deletions
diff --git a/docs/ref/class-based-views.txt b/docs/ref/class-based-views.txt index 3448bbd6d7..2676c2cefc 100644 --- a/docs/ref/class-based-views.txt +++ b/docs/ref/class-based-views.txt @@ -136,6 +136,20 @@ SingleObjectMixin The name of the field on the model that contains the slug. By default, ``slug_field`` is ``'slug'``. + .. attribute:: slug_url_kwarg + + .. versionadded:: 1.4 + + The name of the URLConf keyword argument that contains the slug. By + default, ``slug_url_kwarg`` is ``'slug'``. + + .. attribute:: pk_url_kwarg + + .. versionadded:: 1.4 + + The name of the URLConf keyword argument that contains the primary key. + By default, ``pk_url_kwarg`` is ``'pk'``. + .. attribute:: context_object_name Designates the name of the variable to use in the context. @@ -146,10 +160,11 @@ SingleObjectMixin ``queryset`` is provided, that queryset will be used as the source of objects; otherwise, :meth:`~SingleObjectMixin.get_queryset` will be used. - :meth:`~SingleObjectMixin.get_object` looks for a ``pk`` - argument in the arguments to the view; if ``pk`` is found, - this method performs a primary-key based lookup using that - value. If no ``pk`` argument is found, it looks for a ``slug`` + ``get_object()`` looks for a + :attr:`SingleObjectMixin.pk_url_kwarg` argument in the arguments + to the view; if this argument is found, this method performs a + primary-key based lookup using that value. If this argument is not + found, it looks for a :attr:`SingleObjectMixin.slug_url_kwarg` argument, and performs a slug lookup using the :attr:`SingleObjectMixin.slug_field`. |