Django admin.ModelAdmin.add_form_template でモデル追加画面をカスタマイズ

Djangoのadmin.ModelAdmin.add_form_templateについて

django.contrib.admin.ModelAdmin.add_form_template は、Django管理サイトでモデルの追加画面をカスタマイズするためのオプションです。このオプションを使用すると、デフォルトのテンプレートではなく、独自のテンプレートを指定できます。

使い方

add_form_template オプションは、ModelAdmin クラスで設定します。テンプレートファイルは、admin/ ディレクトリ内に配置する必要があります。

from django.contrib import admin

class MyModelAdmin(admin.ModelAdmin):
    add_form_template = 'admin/my_add_form.html'

# モデルを管理サイトに登録
admin.site.register(MyModel, MyModelAdmin)

テンプレートファイルには、以下の変数が使用できます。

• form: モデルフォーム
• adminform: 管理サイト用のヘルパー
• readonly_fields: 読み取り専用フィールド
• model_admin: ModelAdmin クラスのインスタンス

例

以下は、add_form_template オプションを使用して、モデルの追加画面をカスタマイズする例です。

テンプレートファイル: admin/my_add_form.html

{% extends 'admin/base_site.html' %}

{% block content %}
<h1>{{ model_admin.opts.verbose_name }}を追加</h1>

<form action="" method="post">
{% csrf_token %}
{{ form.as_p }}
<input type="submit" value="保存">
</form>
{% endblock %}

この例では、以下のカスタマイズを行っています。

• ページタイトルを変更
• ヘッダーを追加
• 読み取り専用フィールドを非表示

補足

• add_form_template オプションは、Django 1.8 以降で使用できます。
• 複数のテンプレートを組み合わせて使用することもできます。
• テンプレートファイル内で、{% include %} タグを使用して、他のテンプレートファイルをインクルードすることができます。

• ModelAdmin クラスには、他にも多くのオプションがあります。詳細は、Django ドキュメントを参照してください。
• 管理サイトをカスタマイズする方法については、Django チュートリアルも参考にしてください。

django.contrib.admin.ModelAdmin.add_form_template オプションは、Django管理サイトでモデルの追加画面を簡単にカスタマイズするための便利な機能です。

Django admin.ModelAdmin.add_form_template サンプルコード

{% extends 'admin/base_site.html' %}

{% block content %}
<h1>{{ model_admin.opts.verbose_name }}を追加</h1>

<form action="" method="post">
{% csrf_token %}

  <div class="row">
    <div class="col-md-6">
      {{ form.first_name.label_tag }}
      {{ form.first_name }}
    </div>
    <div class="col-md-6">
      {{ form.last_name.label_tag }}
      {{ form.last_name }}
    </div>
  </div>

  <div class="row">
    <div class="col-md-12">
      {{ form.email.label_tag }}
      {{ form.email }}
    </div>
  </div>

  <input type="submit" value="保存">
</form>

{% endblock %}

読み取り専用フィールドを追加する

{% extends 'admin/base_site.html' %}

{% block content %}
<h1>{{ model_admin.opts.verbose_name }}を追加</h1>

<form action="" method="post">
{% csrf_token %}

  <div class="row">
    <div class="col-md-6">
      {{ form.first_name.label_tag }}
      {{ form.first_name }}
    </div>
    <div class="col-md-6">
      {{ form.last_name.label_tag }}
      {{ form.last_name }}
    </div>
  </div>

  <div class="row">
    <div class="col-md-12">
      {{ form.email.label_tag }}
      {{ form.email }}
    </div>
  </div>

  <div class="row">
    <div class="col-md-12">
      {{ form.created_at.label_tag }}
      {{ form.created_at.value }}
    </div>
  </div>

  <input type="submit" value="保存">
</form>

{% endblock %}

JavaScript を使用してフォームを動的に変更する

{% extends 'admin/base_site.html' %}

{% block content %}
<h1>{{ model_admin.opts.verbose_name }}を追加</h1>

