Django adminのlist_displayをカスタマイズしたときにリストの表示名を変えたい

2020年9月6日

今回はDjango adminのlist_displayをカスタマイズしたときにリストの表示名を変えたいときにどのようにすれば良いのかについてご紹介いたします。

Django adminのlist_displayをカスタマイズしたときにリストの表示名を変えたい

Djangoでlist_displayをカスタマイズしたとします。

すると、カスタマイズしたlist_displayに対してメソッドの表示名が大文字になってそのまま表示されてしまいます。

例として、下記のようにtest_listをlist_displayに追加したとしましょう。

@admin.register(User)
class AdminUserAdmin(UserAdmin):

    (略)

    list_display = ('username', 'email', 'full_name', 'is_staff', 'test_list')
	
    (略)

    def test_list(self, obj):
        return format_html('<button type="button" class="button" onclick="testFucntion(\'' + obj.email + '\')">送信</button>')

@admin.register(User)

class AdminUserAdmin(UserAdmin):

(略)

list_display = ('username', 'email', 'full_name', 'is_staff', 'test_list')

(略)

def test_list(self, obj):

return format_html('<button type="button" class="button" onclick="testFucntion(\'' + obj.email + '\')">送信</button>')

すると、Djangoのadminでは下記のように追加したtest_listが「TEST LIST」と大文字になって表示されてしまいます。
この「TEST LIST」を変えたいという場面が出てくると思います。

では、どうやって「TEST LIST」を変えれば良いかというと、メソッドの下に
test_list.short_description = 'xxx’
を追加すれば良いだけです。
xxxの部分は自分が変更したい名前になります。

上記のソースコードの例だと、

@admin.register(User)
class AdminUserAdmin(UserAdmin):
 
    (略)
 
    list_display = ('username', 'email', 'full_name', 'is_staff', 'test_list')
	
    (略)
 
    def test_list(self, obj):
        return format_html('<button type="button" class="button" onclick="testFucntion(\'' + obj.email + '\')">送信</button>')
 
    test_list.short_description = '送信ボタン'