From f9b75db90f606d03569edcfa71792d443d7545f4 Mon Sep 17 00:00:00 2001 From: Russell Keith-Magee Date: Sun, 9 May 2010 06:44:52 +0000 Subject: [PATCH] Fixed #10712 -- Added documentation for the queryset() method on ModelAdmin. Thanks to mrts for the report, and timo for the patch. git-svn-id: http://code.djangoproject.com/svn/django/trunk@13170 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/ref/contrib/admin/index.txt | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/ref/contrib/admin/index.txt b/docs/ref/contrib/admin/index.txt index aa16cf2a5f..e9784a584a 100644 --- a/docs/ref/contrib/admin/index.txt +++ b/docs/ref/contrib/admin/index.txt @@ -871,6 +871,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 ~~~~~~~~~~~~~