如何初始化Django的CheckboxSelectMultiple使其全部选项未选中？

Problem Description #

I have a Django ModelForm where I'm rendering a ModelMultipleChoiceField using the CheckboxSelectMultiple widget. Here's my form code:

class VisitForm(ModelForm):
    def __init__(self, queryset=None, *args, **kwargs):
        super(VisitForm, self).__init__(*args, **kwargs)
        if queryset:
            self.fields['students'] = forms.ModelMultipleChoiceField(
                queryset=queryset,
                widget=forms.CheckboxSelectMultiple()
            )

In my template, I'm rendering the field like this:

<div class="form-group">
    {{field.label}}
    {{field}}
</div>

The component initializes correctly, but I want all checkboxes to be unchecked by default when the form loads. How can I achieve this?

Solution #

The core issue here is that Django ModelForms automatically populate field values based on the attached model instance (if provided). To force all checkboxes to start unchecked, try one of these simple approaches:

Option 1: Set initial to an empty list when defining the field #

When you create the students field in the __init__ method, explicitly add the initial parameter set to an empty list. This overrides any default selections pulled from the instance:

class VisitForm(ModelForm):
    def __init__(self, queryset=None, *args, **kwargs):
        super(VisitForm, self).__init__(*args, **kwargs)
        if queryset:
            self.fields['students'] = forms.ModelMultipleChoiceField(
                queryset=queryset,
                widget=forms.CheckboxSelectMultiple(),
                initial=[]  # Ensures no options are pre-selected
            )

Option 2: Clear the initial value after field creation #

If you'd rather not set initial during field setup, you can explicitly reset it right after adding the field:

class VisitForm(ModelForm):
    def __init__(self, queryset=None, *args, **kwargs):
        super(VisitForm, self).__init__(*args, **kwargs)
        if queryset:
            self.fields['students'] = forms.ModelMultipleChoiceField(
                queryset=queryset,
                widget=forms.CheckboxSelectMultiple()
            )
            self.fields['students'].initial = []  # Override default selections

Option 3: Skip passing an instance (if your use case allows) #

If you don't need to load existing data from a model instance when rendering the form, just initialize the form without the instance argument. For example, in your view:

form = VisitForm(queryset=Student.objects.all())  # No instance = no pre-selected checkboxes

This works because without an instance, the form has no existing related objects to populate the field with, so all checkboxes remain unchecked by default.

Why This Works #

By default, ModelMultipleChoiceField uses the instance's related objects to set initial selections. Setting initial=[] explicitly tells the field to start empty, overriding the instance's data. If you're not using an instance, the field naturally starts with no selections.

内容的提问来源于stack exchange，提问作者Hanny