Is there a way to filter a queryset in the django admin?
Asked Answered
H

2

19

I'm trying to define an action for a model Bar -- but I only want the list of Bar objects related to a user Foo.

Before I start mucking around in the admin code and passing in a custom queryset (or writing a custom view that hijacks the admin's multi-checkbox support), I figured I'd check to see if there were a way I could slice up the data as is so I get a list view.

Note: I'm not trying to sort by related user, and I'm not trying to add extra options to the default list view to filter by user; I need a specific URL or view that will give me just a list of Bar objects to a specific user Foo.

Heda answered 30/10, 2009 at 21:2 Comment(0)
R
27

It's not documented, but the standard changelist view accepts normal queryset filter parameters as GET arguments. So you can do:

/admin/myapp/bar/?user__username=foo
Rodriquez answered 30/10, 2009 at 21:18 Comment(1)
And the list of possibilities is here: docs.djangoproject.com/en/dev/ref/models/querysets/…Gayla
D
29

All you need to do is override the get_queryset() method on your ModelAdmin. Something like this:

class ThisAdmin(admin.ModelAdmin):
    def get_queryset(self, request):
        """
        Filter the objects displayed in the change_list to only
        display those for the currently signed in user.
        """
        qs = super(ThisAdmin, self).get_queryset(request)
        if request.user.is_superuser:
            return qs
        return qs.filter(owner=request.user)

The advantage of this approach is that it doesn't clutter up your nice pretty admin URLs (and also, therefore, make it extremely obvious to your users how to view other people objects).

Decastere answered 2/11, 2009 at 2:6 Comment(2)
This works fine for the models directly edited on the admin. How about the Foreign Keys that get auto populated in the drop downs.Kebab
def queryset is def get_queryset for all recent versions of Django.Anglican
R
27

It's not documented, but the standard changelist view accepts normal queryset filter parameters as GET arguments. So you can do:

/admin/myapp/bar/?user__username=foo
Rodriquez answered 30/10, 2009 at 21:18 Comment(1)
And the list of possibilities is here: docs.djangoproject.com/en/dev/ref/models/querysets/…Gayla

© 2022 - 2024 — McMap. All rights reserved.