Extending Django Admin Templates - altering change list

django, django-admin

Solution

To expand on Yuji's answer, here are some specifics on overriding `change_list_results.html` ...

Override `changelist_view` as described above in step 1, and also described here at djangoproject. Or auto-override by placing in the appropriate directory as in step 2 above. (Note that the step 2 path shown above is model-specific. App-specific would be `/admin/<MyAppName>/change_list.html` under any directory defined in the TEMPLATE_DIRS tuple.)

Or (perhaps easier) simply specify `ModelAdmin.change_list_template` as explained here with any discoverable template filename. (Although, if you retain the name `change_list.html`, be sure not to deposit directly into the `/admin` folder, else the `extends` tag will cause a recursion.)

class MyModelAdmin(admin.ModelAdmin):
    change_list_template = 'change_list.html' # definitely not 'admin/change_list.html'
    # ...

In your `change_list.html` template, have at a minimum

{% extends "admin/change_list.html" %}
{% load i18n admin_static admin_list %}
{% load myapptags %}

{% block result_list %}
  {% if action_form and actions_on_top and cl.full_result_count %}{% admin_actions %}{% endif %}
  {% result_list cl %}
  {% if action_form and actions_on_bottom and cl.full_result_count %}{% admin_actions %}{% endif %}
{% endblock %}

Create a `/<MyAppName>/templatetags` package (a directory containing `__init__.py`) with a file corresponding to the load tag above

# MyAppName/templatetags/myapptags.py

from django import template
from django.contrib.admin.templatetags.admin_list import result_list

register = template.Library()
register.inclusion_tag('my_change_list_results.html')(result_list)

Copy and edit Django's `change_list_results.html` (as e.g. `my_change_list_results.html` above) to use your added functionality.

Note that these steps do not include extra context for the template, but can easily be expanded as such. (My reason for doing this was to add classes for CSS and a leading `<tbody>` that was not sorted with the results list.)

ADDITIONAL:

To include extra context, change your templatetags module as follows:

# MyAppName/templatetags/myapptags.py

from django import template
from django.contrib.admin.templatetags.admin_list import result_list as admin_list_result_list

def result_list(cl):
    mycl = {'myextracontext': 'something extra'}
    mycl.update(foo_extra())
    mycl.update(admin_list_result_list(cl))
    return mycl

register = template.Library()
register.inclusion_tag('my_change_list_results.html')(result_list)

Then, the value of `myextracontext` or whatever `foo_extra` returns can be included in your results template (as e.g. `{{ myextracontext }}`)

Problem

Original source

Related problems

• Override existing Django Template Tags