Admin customization with ModelAdmin in Django

Introduction

ModelAdmin lets you change how your data shows up in Django's admin site. It helps you make the admin easier to use and look better.

You want to show only certain fields in the admin list view.

You want to add search boxes to find data quickly.

You want to filter data by categories or dates in the admin.

You want to change the order of fields when editing a record.

You want to add custom buttons or actions for your data.

Syntax

Django

from django.contrib import admin
from .models import YourModel

class YourModelAdmin(admin.ModelAdmin):
    list_display = ('field1', 'field2')
    search_fields = ('field1',)
    list_filter = ('field3',)

admin.site.register(YourModel, YourModelAdmin)

list_display controls which fields show in the list view.

search_fields adds a search box for specified fields.

Examples

Shows only title and author columns in the book list.

Django

class BookAdmin(admin.ModelAdmin):
    list_display = ('title', 'author')

Adds a search box to find books by title or author name.

Django

class BookAdmin(admin.ModelAdmin):
    search_fields = ('title', 'author__name')

Adds a filter sidebar to filter books by publication year.

Django

class BookAdmin(admin.ModelAdmin):
    list_filter = ('publication_year',)

Sample Program

This code customizes the admin for the Book model. It shows title, author, and year in the list. It adds a search box for title and author name. It also adds a filter for publication year.

Django

from django.contrib import admin
from .models import Book

class BookAdmin(admin.ModelAdmin):
    list_display = ('title', 'author', 'publication_year')
    search_fields = ('title', 'author__name')
    list_filter = ('publication_year',)

admin.site.register(Book, BookAdmin)

Important Notes

Remember to import your model and admin module correctly.

Use double underscores (__) to search or filter on related model fields.

After changes, restart the Django server to see updates in admin.

Summary

ModelAdmin lets you control how models appear in Django admin.

You can show specific fields, add search, and filters easily.

This makes managing data faster and clearer for admins.

Practice

1. What is the main purpose of customizing a Django ModelAdmin class?

easy

A. To define URL routes for the model views

B. To control how a model is displayed and managed in the Django admin interface

C. To write custom SQL queries for the model

D. To create new database tables automatically

Solution

1. Step 1: Understand ModelAdmin role

   The ModelAdmin class customizes the admin interface for a model, such as which fields show and how data is filtered.

2. Step 2: Identify what ModelAdmin does not do

   It does not create tables, write SQL, or define URLs; those are handled elsewhere in Django.

3. Final Answer:

   To control how a model is displayed and managed in the Django admin interface -> Option B

4. Quick Check:

   ModelAdmin controls admin display = D [OK]

Hint: ModelAdmin customizes admin display, not database or URLs [OK]

Common Mistakes:

• Confusing ModelAdmin with database migrations
• Thinking ModelAdmin handles URL routing
• Assuming ModelAdmin writes SQL queries

2. Which of the following is the correct way to register a model with a custom ModelAdmin in Django admin?

easy

A. admin.site.add(MyModel, MyModelAdmin)

B. admin.register(MyModel, MyModelAdmin)

C. admin.site.register(MyModel, MyModelAdmin)

D. admin.register_site(MyModel, MyModelAdmin)

Solution

1. Step 1: Recall Django admin registration syntax

   The correct method to register a model with a custom admin class is admin.site.register(Model, ModelAdmin).

2. Step 2: Check other options for validity

   Other options like admin.register or admin.site.add do not exist in Django's admin API.

3. Final Answer:

   admin.site.register(MyModel, MyModelAdmin) -> Option C

4. Quick Check:

   Use admin.site.register to register models = A [OK]

Hint: Use admin.site.register(Model, AdminClass) to register [OK]

Common Mistakes:

• Using admin.register instead of admin.site.register
• Trying to call admin.site.add which doesn't exist
• Confusing method names for registration

3. Given this ModelAdmin code, what fields will appear in the Django admin list view?

class BookAdmin(admin.ModelAdmin):
    list_display = ('title', 'author', 'published_date')

admin.site.register(Book, BookAdmin)

medium

A. 'title', 'author', and 'published_date' fields

B. Only 'title' and 'author' fields

C. All fields of the Book model

D. No fields will appear because list_display is incorrect

Solution

1. Step 1: Understand list_display usage

   The list_display attribute defines exactly which fields show in the admin list view.

2. Step 2: Check the fields listed

   The tuple includes 'title', 'author', and 'published_date', so these three fields will appear.

3. Final Answer:

   'title', 'author', and 'published_date' fields -> Option A

4. Quick Check:

   list_display shows specified fields = A [OK]

Hint: list_display shows only fields listed in its tuple [OK]

Common Mistakes:

• Assuming all model fields show by default
• Thinking list_display must include all fields
• Believing list_display is optional for showing fields

4. What is wrong with this ModelAdmin code snippet?

class AuthorAdmin(admin.ModelAdmin):
    search_fields = 'name'

admin.site.register(Author, AuthorAdmin)

medium

A. search_fields should be a list or tuple, not a string

B. AuthorAdmin must inherit from admin.ModelAdminBase

C. admin.site.register is missing parentheses

D. search_fields cannot be used in ModelAdmin

Solution

1. Step 1: Check search_fields type

   The search_fields attribute must be a list or tuple of field names, not a single string.

2. Step 2: Validate other parts

   Inheritance from admin.ModelAdmin is correct, registration syntax is correct, and search_fields is valid in ModelAdmin.

3. Final Answer:

   search_fields should be a list or tuple, not a string -> Option A

4. Quick Check:

   search_fields needs list/tuple = C [OK]

Hint: Wrap search_fields in [] or () even for one field [OK]

Common Mistakes:

• Using a plain string instead of list/tuple for search_fields
• Confusing ModelAdmin inheritance class
• Missing parentheses in admin.site.register (not here though)

5. You want to add a filter sidebar in Django admin to filter books by their 'genre' and 'published_year'. Which ModelAdmin attribute should you customize, and how?

hard

A. Add filter_fields = ['genre', 'published_year'] in the ModelAdmin

B. Use search_fields = ('genre', 'published_year') to enable filtering

C. Override filter_sidebar = True in the ModelAdmin

D. Set list_filter = ('genre', 'published_year') in the ModelAdmin class

Solution

1. Step 1: Identify correct attribute for filters

   The list_filter attribute adds filter sidebars for specified fields in the admin list view.

2. Step 2: Check other options for correctness

   filter_fields and filter_sidebar do not exist; search_fields is for search, not filters.

3. Final Answer:

   Set list_filter = ('genre', 'published_year') in the ModelAdmin class -> Option D

4. Quick Check:

   Use list_filter for sidebar filters = B [OK]

Hint: Use list_filter tuple to add filter sidebar fields [OK]

Common Mistakes:

• Using search_fields instead of list_filter for filters
• Trying to use non-existent filter_fields attribute
• Assuming filter_sidebar is a valid option