Add `help_text` to Django Admin field

Question

I'm attempting to display an image when editing a user on the admin panel, but I can't figure out how to add help text.

I'm using this Django Admin Show Image from Imagefield code, which works fine.

However the short_description attribute only names the image, and help_text doesn't seem to add an text below it.

How can I add help_text to this field like normal model fields?

EDIT:

I would like to have help_text on the image like the password field does in this screenshot:

Anton Shurashov · Answer 1 · 2017-08-06T20:02:22.613

10

Use a custom form if you don't want change a model:

from django import forms

class MyForm(forms.ModelForm):
    def __init__(self, *args, **kwargs):
        super(MyForm, self).__init__(*args, **kwargs)
        self.fields['image'].help_text = 'My help text'

    class Meta:
        model = MyModel
        exclude = ()

@admin.register(MyModel)
class MyModelAdmin(admin.ModelAdmin):
    form = MyForm
    # ...

edited Aug 06 '17 at 20:02

answered Aug 06 '17 at 18:55

Anton Shurashov

1,670
1
20
33

1

This doesn't seem to add the help text though. Am I missing something? – cdignam Aug 06 '17 at 19:03
Does your field in the `MyModel` contain the `help_text` parameter like this: `image = models.ImageField(<...>, help_text='My help text')`? – Anton Shurashov Aug 06 '17 at 19:06
1

I currently just pull the url from the model and I want to avoid adding anything else to it. – cdignam Aug 06 '17 at 19:11

score 1 · Answer 2 · edited Mar 11 '22 at 00:51

Took me a while to figure out. If you've defined a custom field in your admin.py only and the field is not in your model. Use a custom ModelForm:

class SomeModelForm(forms.ModelForm):
    # You don't need to define a custom form field or setup __init__()

    class Meta:
        model = SomeModel
        help_texts = {'avatar': 'User's avatar Image'}
        exclude = ()

And in the admin.py:

class SomeModelAdmin(admin.ModelAdmin):
    form = SomeModelForm
    # ...

score 1 · Answer 3 · answered Nov 25 '21 at 11:11

If you don't want to create a custom model form class :

class MyModelAdmin(admin.ModelAdmin):
    def get_form(self, request, obj=None, change=False, **kwargs):
        form = super().get_form(request, obj=obj, change=change, **kwargs)
        form.base_fields["image"].help_text = "Some help text..."
        return form

Add `help_text` to Django Admin field

3 Answers3