How do you dynamically hide form fields in Django?

Question

I am making a profile form in Django. There are a lot of optional extra profile fields but I would only like to show two at a time. How do I hide or remove the fields I do not want to show dynamically?

Here is what I have so far:

class UserProfileForm(forms.ModelForm):
    extra_fields = ('field1', 'field2', 'field3')
    extra_field_total = 2

    class Meta:
        model = UserProfile

    def __init__(self, *args, **kwargs):
        extra_field_count = 0
        for key, field in self.base_fields.iteritems():
            if key in self.extra_fields:
                if extra_field_count < self.extra_field_total:
                    extra_field_count += 1
                else:
                    # do something here to hide or remove field
        super(UserProfileForm, self).__init__(*args, **kwargs)

Related answer: stackoverflow.com/a/1914812/462865

Amir Ali Akbari
– Amir Ali Akbari

2016-09-07 10:09:50 +00:00
Commented Sep 7, 2016 at 10:09 — Amir Ali Akbari
– Amir Ali Akbari, Commented Sep 7, 2016 at 10:09

Jason Christa · Accepted Answer · 2009-08-10 19:18:53Z

28

I think I found my answer.

First I tried:

field.widget = field.hidden_widget

which didn't work.

The correct way happens to be:

field.widget = field.hidden_widget()

answered Aug 10, 2009 at 19:18

Jason Christa

12.5k15 gold badges61 silver badges86 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

benzkji Over a year ago

what if you have an invalid value in the hidden field? you users will go nuts...

nitwit Over a year ago

@benzkji this is often used with select/radio inputs, naturally

benzkji Over a year ago

I can see that this might be often used, and will work in some, maybe even many cases. But if your field is a choice field, and you have old, invalid values in your database, those records cannot be saved anymore, because the hidden widget will contain an invalid value.

egor83 Over a year ago

Instead of field.hidden_widget() you can also put forms.HiddenInput()

fedorqui · Accepted Answer · 2018-08-14 09:46:02Z

5

def __init__(self, *args, **kwargs):
    is_video = kwargs.pop('is_video')
    is_image = kwargs.pop('is_image')
    super(ContestForm, self).__init__(*args, **kwargs)
    if is_video:
        del self.fields['video_link']
        # self.exclude('video_link')
    if is_image:
        del self.fields['image']

use delete instead of self.exclude().

edited Aug 14, 2018 at 9:46

fedorqui

293k112 gold badges592 silver badges640 bronze badges

answered Mar 20, 2012 at 17:42

Invincible

4224 silver badges20 bronze badges

1 Comment

Vitalii Dmitriev Over a year ago

Why del is better than self.exclude()?

oak · Accepted Answer · 2012-02-07 20:21:35Z

4

Can also use

def __init__(self, instance, *args, **kwargs):    
    super(FormClass, self).__init__(instance=instance, *args, **kwargs)
    if instance and instance.item:
        del self.fields['field_for_item']

answered Feb 7, 2012 at 20:21

oak

1379 bronze badges

Comments

hughdbrown · Accepted Answer · 2009-08-10 18:16:41Z

1

You are coding this in the Form. Wouldn't it make more sense to do this using CSS and JavaScript in the template code? Hiding a field is as easy as setting "display='none'" and toggling it back to 'block', say, if you need to display it.

Maybe some context on what the requirement is would clarify this.

answered Aug 10, 2009 at 18:16

hughdbrown

49.2k20 gold badges89 silver badges111 bronze badges

4 Comments

Jason Christa Over a year ago

Firstly, just because I think form logic should stay in the form. Also, because I see what fields have already been filled out before and don't show those.

Rob Osborne Over a year ago

This moves business logic into the presentation layer ("these objects don't have this field"). Especially bad if the web developer is NOT the backend developer.

benzkji Over a year ago

what if a value in a hidden field is not valid (any more)? you'll get "please correct the errors below"...happy searching.

nitwit Over a year ago

this can be achieved with something like if (mainField.value === 'value') { dependentField.style.display = 'block';

Collectives™ on Stack Overflow

How do you dynamically hide form fields in Django?

4 Answers 4

4 Comments

1 Comment

Comments

4 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

4 Comments

1 Comment

Comments

4 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related