Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

[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
  • Loading branch information...
commit 2ee73c2f4e6f0822892c97998325faeeee408255 1 parent 5d75102
@freakboy3742 freakboy3742 authored
Showing with 14 additions and 0 deletions.
  1. +14 −0 docs/ref/contrib/admin/index.txt
View
14 docs/ref/contrib/admin/index.txt
@@ -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
~~~~~~~~~~~~~
Please sign in to comment.
Something went wrong with that request. Please try again.