Commit 2ee73c2f authored by Russell Keith-Magee's avatar Russell Keith-Magee
Browse files

[1.1.X] Fixed #10712 -- Added documentation for the queryset() method on...

[1.1.X] Fixed #10712 -- Added documentation for the queryset() method on ModelAdmin. Thanks to mrts for the report, and timo for the patch.

Backport of r13170 from trunk.

git-svn-id: http://code.djangoproject.com/svn/django/branches/releases/1.1.X@13176 bcc190cf-cafb-0310-a4f2-bffc1f526a37
parent 5d751026
Loading
Loading
Loading
Loading
+14 −0
Original line number Diff line number Diff line
@@ -823,6 +823,20 @@ return a subset of objects for this foreign key field based on the user::
This uses the ``HttpRequest`` instance to filter the ``Car`` foreign key field
to only the cars owned by the ``User`` instance.

.. method:: ModelAdmin.queryset(self, request):

The ``queryset`` method on a ``ModelAdmin`` returns a
:class:`~django.db.models.QuerySet` of all model instances that can be
edited by the admin site. One use case for overriding this method is
to show objects owned by the logged-in user::

    class MyModelAdmin(admin.ModelAdmin):
        def queryset(self, request):
            qs = super(self, MyModelAdmin).queryset(request)
            if request.user.is_superuser:
                return qs
            return qs.filter(author=request.user)

Other methods
~~~~~~~~~~~~~