Djangoフォームで forms.Field.initial 属性を使ってフィールドの初期値を設定する

Djangoのforms.Field.initial

設定方法

forms.Field.initialは、フィールドのコンストラクタで設定できます。以下は例です。

from django.forms import forms

class MyForm(forms.Form):
  name = forms.CharField(initial='John Doe')

# フォームが最初に表示された時に、`name`フィールドには`John Doe`が表示されます。

また、initial属性は、フォームのビューで動的に設定することもできます。以下は例です。

from django.forms import forms
from django.shortcuts import render

def my_view(request):
  initial_value = request.GET.get('initial_value', '')
  form = MyForm(initial={'name': initial_value})

  return render(request, 'my_template.html', {'form': form})

# `?initial_value=Jane Doe`というクエリパラメータ付きでアクセスすると、
# `name`フィールドには`Jane Doe`が表示されます。

使用例

forms.Field.initialは、以下のような様々な場面で使用できます。

• フォームの初期値をデフォルト値で設定したい場合
• ユーザー入力に基づいてフォームの初期値を設定したい場合
• データベースから取得した値でフォームの初期値を設定したい場合

注意点

• forms.Field.initialは、フィールドの初期値を設定する属性です。フォームが送信された後、この値は変更される可能性があります。
• forms.Field.initialは、required属性と相互作用します。required=Trueの場合、ユーザーはフォーム送信時に値を入力する必要があります。

Django forms.Field.initial サンプルコード

初期値をデフォルト値で設定する

from django.forms import forms

class MyForm(forms.Form):
  name = forms.CharField(initial='John Doe')
  email = forms.EmailField(initial='[email protected]')

# フォームが最初に表示された時に、
# `name`フィールドには`John Doe`、
# `email`フィールドには`[email protected]`が表示されます。

ユーザー入力に基づいて初期値を設定する

from django.forms import forms
from django.shortcuts import render

def my_view(request):
  initial_name = request.GET.get('name', '')
  initial_email = request.GET.get('email', '')
  form = MyForm(initial={'name': initial_name, 'email': initial_email})

  return render(request, 'my_template.html', {'form': form})

# `?name=Jane Doe&[email protected]`というクエリパラメータ付きでアクセスすると、
# `name`フィールドには`Jane Doe`、
# `email`フィールドには`[email protected]`が表示されます。

データベースから取得した値で初期値を設定する

from django.forms import forms
from django.contrib.auth.models import User

class MyForm(forms.Form):
  user = forms.ModelChoiceField(queryset=User.objects.all(), initial=lambda: request.user)

# フォームが最初に表示された時に、
# `user`フィールドにはログイン中のユーザーが表示されます。

• initial属性は、フィールドごとに個別に設定できます。
• initial属性は、フォームのすべてのフィールドに設定できます。
• initial属性は、callable オブジェクトで設定することもできます。

Django forms.Field.initial の代替方法

フォームのコンストラクタで初期値を設定する

from django.forms import forms

class MyForm(forms.Form):
  def __init__(self, *args, **kwargs):
    super().__init__(*args, **kwargs)
    self.fields['name'].initial = 'John Doe'

# フォームが最初に表示された時に、
# `name`フィールドには`John Doe`が表示されます。

フォームのビューで初期値を設定する

from django.forms import forms
from django.shortcuts import render

def my_view(request):
  form = MyForm()
  form.fields['name'].initial = 'John Doe'

  return render(request, 'my_template.html', {'form': form})

# フォームが最初に表示された時に、
# `name`フィールドには`John Doe`が表示されます。

テンプレートで初期値を設定する

{% load widget_tweaks %}

<form action="{% url 'my_view' %}" method="post">
  {% csrf_token %}
  {{ form.as_p }}
</form>

<script>
  document.getElementById('id_name').value = 'John Doe';
</script>

カスタムフォームウィジェットを使用する

from django.forms import forms, widgets

class MyWidget(forms.Widget):
  def render(self, name, value, attrs=None):
    return '<input type="text" name="%s" value="%s" />' % (name, 'John Doe')

class MyForm(forms.Form):
  name = forms.CharField(widget=MyWidget())

# フォームが最初に表示された時に、
# `name`フィールドには`John Doe`が表示されます。

これらの方法は、それぞれ異なる利点と欠点があります。状況に応じて適切な方法を選択してください。