<form action="" method="post">
{% csrf_token %}

  <div class="row">
    <div class="col-md-6">
      {{ form.first_name.label_tag }}
      {{ form.first_name }}
    </div>
    <div class="col-md-6">
      {{ form.last_name.label_tag }}
      {{ form.last_name }}
    </div>
  </div>

  <div class="row">
    <div class="col-md-12">
      {{ form.email.label_tag }}
      {{ form.email }}
    </div>
  </div>

  <script>
    $(document).ready(function() {
      // 姓が入力されたら、メールアドレスフィールドを必須にする
      $('#id_last_name').on('change', function() {
        if ($(this).val() !== '') {
          $('#id_email').attr('required', true);
        } else {
          $('#id_email').attr('required', false);
        }
      });
    });
  </script>

  <input type="submit" value="保存">
</form>

{% endblock %}

カスタムテンプレートタグを使用する

{% extends 'admin/base_site.html' %}

{% block content %}
<h1>{{ model_admin.opts.verbose_name }}を追加</h1>

<form action="" method="post">
{% csrf_token %}

{% load my_tags %}

  {% render_my_form_fields form %}

  <input type="submit" value="保存">
</form>

{% endblock %}

my_tags.py

from django.template import Library

register = Library()

@register.simple_tag
def render_my_form_fields(form):
  """
  フォームフィールドをレンダリングするカスタムテンプレートタグ
  """
  output = ''
  for field in

Django admin.ModelAdmin.add_form_template 他の方法

ModelAdmin クラスのメソッドをオーバーライドする

• ModelAdmin クラスには、add_view() メソッドなど、いくつかのメソッドをオーバーライドできます。
• これらのメソッドをオーバーライドすることで、追加画面の処理を自由にカスタマイズできます。

例:

from django.contrib import admin

class MyModelAdmin(admin.ModelAdmin):
    def add_view(self, request, form_url='', extra_context=None):
        # 追加画面の処理をカスタマイズ
        ...

# モデルを管理サイトに登録
admin.site.register(MyModel, MyModelAdmin)

admin_form_template を使用する

• admin_form_template オプションを使用して、モデル編集画面と追加画面の両方に適用されるテンプレートを指定できます。
• このテンプレートを使用して、画面全体のレイアウトをカスタマイズできます。

例:

from django.contrib import admin

class MyModelAdmin(admin.ModelAdmin):
    admin_form_template = 'admin/my_form.html'

# モデルを管理サイトに登録
admin.site.register(MyModel, MyModelAdmin)

my_form.html

{% extends 'admin/base_site.html' %}

{% block content %}
<h1>{{ model_admin.opts.verbose_name }}</h1>

{% if action == 'add' %}
  <h2>追加</h2>
{% else %}
  <h2>編集</h2>
{% endif %}

<form action="" method="post">
{% csrf_token %}

  {{ form.as_p }}

  <input type="submit" value="保存">
</form>

{% endblock %}

JavaScript を使用する

• JavaScript を使用して、追加画面の挙動を動的に変更できます。
• 例えば、フォームフィールドの表示・非表示を切り替えたり、バリデーションを追加したりできます。

例:

<script>
$(document).ready(function() {
  // 姓が入力されたら、メールアドレスフィールドを必須にする
  $('#id_last_name').on('change', function() {
    if ($(this).val() !== '') {
      $('#id_email').attr('required', true);
    } else {
      $('#id_email').attr('required', false);
    }
  });
});
</script>

カスタムビューを使用する

• 独自のビューを作成して、追加画面の処理を完全にカスタマイズできます。
• これは、複雑なカスタマイズが必要な場合に有効です。

例:

from django.contrib import admin
from django.views.generic import CreateView

class MyModelCreateView(CreateView):
    model = MyModel
    template_name = 'admin/my_add_form.html'

# URL を設定
urlpatterns = [
    path('admin/my_model/add/', MyModelCreateView.as_view(), name='my_model_add'),
]

my_add_form.html

<h1>{{ model_admin.opts.verbose_name }}を追加</h1>

<form action="" method="post">
{% csrf_token %}

  {{ form.as_p }}

  <input type="submit" value="保存">
</form>

admin.ModelAdmin.add_form_template は、Django 管理サイトのモデル追加画面をカスタマイズするための便利な機能です。

上記以外にも、さまざまな方法で追加画面をカスタマイズできます。

ニーズに合わせて適切な方法を選択してください。