Commits

russ...@bcc190cf-cafb-0310-a4f2-bffc1f526a37  committed 27d6077

[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.

  • Participants
  • Parent commits 8e2843b
  • Branches releases/1.1.X

Comments (0)

Files changed (1)

File docs/ref/contrib/admin/index.txt

 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
 ~~~~~~~~~~~~~