How to add custom search box in Django-admin?

Question

I know this is gonna be a very basic question.

In Django, I have successfully created an admin panel. Now I want to add a custom search box in one of my field namely Photo field. But I don't know how to add custom search box in a django-admin panel. If I get some proper hints than I believe that I can do it.

Admin.py:

from django.contrib import admin

from photo.models import Photo


class PhotoAdmin(admin.ModelAdmin):
    list_display = ('name', 'approved', 'approved_time', 'uploaded_time', 'user')

models.py:

class Photo(models.Model):
    name = models.CharField(max_length=100)
    photo = models.ImageField(upload_to='photos', blank=False, null=True)
    approved = models.BooleanField(default=False)
    approved_time = models.DateTimeField(auto_now=True,null=True, blank=True)
    uploaded_time = models.DateTimeField()
    description = models.CharField(max_length=500, blank=False , null=True)
    keyword = models.CharField(max_length=500, blank=False, null=True)
    image_id = models.CharField(max_length=300, blank=True, null=True)
    Certified = models.BooleanField(default=False)
    approved_by = models.CharField(max_length=100)
    user = models.ForeignKey(User)
    total_download = models.IntegerField(default=0)
    watermarked_image = models.ImageField(upload_to='temp', blank=True, null=True)

I want to add a custom search box in this Photo field where image can be searched by it's ID. Now how can I add this search box in my above given model.

On a side note, do not use `Certified` use `certified` instead for attribute name. — Underoos, Mar 20 '20 at 20:37

score 172 · Accepted Answer · edited Mar 21 '23 at 14:24

172

Use the search_fields attribute of the ModelAdmin:

class PhotoAdmin(admin.ModelAdmin):
    ...
    search_fields = ['name', 'description', 'user__related_fieldname', 'keyword']

edited Mar 21 '23 at 14:24

Francisco

10,918
6
34
45

answered Feb 14 '15 at 05:46

catavaran

44,703
8
98
85

Thanks for your reply.. i want to search item by ID,should i include `id` or `photo.id` in `search_fields` parameter ? – Md. Tanvir Raihan Feb 14 '15 at 06:04
1

Yes, add the `'id'` field to the `search_fields`. – catavaran Feb 14 '15 at 06:11
15

and for those who come after, you could search on related model fields, too `search_fields = ('name', 'relatedfield__name')` – ptim Jun 03 '17 at 13:47

score 25 · Answer 2 · edited Sep 24 '21 at 12:38

25

cant reply due to low karma..

but don't forget to register the Admin Model too, like

admin.py

from django.contrib import admin
from .models import *

admin.site.register(Photo, PhotoAdmin)

edited Sep 24 '21 at 12:38

Augusto Destrero

4,095
1
23
25

answered Feb 21 '18 at 14:26

Dan Walters

1,218
1
18
30

Got AttributeError: type object 'ModelAdmin' has no attribute '_meta'. – Akhil S Jun 05 '21 at 14:57
I fixed the code in the answer to avoid some headaches to SO copy-pasters. ;) – Augusto Destrero Sep 24 '21 at 12:39

score 3 · Answer 3 · answered Jun 05 '21 at 14:56

3

When you write:

admin.site.register([Photo, PhotoAdmin])

you register in admin two models: Photo and PhotoAdmin, you must register Model and ModelAdmin for it, like this:

admin.site.register(Photo, PhotoAdmin)

answered Jun 05 '21 at 14:56

Akhil S

955
11
16

score 3 · Answer 4 · edited Mar 21 '23 at 14:25

3

Adding Dan Walters answer, you can also search if you don't know the exact word with __icontains

class PhotoAdmin(admin.ModelAdmin):
    ...
    search_fields = ['name__icontains', 'description', 'user__related_fieldname', 'keyword__icontains',
]

it's equivalent to LIKE in SQL

edited Mar 21 '23 at 14:25

Francisco

10,918
6
34
45

answered Sep 22 '22 at 11:58

Michael Halim

262
2
20

How to add custom search box in Django-admin?

4 Answers4

Linked