[Fixed]-For the django admin, how do I add a field to the User model and have it editable in the admin?

by

29👍

✅

First the “is it plugged in?” question — Have you manually added new_field to the users table in the database? Syncdb wouldn’t have taken care of that, of course.

After that, I would try appending the fields onto the existing UserAdmin rather than rebuilding it from scratch:

from django.contrib.auth.admin import UserAdmin

UserAdmin.list_display += ('new_field',)  # don't forget the commas
UserAdmin.list_filter += ('new_field',)
UserAdmin.fieldsets += ('new_field',)
👤anschauung

6👍

Just figured this out, perhaps this could help you as well.

Since you don’t mention that you have a separate profile, if you want to simply add a column to the existing User admin, you can do the following in admin.py:

First you create a custom admin by subclassing UserAdmin:

class CustomUserAdmin(UserAdmin):
    list_display = UserAdmin.list_display + ('is_complete',)

    def is_complete(self, obj):
        # Example here, you can use any expression.
        return SomeOtherClass.objects.get(my_field=obj).is_complete()

    # Not required, but this gives you a nice boolean field:
    is_complete.boolean = True

Then unregister the existing UserAdmin and register your own:

admin.site.unregister(User)
admin.site.register(User, CustomUserAdmin)
👤Martijn de Milliano

4👍

It is preferred to write your own user profile class, and attach it to the User model. Then you can use the get_profile() method to retrieve the profile from the user.

Subclassing the profile admin from an Inline Admin should also allow you to edit the profile on the user’s page, which is almost what you’re trying to do.

This post has a really good write-up on the issue: http://www.b-list.org/weblog/2006/jun/06/django-tips-extending-user-model/

👤sykora

2👍

Despite your DB look up concerns for having a UserProfile, that is really the way you should go for this problem. There are two main reasons for this:

  1. The User Model is pretty tightly coupled to Django’s authentication system and to many other plugins. Monkey patching it isn’t a good idea.

  2. Django has built-in support for creating User Profiles and many extensions know how to play nicely with these. By using User Profiles (see http://docs.djangoproject.com/en/dev/topics/auth/#storing-additional-information-about-users for the main discussion on this) you can benefit from that.

If you’re looking to add functionality to the Admin interface for users, then this note may be helpful:

http://www.thenestedfloat.com/articles/displaying-custom-user-profile-fields-in-djangos-admin/index.html

Regards,

Ian

👤IanSR

1👍

Based on @anschauung response, what worked for me in Django 3.2 is:

from django.contrib.auth.admin import UserAdmin

# don't forget the commas
UserAdmin.list_filter += ('new_field',)
UserAdmin.fieldsets +=  (('Extra Fields', {'fields': ('new_field', )}),)
👤M.C

-1👍

I got the ‘that is missing from the form’ error, and discovered that it was due to my field being marked as ‘editable=False’ in the model.

👤stephendwolff

Leave a comment