Django の admin サイトLink to this heading#

他のトピックLink to this heading#

register デコレータLink to this heading#

register(*models, site=django.contrib.admin.sites.site)Link to this definition#

ModelAdmin を登録するために、デレコータも用意されています:

Code

from django.contrib import admin
from .models import Author


@admin.register(Author)
class AuthorAdmin(admin.ModelAdmin):
    pass

1 つ以上のモデルが与えられ、 ModelAdmin に登録されます。カスタムの AdminSite を使用している場合、site キーワード引数を使って渡してください:

Code

from django.contrib import admin
from .models import Author, Editor, Reader
from myproject.admin_site import custom_admin_site


@admin.register(Author, Reader, Editor, site=custom_admin_site)
class PersonAdmin(admin.ModelAdmin):
    pass

このデコレータは、model admin クラスをその __init__() メソッド内で参照する必要がある場合（例： super(PersonAdmin, self).__init__(*args, **kwargs) ）には使用できません。代わりに super().__init__(*args, **kwargs) のようにします。

admin ファイルを見つけるLink to this heading#

INSTALLED_APPS 設定内に 'django.contrib.admin' を記述すると、Django は自動的に各アプリケーション内で admin モジュールを探してインポートします。

class apps.AdminConfigLink to this definition#

これは、admin に対するデフォルトの AppConfig クラスです。Django が開始すると autodiscover() を呼び出します。

class apps.SimpleAdminConfigLink to this definition#

このクラスは AdminConfig と同じように動作しますが、autodiscover(() を呼び出しません。

default_siteLink to this definition#

これはデフォルトの admin サイトのクラスやサイトインスタンスを返す呼び出し可能オブジェクトへのドット区切りのインポートパスです。デフォルトは 'django.contrib.admin.sites.AdminSite' です。使い方は デフォルトの admin サイトをオーバーライドする を参照してください。

autodiscover()Link to this definition#

この関数は、インストールされた各アプリケーション内で admin モジュールをインポートするよう試みます。これらのモジュールは admin にモデルが登録されているものと想定されます。

通常、この機能を手動で呼び出す必要はありません。Django が開始するとき AdminConfig が呼び出してくれます。

カスタム AdminSite を使用している場合、通常はすべての ModelAdmin サブクラスをコードにインポートし、それらをカスタム AdminSite に登録します。その場合、自動検出を無効にするには、INSTALLED_APPS 設定で 'django.contrib.admin' の代わりに 'django.contrib.admin.apps.SimpleAdminConfig' を指定する必要があります。

ModelAdmin のオプションLink to this heading#

ModelAdmin は非常に柔軟にできています。インターフェイスをカスタマイズするために、様々なオプションが用意されています。すべてのプションは ModelAdmin サブクラスで定義します:

from django.contrib import admin


class AuthorAdmin(admin.ModelAdmin):
    date_hierarchy = "pub_date"

ModelAdmin.actionsLink to this definition#

チェンジリストページで有効化するアクションのリストです。詳細は 管理アクション を参照してください。

ModelAdmin.actions_on_topLink to this definition#

ModelAdmin.actions_on_bottomLink to this definition#

ページ上のどこにアクションバーが表示されかをコントロールします。デフォルトでは、admin チェンジリストはページのトップにアクションを表示します (actions_on_top = True; actions_on_bottom = False)。

ModelAdmin.actions_selection_counterLink to this definition#

アクションのドロップダウンの隣に選択用カウンターを表示するかどうかをコントロールします。デフォルトでは、admin チェンジリストは表示するようになっています (actions_selection_counter = True)。

ModelAdmin.date_hierarchyLink to this definition#

date_hierarchy をモデル内の DateField か DateTimeField の名前にセットすると、チェンジリストのページがそのフィールドによる日付ベースのドリルダウンナビゲーションを含むようになります。

実装例:

Code

date_hierarchy = "pub_date"

__ ルックアップを使用して、関連するモデルのフィールドを指定することもできます。たとえば:

Code

date_hierarchy = "author__pub_date"

この機能は、有効なデータに基づいて、適切に変化させます。たとえば、すべての日付が 1 月に収まっている場合、日のドリルダウンのみを表示します。

ModelAdmin.empty_value_displayLink to this definition#

この属性は、空(None、空の文字列、等)のレコードのフィールドに対するデフォルトの表示値をオーバーライドします。デフォルト値は - (ダッシュ)です。たとえば:

Code

from django.contrib import admin


class AuthorAdmin(admin.ModelAdmin):
    empty_value_display = "-empty-"

AdminSite.empty_value_display ですべての admin ページもしくは特定のフィールドに対して empty_value_display をオーバーライドすることもできます:

Code

from django.contrib import admin


class AuthorAdmin(admin.ModelAdmin):
    list_display = ["name", "title", "view_birth_date"]

    @admin.display(empty_value="???")
    def view_birth_date(self, obj):
        return obj.birth_date

ModelAdmin.excludeLink to this definition#

この属性を使用する場合、フォームから除外するフィールドの名称をリストで指定します。

たとえば、以下のモデルを考えてみましょう:

Code

from django.db import models


class Author(models.Model):
    name = models.CharField(max_length=100)
    title = models.CharField(max_length=3)
    birth_date = models.DateField(blank=True, null=True)

Author モデルに対するフォームが name と title の 2 つのフィールドのみを含むようにしたい場合、以下のように fields か exclude を指定することになります:

Code

from django.contrib import admin


class AuthorAdmin(admin.ModelAdmin):
    fields = ["name", "title"]


class AuthorAdmin(admin.ModelAdmin):
    exclude = ["birth_date"]

Author モデルが 3 つのフィールド (name、title、birth_date) しか持っていないので、上記の宣言によって生成されるフォームはまったく同じフィールドを持つことになります。

ModelAdmin.fieldsLink to this definition#

"add" と "change" 上のフォームでシンプルなレイアウト変更 (有効なフィールドのみ表示、順序の変更、行のグルーピングなど) を行うには、fields オプションを使用してください。たとえば、以下のように、django.contrib.flatpages.models.FlatPage モデルに対して admin フォームのよりシンプルなバージョンを定義できます。

Code

class FlatPageAdmin(admin.ModelAdmin):
    fields = ["url", "title", "content"]

上記の例では、指定したフィールド (url、title、content) だけが (結果として) フォーム上で表示されます。fields は ModelAdmin.readonly_fields で定義される値を持つことができ、読み取り専用で表示されます。

より複雑なレイアウトを作るには、fieldsets オプションを参照してください。

fields オプションは、list_display と同じタイプの値を受け付けますが、呼び出し可能オブジェクトや関連フィールドの __ ルックアップは受け付けません。モデルおよびモデル管理クラスのメソッド名は、readonly_fields にリストされている場合にのみ使用されます。

1 つの行に複数のフィールドを表示するには、タプルで囲んでください。この例では、url と title フィールドが同じ行に表示され、content フィールドは次の行に表示されます:

Code

class FlatPageAdmin(admin.ModelAdmin):
    fields = [("url", "title"), "content"]

fields オプションも fieldsets オプションも指定されない場合、 Django はデフォルトで次のように表示します。 AutoField ではなく、かつ editable=True が設定されている各フィールドを、モデル内で定義された順序で単一のフィールドセットに表示します。その後に readonly_fields で定義されたフィールドを表示します。

ModelAdmin.fieldsetsLink to this definition#

admin の "add" と "change" ページのレイアウトをコントロールするには、fieldsets をセットしてください。

fieldsets は、2 値タプルのリストで、各 2 値タプルは admin フォームページの <fieldset> を表します。 (<fieldset> はフォームの "section" です。)

2 値タプルのフォーマットは (name, field_options) で、name はフィールドセットのタイトル文字列を表し、field_options フィールドセットに関する情報のディクショナリで、表示するフィールドのリストを含みます。

django.contrib.flatpages.models.FlatPage モデルを用いた例は以下のようになります。

Code

from django.contrib import admin


class FlatPageAdmin(admin.ModelAdmin):
    fieldsets = [
        (
            None,
            {
                "fields": ["url", "title", "content", "sites"],
            },
        ),
        (
            "Advanced options",
            {
                "classes": ["collapse"],
                "fields": ["registration_required", "template_name"],
            },
        ),
    ]

これにより、admin ページは以下のような見た目となります:

fieldsets と fields オプションのどちらも存在しない場合、Django はデフォルトで AutoField と editable=True 以外の各フィールドを、単一のフィールドセットで、モデル内でフィールドが定義されたとおりの順番で表示します。

field_options ディクショナリは以下のキーを持つことができます:

• fields

  フィールドセット内に表示するフィールド名のリストまたはタプルです。このキーは必須です。

  実装例:

  Code

  {
      "fields": ["first_name", "last_name", "address", "city", "state"],
  }
  

  fields オプションと同様に、複数のフィールドを 1 行に表示するにはタプルでこれらのフィールドを囲んでください。この例では、first_name と last_name フィールドが 1 つの行に表示されます。

  Code

  {
      "fields": [("first_name", "last_name"), "address", "city", "state"],
  }
  

  fields は ModelAdmin.readonly_fields で定義される値を持つことができ、読み取り専用で表示されます。

  fields に呼び出し可能オブジェクトの名前を追加した場合、fields オプションと同じルールが適用されます: 呼び出し可能オブジェクトは readonly_fields 内でリスト化される必要があります。

• classes

  フィールドセットに適用する追加のCSSクラスを含むリストまたはタプルです。これには、プロジェクト内で定義されたカスタムCSSクラスや、Djangoが提供するCSSクラスを含めることができます。デフォルトの管理サイトのCSSスタイルシート内では、特に役立つ2つのクラス、collapse と wide が定義されています。

  実装例:

  Code

  {
      "classes": ["wide", "collapse"],
  }
  

  wide スタイルが適用されたフィールドセットは、管理インターフェースで追加の横幅が与えられます。collapse スタイルが適用された名前付きフィールドセットは、初期状態で折りたたまれ、表示/非表示を切り替えるための展開可能なウィジェットが使用されます。

• description

  各フィールドセットの見出しの下に表示されるオプションの追加テキストの文字列です。

  この値は、管理インターフェイスに表示されるときにはHTMLエスケープされないことに注意してください。これにより、HTML を含めることができます。あるいは、プレーンテキストと django.utils.html.escape() を使って HTML の特殊文字をエスケープすることもできます。

ModelAdmin.filter_horizontalLink to this definition#

デフォルトでは、ManyToManyField は <select multiple> で admin サイトで表示されます。複数選択のボックスは、たくさんのアイテムを選択するには不向きです。ManyToManyField をこのリストに加えると、代わりにかっこよくて控えめな JavaScript の "filter" インターフェースを使用します。非選択および選択済みのオプションは 2 つのボックスに並べて表示されます。垂直方向のインターフェースを使用するには filter_vertical を参照してください。

ModelAdmin.filter_verticalLink to this definition#

filter_horizontal と同じですが、フィルタインターフェイスを垂直方向に表示し、非選択のオプションは選択済みのオプションの上部に表示されます。

ModelAdmin.formLink to this definition#

デフォルトではモデルに対して ModelForm が動的に生成されます。追加と変更の両方のページで使用されるフォームです。独自の ModelForm を定義すれば、追加と変更のページでフォームの挙動を簡単にオーバーライドできます。あるいは、まったく新しいモデルフォームを作る代わりに、ModelAdmin.get_form() メソッドを使ってデフォルトのフォームをカスタムすることもできます。

例については カスタムのバリデーションを admin に追加する を参照してください。

ModelAdmin.formfield_overridesLink to this definition#

admin 内で使用するための Field のうちある程度の部分をオーバーライドする簡単 (だけど汚い) 方法を提供します。formfield_overrides はディクショナリで、フィールドクラスの構成時にフィールドに渡す引数のディクショナリをマッピングします。

これでは抽象的すぎるので、具体的な例を見てみましょう。formfield_overrides のもっとも一般的な使い道は、特定のタイプのフィールドに対してカスタムしたウィジェットを追加することです。大きなテキストフィールドを使用するために、デフォルトの <textarea> の代わりに RichTextEditorWidget を使いたいとしましょう。この場合、以下のように記述します。

Code

from django.contrib import admin
from django.db import models

# Import our custom widget and our model from where they're defined
from myapp.models import MyModel
from myapp.widgets import RichTextEditorWidget


class MyModelAdmin(admin.ModelAdmin):
    formfield_overrides = {
        models.TextField: {"widget": RichTextEditorWidget},
    }

ディクショナリ内のキーは文字列 ではなく 実際のフィールドクラスである点に注意してください。値は別のディクショナリです; これらの引数はフォームフィールドの __init__() メソッドに渡されます。詳細は フォーム API を参照してください。

ModelAdmin.inlinesLink to this definition#

後述の InlineModelAdmin オブジェクトと ModelAdmin.get_formsets_with_inlines() を参照してください。

ModelAdmin.list_displayLink to this definition#

admin のチェンジリストページでどのフィールドを表示するかコントロールするために、list_display をセットします。

実装例:

Code

list_display = ["first_name", "last_name"]

list_display をセットしない場合、admin サイトは各オブジェクトの __str__() 表現を表示する単一の列を表示します。

list_display で使用できる値は5種類あります。最も簡単なもの以外は、フィールドの表示方法をカスタマイズするために display() デコレーターを使用できます。

• モデルフィールドの名前。次に例を示します。

  Code

  class PersonAdmin(admin.ModelAdmin):
      list_display = ["first_name", "last_name"]
  

• リレーション先フィールドの名前を __ 表記で記述します。例えば、次のようにします。

  Code

  class PersonAdmin(admin.ModelAdmin):
      list_display = ["city__name"]
  

• 1 つの引数 (モデルのインスタンス) を受け入れる呼び出し可能オブジェクトです。次に例を示します。

  Code

  @admin.display(description="Name")
  def upper_case_name(obj):
      return f"{obj.first_name} {obj.last_name}".upper()
  
  
  class PersonAdmin(admin.ModelAdmin):
      list_display = [upper_case_name]
  

• 1 つの引数 (モデルのインスタンス) を受け入れる ModelAdmin メソッドを表す文字列です。次に例を示します。

  Code

  class PersonAdmin(admin.ModelAdmin):
      list_display = ["upper_case_name"]
  
      @admin.display(description="Name")
      def upper_case_name(self, obj):
          return f"{obj.first_name} {obj.last_name}".upper()
  

• モデルの属性や (必須の引数を持たない) メソッドを表す文字列です。次に例を示します。

  Code

  from django.contrib import admin
  from django.db import models
  
  
  class Person(models.Model):
      name = models.CharField(max_length=50)
      birthday = models.DateField()
  
      @admin.display(description="Birth decade")
      def decade_born_in(self):
          decade = self.birthday.year // 10 * 10
          return f"{decade}’s"
  
  
  class PersonAdmin(admin.ModelAdmin):
      list_display = ["name", "decade_born_in"]
  

list_display に関する特殊な状況の注意点があります。

• フィールドが ForeignKey の場合、 Django はリレーション先オブジェクトの __str__() を表示します。

• ManyToManyField フィールドは、テーブル内で各行に対して個別の SQL ステートメントを実行する可能性があるため、サポートされていません。それでも使いたい場合は、モデルにカスタムメソッドを作成し、そのメソッドの名前を list_display に追加してください。 (list_display 内でのカスタムメソッドについてより詳しくは下記を参照してください。)

• フィールドが BooleanField の場合、Django は True, False, None の代わりに、かわいい "yes", "no", "unknown" アイコンを表示します。

• 与えられた文字列がモデル、ModelAdmin、呼び出し可能オブジェクトのどれかの場合、Django はデフォルトで HTML エスケープして出力します。ユーザーの入力をエスケープしたり非エスケープのタグを使う場合、format_html() を使用してください。

  以下は、モデルの例です。

  Code

  from django.contrib import admin
  from django.db import models
  from django.utils.html import format_html
  
  
  class Person(models.Model):
      first_name = models.CharField(max_length=50)
      last_name = models.CharField(max_length=50)
      color_code = models.CharField(max_length=6)
  
      @admin.display
      def colored_name(self):
          return format_html(
              '<span style="color: #{};">{} {}</span>',
              self.color_code,
              self.first_name,
              self.last_name,
          )
  
  
  class PersonAdmin(admin.ModelAdmin):
      list_display = ["first_name", "last_name", "colored_name"]
  

• これまでの例で見てきたように、呼び出し可能オブジェクト、モデルメソッド、または ModelAdmin メソッドを使用する場合、 display() デコレータで呼び出し可能オブジェクトをラップし、 description 引数を渡すことで、カラムのタイトルをカスタマイズできます。

• フィールドの値が None、空の文字列、エレメントを持たない iterable のいずれかの場合、Django は - (ダッシュ) を表示します。この挙動は AdminSite.empty_value_display でオーバーライドできます。

  Code

  from django.contrib import admin
  
  admin.site.empty_value_display = "(None)"
  

  ModelAdmin.empty_value_display も使用できます。

  Code

  class PersonAdmin(admin.ModelAdmin):
      empty_value_display = "unknown"
  

  もしくは、フィールドレベルで以下のようにできます。

  Code

  class PersonAdmin(admin.ModelAdmin):
      list_display = ["name", "birth_date_view"]
  
      @admin.display(empty_value="unknown")
      def birth_date_view(self, obj):
          return obj.birth_date
  

• 与えられた文字列がモデル ModelAdmin のメソッドか、 True, False, None を返す呼び出し可能オブジェクトの場合、 Django はそのメソッドを display() デコレータでラップし、 boolean 引数を True で渡すと、かわいい "yes", "no", "unknown" アイコンを表示します。

  Code

  from django.contrib import admin
  from django.db import models
  
  
  class Person(models.Model):
      first_name = models.CharField(max_length=50)
      birthday = models.DateField()
  
      @admin.display(boolean=True)
      def born_in_fifties(self):
          return 1950 <= self.birthday.year < 1960
  
  
  class PersonAdmin(admin.ModelAdmin):
      list_display = ["name", "born_in_fifties"]
  

• __str__() メソッドは、他のモデルメソッドとまったく同様に list_display 内でも有効です。つまり、以下のような書き方は完璧に OK です。

  Code

  list_display = ["__str__", "some_other_field"]
  

• 通常、実際のデータベースフィールドではない list_display の要素は、ソートに使用できません (Django のソートはすべてデータベースレベルで実行されるためです)。

  しかし、list_display の要素が特定のデータベースフィールドを表す場合、メソッドに display() デコレータを使用し、 ordering 引数を渡すことで、その事実を伝えることができます。

  Code

  from django.contrib import admin
  from django.db import models
  from django.utils.html import format_html
  
  
  class Person(models.Model):
      first_name = models.CharField(max_length=50)
      color_code = models.CharField(max_length=6)
  
      @admin.display(ordering="first_name")
      def colored_first_name(self):
          return format_html(
              '<span style="color: #{};">{}</span>',
              self.color_code,
              self.first_name,
          )
  
  
  class PersonAdmin(admin.ModelAdmin):
      list_display = ["first_name", "colored_first_name"]
  

  上記のコードは、admin 内で colored_first_name で ソートしようとするとき、first_name フィールドで並べ替えるよう Django に伝えます。

  引数 ordering で降順を示すには、フィールド名の前にハイフンをつけます。上記の例を使うと、次のようになります。

  Code

  @admin.display(ordering="-first_name")
  def colored_first_name(self): ...
  

  引数 Lordering はリレーション先モデルの値でソートするクエリのルックアップをサポートします。この例では、"author first name" カラムをリストに表示し、first name でソートできるようにしています。

  Code

  class Blog(models.Model):
      title = models.CharField(max_length=255)
      author = models.ForeignKey(Person, on_delete=models.CASCADE)
  
  
  class BlogAdmin(admin.ModelAdmin):
      list_display = ["title", "author", "author_first_name"]
  
      @admin.display(ordering="author__first_name")
      def author_first_name(self, obj):
          return obj.author.first_name
  

  クエリ式 は ordering 引数と一緒に使うことができます。

  Code

  from django.db.models import Value
  from django.db.models.functions import Concat
  
  
  class Person(models.Model):
      first_name = models.CharField(max_length=50)
      last_name = models.CharField(max_length=50)
  
      @admin.display(ordering=Concat("first_name", Value(" "), "last_name"))
      def full_name(self):
          return self.first_name + " " + self.last_name
  

• list_display の要素はプロパティにすることもできます。

  Code

  class Person(models.Model):
      first_name = models.CharField(max_length=50)
      last_name = models.CharField(max_length=50)
  
      @property
      @admin.display(
          ordering="last_name",
          description="Full name of the person",
          boolean=False,
      )
      def full_name(self):
          return self.first_name + " " + self.last_name
  
  
  class PersonAdmin(admin.ModelAdmin):
      list_display = ["full_name"]
  

  ただし、@property は @display より上でなければなりません。display() デコレータを使用するのではなく、直接表示関連の属性を設定する古い方法を使用している場合は、@property デコレータではなく、property() 関数を使用しなければならないことに注意してください。

  Code

  def my_property(self):
      return self.first_name + " " + self.last_name
  
  
  my_property.short_description = "Full name of the person"
  my_property.admin_order_field = "last_name"
  my_property.boolean = False
  
  full_name = property(my_property)
  

• list_display のフィールド名はHTMLの出力でも <th> 要素に column-<field_name> という形でCSSクラスとして表示されます。これは例えばCSSファイルでカラムの幅を設定するのに使うことができます。

• Django は、list_display の各要素を以下の順番で解釈しようとします。

  • モデルのフィールド、またはリレーション先のフィールド由来のフィールド。

  • 呼び出し可能オブジェクト。

  • ModelAdmin 属性を表す文字列。

  • モデル属性を表す文字列。

  たとえば、first_name がモデルフィールドと ModelAdmin 属性の両方で存在する場合、モデルフィールドの方が使用されます。

ModelAdmin.list_display_linksLink to this definition#

list_display 内のフィールドにおいて "変更" ページへのリンクをコントロールするには、list_display_links を使用してください。

デフォルトでは、チェンジリストページは最初のカラム (list_display で最初に指定したフィールド) に各アイテムの変更ページへのリンクが貼られています。しかし、list_display_links を使って変更できます。

• リンクを貼らない場合は None をセットしてください。

• (list_display と同様のフォーマットで) リンクに変換したいカラムのフィールドのリストないしタプルをセットしてください。

  1 つないし複数のフィールドを指定できます。list_display にある限り、Django はいくつのフィールドがリンクになろうと気にしません。唯一の要件は、list_display_links をこの方式で使いたいときは list_display を指定することです。

以下の例では、first_name と last_name フィールドがチェンジリストページでリンクされます。

Code

class PersonAdmin(admin.ModelAdmin):
    list_display = ["first_name", "last_name", "birthday"]
    list_display_links = ["first_name", "last_name"]

以下の例では、チェンジリストページのグリッドにはリンクがなくなります。

Code

class AuditEntryAdmin(admin.ModelAdmin):
    list_display = ["timestamp", "message"]
    list_display_links = None

ModelAdmin.list_editableLink to this definition#

チェンジリストページ上での編集を有効にしたいモデルのフィールド名のリストを list_editable にセットしてください。list_editable に指定されたフィールドは、チェンジリストページ上でフォームウィジェットとして表示され、ユーザーは複数の行を一度に編集して保存できます。

ModelAdmin.list_filterLink to this definition#

admin のチェンジリストページの右サイドバーのフィルタを有効化するには、list_filter をセットしてください。

最もシンプルな list_filter はフィルタリングを有効にするフィールド名のリストまたはタプルを受け取りますが、より高度なオプションもいくつか用意されています。詳細は ModelAdmin リストフィルタ を参照してください。

ModelAdmin.list_max_show_allLink to this definition#

"Show all" の admin チェンジリストページで表示するアイテム数をコントロールするには、list_max_show_all をセットしてください。チェンジリストページの "Show all" リンクは、この設定値以下の場合のみ表示されます。デフォルトでは 200 にセットされています。

ModelAdmin.list_per_pageLink to this definition#

ページ分割された admin のチェンジリストページに表示するアイテム数をコントロールするには、list_per_page をセットしてください。デフォルトでは 100 にセットされています。

ModelAdmin.list_select_relatedLink to this definition#

admin のチェンジリストページでオブジェクトのリストを検索するときに select_related() を使用するよう Django に伝えるには、list_select_related をセットしてください。これにより多くのデータベースクエリを削減できます。

値は真偽値、リスト、タプルのどれかでなければなりません。デフォルトは False です。

値が True のとき、常に select_related() が呼ばれます。False のときは、ForeignKey が存在する場合 Django は list_display を参照して select_related() を呼び出します。

よりきめ細やかにコントロールする場合は、list_select_related の値にタプル (ないしリスト) を使用してください。空のタプルは、Django が select_related を一切呼び出さないようにします。他のタプルは、パラメータとして直接 select_related に渡されます。次に例を示します。

Code

class ArticleAdmin(admin.ModelAdmin):
    list_select_related = ["author", "category"]

これは select_related('author', 'category') を呼び出します。

リクエストに基づいた動的な値を指定する場合は、get_list_select_related() メソッドを実装できます。

ModelAdmin.orderingLink to this definition#

Django の admin ビューでオブジェクトのリストをどのようにソートするかを指定するには、 ordering をセットしてください。モデルの ordering パラメータと同じフォーマットでリストかタプルを与えてください。

指定がない場合、Django admin はモデルのデフォルトの並び順を使用します。

動的なソートを指定する場合 (例えばユーザーや言語に応じて変更する場合など)、get_ordering() メソッドを実装できます。

ModelAdmin.paginatorLink to this definition#

ページ分割に使われる paginator クラスです。デフォルトでは django.core.paginator.Paginator が使われます。カスタムの paginator クラスが django.core.paginator.Paginator と同じコンストラクタインターフェースを持たない場合、ModelAdmin.get_paginator() に対する実装も行う必要があります。

ModelAdmin.prepopulated_fieldsLink to this definition#

prepopulated_fields を、フィールド名と事前入力するフィールドをマッピングした辞書に設定します。

Code

class ArticleAdmin(admin.ModelAdmin):
    prepopulated_fields = {"slug": ["title"]}

設定された場合、指定されたフィールドは割り当てられたフィールドから入力するために JavaScript を使用します。この機能の主な用途は、1つ以上の他のフィールドから SlugField フィールドの値を自動的に生成することです。生成される値はソースフィールドの値を連結し、その結果を有効なスラグに変換することで生成されます (たとえば、ダッシュをスペースに置き換えたり、ASCII 文字を小文字にしたりします)。

事前入力されたフィールドは値が保存された後に JavaScript によって変更されることはありません。通常、スラグが変更されることは望ましくありません (スラグがオブジェクトで使用されている場合、オブジェクトの URL が変更されることになります)。

prepopulated_fields は DateTimeField、ForeignKey、OneToOneField、ManyToManyField フィールドを受け入れません。

ModelAdmin.preserve_filtersLink to this definition#

デフォルトでは、オブジェクトを作成、編集、削除しても、適用されたフィルタはリストビューに保存されます。この属性を False に設定することで、フィルタをクリアできます。

ModelAdmin.show_facetsLink to this definition#

管理画面のチェンジリストのフィルタにファセット数を表示するかどうかを制御します。デフォルトは ShowFacets.ALLOW です。

表示されている場合、ファセット数は現在適用されているフィルタに合わせて更新されます。

class ShowFacetsLink to this definition#

ModelAdmin.show_facets に指定できる値の Enum。

ALWAYSLink to this definition#

常にファセット数を表示します。

ALLOWLink to this definition#

クエリ文字列パラメータ _facets が指定された場合に、ファセット数を表示します。

NEVERLink to this definition#

ファセット数を表示しません。

show_facets に必要な ShowFacets の値を指定します。例えば、クエリパラメータを指定することなく常にファセット数を表示したい場合:

Code

from django.contrib import admin


class MyModelAdmin(admin.ModelAdmin):
    ...
    # Have facets always shown for this model admin.
    show_facets = admin.ShowFacets.ALWAYS

ModelAdmin.radio_fieldsLink to this definition#

デフォルトでは、ForeignKey や choices がセットされたフィールドに対して、Django の admin はセレクトボックスのインターフェース (<select>) を使用します。フィールドが radio_fields に指定された場合、Django は代わりに ラジオボタンのインターフェースを使用します。group が Person モデルの ForeignKey だと仮定すると、次のようになります。

Code

class PersonAdmin(admin.ModelAdmin):
    radio_fields = {"group": admin.VERTICAL}

django.contrib.admin モジュールから HORIZONTAL か VERTICAL のどちらを使用するか選択してください。

ForeignKey ないし choices がセットされたフィールド以外は、radio_fields に含めないでください。

ModelAdmin.autocomplete_fieldsLink to this definition#

autocomplete_fields は、Select2 オートコンプリート入力に変更したい ForeignKey ないし ManyToManyField フィールドのリストです。

デフォルトでは、これらのフィールドに対して admin はセレクトボックスのインターフェース (<select>) を使用します。ドロップダウン内に表示する関係インスタンスをすべて選択するオーバーヘッドから逃れたいこともあるでしょう。

Select2 入力はデフォルトの入力と似た見た目ですが、非同期的にオプションを読み込む検索機能を持っています。こちらの方が高速で、特に関係モデルに多くのインスタンスがある場合にはユーザーフレンドリーです。

オートコンプリート検索はリレーション先オブジェクトの ModelAdmin を使用するため、ModelAdmin に search_fields を定義する必要があります。

認可されていないデータが漏洩されるのを防ぐため、オートコンプリートを使うには、ユーザーは必ずリレーション先オブジェクトに対する view か change 権限を持っていなければなりません。

結果のソートおよびページ分割は、関係する ModelAdmin の get_ordering() と get_paginator() メソッドでコントロールします。

以下の例では、ChoiceAdmin フィールドは Question への ForeignKey に対するオートコンプリートフィールドを持ちます。結果は question_text フィールドによりフィルタされ、また date_created フィールドにより並べ替えられます:

Code

class QuestionAdmin(admin.ModelAdmin):
    ordering = ["date_created"]
    search_fields = ["question_text"]


class ChoiceAdmin(admin.ModelAdmin):
    autocomplete_fields = ["question"]

ModelAdmin.raw_id_fieldsLink to this definition#

デフォルトでは、ForeignKey のフィールドに対して Django の admin はセレクトボックスのインターフェース (<select>) を使用します。ドロップダウン内に表示する関係インスタンスをすべて選択するオーバーヘッドから逃れたいこともあるでしょう。

raw_id_fields は、ForeignKey や ManyToManyField に対する Input ウィジェットを適用したいフィールドのリストです:

Code

class ArticleAdmin(admin.ModelAdmin):
    raw_id_fields = ["newspaper"]

raw_id_fields Input ウィジェットには、ForeignKey の場合はプライマリキーを、ManyToManyField の場合はカンマで区切った値のリストを入力します。raw_id_fields ウィジェットには、ユーザーが値を検索および選択できるよう、隣にルーペボタンがあります:

ModelAdmin.readonly_fieldsLink to this definition#

デフォルトでは、すべてのフィールドが編集可能となっています。このオプションに含まれるフィールド (list か tuple で指定します) は、データをそのまま表示するだけで編集できなくなります。また、追加と編集に使われる ModelForm からも除外されます。 ModelAdmin.fields か ModelAdmin.fieldsets を指定した場合、read-only のフィールドは表示のために存在している必要があります (存在しなければ無視されます)。

ModelAdmin.fields や ModelAdmin.fieldsets で明示的に並び順を定義しないで readonly_fields を使った場合、これらのフィールドはすべての編集可能なフィールドの後に表示されます。

read-only のフィールドはモデルのフィールドからデータを表示するだけではなく、モデルや ModelAdmin クラス自身のメソッドの出力を表示させることもできます。これは ModelAdmin.list_display の挙動に似ています。これにより、編集中のオブジェクトのステータスのフィードバックを admin インターフェースに与えることができるようになります。たとえば:

Code

from django.contrib import admin
from django.utils.html import format_html_join
from django.utils.safestring import mark_safe


class PersonAdmin(admin.ModelAdmin):
    readonly_fields = ["address_report"]

    # description functions like a model field's verbose_name
    @admin.display(description="Address")
    def address_report(self, instance):
        # assuming get_full_address() returns a list of strings
        # for each line of the address and you want to separate each
        # line by a linebreak
        return format_html_join(
            mark_safe("<br>"),
            "{}",
            ((line,) for line in instance.get_full_address()),
        ) or mark_safe("<span class='errors'>I can't determine this address.</span>")

ModelAdmin.save_asLink to this definition#

admin のチェンジーフォームで "新規に保存" 機能を有効化するには save_as をセットしてください。

通常、オブジェクトには 3 つの保存オプションがあります: "保存"、"保存して編集を続ける"、"保存して 1 つ追加" です。save_as が True の場合、"保存して 1 つ追加" が "新規に保存" ボタンに変更され、既存のオブジェクトを変更するのではなく (新しい ID) で新規のオブジェクトが作成されるようになります。

デフォルトでは save_as は False にセットされています。

ModelAdmin.save_as_continueLink to this definition#

save_as=True のとき、新規オブジェクトを保存した後のデフォルトのリダイレクト先はそのオブジェクトの変更ビューです。save_as_continue=False にセットすると、リダイレクト先がチェンジリストビューになります。

デフォルトでは save_as_continue は True にセットされています。

ModelAdmin.save_on_topLink to this definition#

admin のチェンジフォームの上部に保存ボタンを追加するには save_on_top をセットしてください。

通常、保存ボタンはフォームの下部のみに表示されます。save_on_top をセットすると、ボタンは上部と下部の両方に表示されるようになります。

デフォルトでは save_on_top は False にセットされています。

ModelAdmin.search_fieldsLink to this definition#

admin のチェンジリストページで検索ボックスを有効化するには search_fields をセットしてください。セットするのはフィールド名のリストで、ここで指定したフィールドはテキストボックス内での検索クエリの対象となります。

指定するフィールドの種類は、CharField や TextField といったテキストフィールドである必要があります。ルックアップ API の "follow" 記法を使えば ForeignKey や ManyToManyField をルックアップすることもできます。

Code

search_fields = ["foreign_key__related_fieldname"]

たとえば、著者の情報を持つブログエントリーの場合、以下の定義により、著者のメールアドレスによるブログエントリーの検索が可能となります。

Code

search_fields = ["user__email"]

検索ボックスで検索が行われるとき、Django は検索クエリを単語に分割し、(icontains ルックアップを使って) 大文字と小文字を区別しない各単語を含むオブジェクトを返します。各単語は最低 1 つの search_fields に含まれている必要があります。例えば、search_fields が ['first_name', 'last_name'] にセットされ、ユーザーが john lennon と検索した場合、Django は SQL の WHERE 節と同等の検索を実行します。

SQL

WHERE (first_name ILIKE '%john%' OR last_name ILIKE '%john%')
AND (first_name ILIKE '%lennon%' OR last_name ILIKE '%lennon%')

検索クエリには空白を含む引用句を含めることができます。たとえば、ユーザが "john winston" や 'john winston' を検索した場合、 Django はこの SQL の WHERE 句と等価な処理を行います。

SQL

WHERE (first_name ILIKE '%john winston%' OR last_name ILIKE '%john winston%')

もし icontains ルックアップを使用したくない場合は、フィールドに追加することで任意のルックアップを使用できます。例えば、search_fields を ['first_name__exact'] に設定することで、exact を使用できます。

いくつかの (古い) ショートカットを使って、フィールドルックアップを指定することもできます。以下の文字で search_fields 内のフィールドにプレフィックスを追加できます。これはフィールドに __<lookup> を追加するのと同等です。

プレフィックス	ルックアップ
^	istartswith
=	iexact
@	search
None	icontains

検索方法をカスタムする必要がある場合は、ModelAdmin.get_search_results() を使って追加的もしくは代替の検索方法を提供できます。

ModelAdmin.search_help_textLink to this definition#

search_help_text には検索ボックスの下に表示される説明文を指定します。

ModelAdmin.show_full_result_countLink to this definition#

フィルタリングされた admin ページにオブジェクトのカウント (例: 99 results (103 total)) を表示するかどうかをコントロールするには、show_full_result_count をセットしてください。False にセットすると、代わりに 99 results (Show all) のような文字列が表示されるようになります。

デフォルトの show_full_result_count=True は、テーブル内の全アイテムをカウントするクエリを発行するため、多くの行を含むテーブルではパフォーマンス低下の原因となります。

ModelAdmin.sortable_byLink to this definition#

デフォルトでは、チェンジリストページでは list_display で指定された全てのモデルフィールド (および display() デコレータの ordering 引数を使用する呼び出し可能オブジェクト、または admin_order_field 属性を持つ呼び出し可能オブジェクト) によるソートが可能です。

特定のカラムでのソートを無効化したい場合、 sortable_by に list_display サブセットのコレクション (例: list 、 tuple 、 set) をセットしてください。空のコレクションを指定すると、すべてのカラムでソート不可となります。

リストを動的に指定する必要があるときは、代わりに get_sortable_by() メソッドを実装してください。

ModelAdmin.view_on_siteLink to this definition#

"サイトで見る" リンクを表示するか否かをコントロールするには、view_on_site をセットしてください。このリンクは保存されたオブジェクトを表示できる URL に誘導します。

値は、真偽値か呼び出し可能オブジェクトで指定します。True (デフォルトです) の場合、オブジェクトの get_absolute_url() メソッドが使われ、URLが生成されます。

モデルが get_absolute_url() メソッドを持っていても "サイトで見る" ボタンを表示したくない場合は、view_on_site に False をセットしてください:

Code

from django.contrib import admin


class PersonAdmin(admin.ModelAdmin):
    view_on_site = False

呼び出し可能オブジェクトの場合、引数にモデルのインスタンスを受け入れます。例えば:

Code

from django.contrib import admin
from django.urls import reverse


class PersonAdmin(admin.ModelAdmin):
    def view_on_site(self, obj):
        url = reverse("person-detail", kwargs={"slug": obj.slug})
        return "https://example.com" + url

ModelAdmin のメソッドLink to this heading#

ModelAdmin.save_model(request, obj, form, change)Link to this definition#

save_model メソッドには、HttpRequest、モデルのインスタンス、ModelForm のインスタンス、追加か変更かを表す真偽値が渡されます。このメソッドをオーバーライドすると、保存の前後に操作を追加できます。super().save_model() を呼び出して、Model.save() を使ってオブジェクトを保存してください。

例えば、保存前にオブジェクトに request.user を追加するには:

Code

from django.contrib import admin


class ArticleAdmin(admin.ModelAdmin):
    def save_model(self, request, obj, form, change):
        obj.user = request.user
        super().save_model(request, obj, form, change)

ModelAdmin.delete_model(request, obj)Link to this definition#

delete_model には、HttpRequest とモデルのインスタンスが渡されます。このメソッドをオーバーライドすると、削除の前後に操作を追加できます。super().delete_model() を呼び出して、Model.delete() を使ってオブジェクトを削除してください。

ModelAdmin.delete_queryset(request, queryset)Link to this definition#

delete_queryset() には、HttpRequest と削除するオブジェクトの QuerySet が渡されます。このメソッドをオーバーライドすると、"選択したオブジェクトの削除" アクション に対する削除のプロセスをカスタムできます。

ModelAdmin.save_formset(request, form, formset, change)Link to this definition#

save_formset メソッドには、HttpRequest、親 ModelForm のインスタンス、親オブジェクトの追加か変更かを表す真偽値が与えられます。

たとえば、変更のあったフォームセットのモデルのインスタンスそれぞれに request.user を追加するには、次のようにします。

Code

class ArticleAdmin(admin.ModelAdmin):
    def save_formset(self, request, form, formset, change):
        instances = formset.save(commit=False)
        for obj in formset.deleted_objects:
            obj.delete()
        for instance in instances:
            instance.user = request.user
            instance.save()
        formset.save_m2m()

関連項目: フォームセット内のオブジェクトを保存する

ModelAdmin.get_ordering(request)Link to this definition#

get_ordering メソッドは引数に request を取り、ordering のときと同じような list か tuple を返すことが期待されます。次に例を示します。

Code

class PersonAdmin(admin.ModelAdmin):
    def get_ordering(self, request):
        if request.user.is_superuser:
            return ["name", "rank"]
        else:
            return ["name"]

ModelAdmin.get_search_results(request, queryset, search_term)Link to this definition#

get_search_results メソッドは、検索語と一致するオブジェクトを表示するための、オブジェクトのリストを修正します。リクエスト、現在のフィルタを適用するクエリセット、 ユーザーが入力した検索語を受け取ります。 検索を実行するために修正されたクエリセットと、結果に重複があるかどうかを表す真偽値を含むタプルを返します。

デフォルトの実装では、ModelAdmin.search_fields に含まれるフィールドを検索します。

このメソッドは、独自の検索方法でオーバーライドできます。例えば、数値のフィールドで検索したり、Solr や Haystack といった外部のツールを使うことができます。独自の検索方法によって実装されたクエリセットの変更が結果に重複を生じさせるかを確認し、返値の 2 番目の要素に True を返す必要があります。

たとえば、name と age で検索するには、以下のように使います。

Code

class PersonAdmin(admin.ModelAdmin):
    list_display = ["name", "age"]
    search_fields = ["name"]

    def get_search_results(self, request, queryset, search_term):
        queryset, may_have_duplicates = super().get_search_results(
            request,
            queryset,
            search_term,
        )
        try:
            search_term_as_int = int(search_term)
        except ValueError:
            pass
        else:
            queryset |= self.model.objects.filter(age=search_term_as_int)
        return queryset, may_have_duplicates

この実装は、数値フィールドに対して文字列比較を行う search_fields = ('name', '=age') に比べて、はるかに効率的です... たとえば PostgreSQL では ... OR UPPER("polls_choice"."votes"::text) = UPPER('4') となります。

ModelAdmin.save_related(request, form, formsets, change)Link to this definition#

save_related メソッドには、HttpRequest、親 ModelForm のインスタンス、インラインフォームセットのリスト、親の追加か変更かを表す真偽値が与えられます。このメソッドで、保存の前後に親に対するリレーション先オブジェクトに対する操作を追加できます。この時点では親オブジェクトとそのフォームはすでに保存されていることに注意してください。

ModelAdmin.get_autocomplete_fields(request)Link to this definition#

get_autocomplete_fields() メソッドには、HttpRequest が渡され、上述の ModelAdmin.autocomplete_fields セクションで説明した通りオートコンプリートウィジェットで表示するフィールドの名前の list か tuple を返すことが期待されます。

ModelAdmin.get_readonly_fields(request, obj=None)Link to this definition#

get_readonly_fields メソッドには、HttpRequest と編集対象の obj (ないし新規追加用の None) が渡され、上述の ModelAdmin.readonly_fields セクションで説明した通り、読み取り専用で表示するフィールドの名前の list か tuple を返すことが期待されます。

ModelAdmin.get_prepopulated_fields(request, obj=None)Link to this definition#

get_prepopulated_fields メソッドには、HttpRequest と編集対象の obj (ないし新規追加用の None) が渡され、上述の ModelAdmin.prepopulated_fields セクションで説明した通り dictionary を返すことが期待されます。

ModelAdmin.get_list_display(request)Link to this definition#

get_list_display メソッドには、HttpRequest が渡され、上述の ModelAdmin.list_display セクションで説明した通りチェンジリストビューで表示するフィールドの名前の list か tuple を返すことが期待されます。

ModelAdmin.get_list_display_links(request, list_display)Link to this definition#

get_list_display_links メソッドには、HttpRequest と ModelAdmin.get_list_display() によって返された list ないし tuple が渡されます。上述の ModelAdmin.list_display_links セクションで説明した通り、チェンジリストで変更ビューにリンクを貼りたいフィールドの名前の list か tuple、もしくは None を返すことが期待されます。

ModelAdmin.get_exclude(request, obj=None)Link to this definition#

get_exclude メソッドには、HttpRequest と編集対象の obj (ないし新規追加用の None) が渡され、上述の ModelAdmin.exclude セクションで説明した通りフィールドのリストを返すことが期待されます。

ModelAdmin.get_fields(request, obj=None)Link to this definition#

get_fields メソッドには、HttpRequest と編集対象の obj (ないし新規追加用の None) が渡され、上述の ModelAdmin.fields セクションで説明した通りフィールドのリストを返すことが期待されます。

ModelAdmin.get_fieldsets(request, obj=None)Link to this definition#

get_fieldsets メソッドには、HttpRequest と編集対象の obj (ないし新規追加用の None) が渡され、2 値タプルのリストを返すことが期待されます。各 2 値タプルは、上述の ModelAdmin.fieldsets セクションで説明した通り admin のフォームページ上の <fieldset> を表します。

ModelAdmin.get_list_filter(request)Link to this definition#

get_list_filter メソッドには、HttpRequest が渡され、list_filter 属性のときと同じ種類のシーケンス型を返すことが期待されます。

ModelAdmin.get_list_select_related(request)Link to this definition#

get_list_select_related メソッドには、HttpRequest が渡され、真偽値もしくは ModelAdmin.list_select_related と同様のリストを返す必要があります。

ModelAdmin.get_search_fields(request)Link to this definition#

get_search_fields メソッドには、HttpRequest が渡され、search_fields 属性のときと同じ種類のシーケンス型を返すことが期待されます。

ModelAdmin.get_sortable_by(request)Link to this definition#

get_list_display メソッドは HttpRequest を受け取り、チェンジリストページでソート可能なフィールドの名のコレクション (例: list、tuple、set) を返すことが期待されます。

デフォルトの実装では、セットされている場合は sortable_by を返します。セットされていなければ get_list_display() を参照します。

たとえば、1 つ以上のカラムを並び替え不可にするには:

Code

class PersonAdmin(admin.ModelAdmin):
    def get_sortable_by(self, request):
        return {*self.get_list_display(request)} - {"rank"}

ModelAdmin.get_inline_instances(request, obj=None)Link to this definition#

get_inline_instances メソッドは、編集中の HttpRequest と obj (追加フォームの場合は None) を受け取り、以下の InlineModelAdmin セクションで説明されているように、InlineModelAdmin オブジェクトの list または tuple を返すことが期待されます。例えば、以下は追加、変更、削除、閲覧の権限に基づくデフォルトのフィルタリングなしでインラインを返す方法です:

Code

class MyModelAdmin(admin.ModelAdmin):
    inlines = [MyInline]

    def get_inline_instances(self, request, obj=None):
        return [inline(self.model, self.admin_site) for inline in self.inlines]

このメソッドをオーバーライドする場合、返値となるインラインは inlines で定義したクラスのインスタンスにしてください。間違えると、リレーション先オブジェクトを追加する際に "Bad Request" が発生する可能性があります。

ModelAdmin.get_inlines(request, obj)Link to this definition#

get_inlines メソッドは、編集対象の HttpRequest と obj (追加フォームの場合は None) を受け取り、インラインのイテラブルを返すことが期待されます。 ModelAdmin.inlines で指定する代わりに、このメソッドをオーバーライドすることで、リクエストやモデルインスタンスに基づいて動的にインラインを追加できます。

ModelAdmin.get_urls()Link to this definition#

ModelAdmin の get_urls メソッドは URLconf と同じようにその ModelAdmin で使用する URL を返します。 そのため、 URL ディスパッチャ で説明されているように、ビューの AdminSite.admin_view() ラッパーを使って拡張できます:

Code

from django.contrib import admin
from django.template.response import TemplateResponse
from django.urls import path


class MyModelAdmin(admin.ModelAdmin):
    def get_urls(self):
        urls = super().get_urls()
        my_urls = [path("my_view/", self.admin_site.admin_view(self.my_view))]
        return my_urls + urls

    def my_view(self, request):
        # ...
        context = dict(
            # Include common variables for rendering the admin template.
            self.admin_site.each_context(request),
            # Anything else you want in the context...
            key=value,
        )
        return TemplateResponse(request, "sometemplate.html", context)

admin のレイアウトを使用したい場合、admin/base_site.html を extend してください:

Django template

{% extends "admin/base_site.html" %}
{% block content %}
...
{% endblock %}

ページがキャッシュ可能で、それでもパーミッションチェックを行いたい場合は、 AdminSite.admin_view() に cacheable=True 引数を渡します:

Code

path("my_view/", self.admin_site.admin_view(self.my_view, cacheable=True))

ModelAdmin ビューは model_admin 属性を持ちます。その他の AdminSite ビューは admin_site 属性を持ちます。

ModelAdmin.get_form(request, obj=None, **kwargs)Link to this definition#

admin の追加と変更のビューで使うための ModelForm クラスを返します。add_view() と change_view() を参照してください。

基本の実装は modelform_factory() を使用して form をサブクラス化し、fields や exclude といった属性によって修正されます。なので、例えばスーパーユーザーに対して追加的なフィールドを与えたい場合は、以下のように基本のフォームを変更できます:

Code

class MyModelAdmin(admin.ModelAdmin):
    def get_form(self, request, obj=None, **kwargs):
        if request.user.is_superuser:
            kwargs["form"] = MySuperuserForm
        return super().get_form(request, obj, **kwargs)

ModelForm クラスを直接返すこともできます。

ModelAdmin.get_formsets_with_inlines(request, obj=None)Link to this definition#

admin の追加や変更のビューで使用するための (FormSet, InlineModelAdmin) ペアを生成します。

たとえば、変更ビューのみで特定のインラインを表示したい場合、以下のように get_formsets_with_inlines をオーバーライドできます。

Code

class MyModelAdmin(admin.ModelAdmin):
    inlines = [MyInline, SomeOtherInline]

    def get_formsets_with_inlines(self, request, obj=None):
        for inline in self.get_inline_instances(request, obj):
            # hide MyInline in the add view
            if not isinstance(inline, MyInline) or obj is not None:
                yield inline.get_formset(request, obj), inline

ModelAdmin.formfield_for_foreignkey(db_field, request, **kwargs)Link to this definition#

ModelAdmin の formfield_for_foreignkey を使うと、ForignKey フィールドに対するデフォルトのフォームフィールドをオーバーライドできます。たとえば、ユーザーに基づいてこの ForeignKey フィールドに対するオブジェクトのサブセットを返すには:

Code

class MyModelAdmin(admin.ModelAdmin):
    def formfield_for_foreignkey(self, db_field, request, **kwargs):
        if db_field.name == "car":
            kwargs["queryset"] = Car.objects.filter(owner=request.user)
        return super().formfield_for_foreignkey(db_field, request, **kwargs)

これは、HttpRequest インスタンスを使って Car ForeignKey フィールドをフィルタし、特定の User インスタンスが所有する car のみを表示します。

より複雑なフィルタを行うには、ModelForm.__init__() メソッドを使用することで、モデルの instance に基づいたフィルタを行うことができます (リレーションシップを扱うフィールド を参照してください)。たとえば:

Code

class CountryAdminForm(forms.ModelForm):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.fields["capital"].queryset = self.instance.cities.all()


class CountryAdmin(admin.ModelAdmin):
    form = CountryAdminForm

ModelAdmin.formfield_for_manytomany(db_field, request, **kwargs)Link to this definition#

formfield_for_foreignkey メソッドと同じように、formfield_for_manytomany メソッドをオーバーライドすると ManyToMany に対するデフォルトのフォームフィールドを変更できます。たとえば、あるオーナーは複数の car を所有でき、また car は複数のオーナーに所有されるとすると（多対多の関係です） Car のフィールドをフィルタして特定の User が所有する car だけを表示できます:

Code

class MyModelAdmin(admin.ModelAdmin):
    def formfield_for_manytomany(self, db_field, request, **kwargs):
        if db_field.name == "cars":
            kwargs["queryset"] = Car.objects.filter(owner=request.user)
        return super().formfield_for_manytomany(db_field, request, **kwargs)

ModelAdmin.formfield_for_choice_field(db_field, request, **kwargs)Link to this definition#

formfield_for_foreignkey や formfield_for_manytomany メソッドと同じように、formfield_for_choice_field メソッドをオーバーライドすると選択肢として宣言されたフィールドに対するデフォルトのフォームフィールドを変更できます。 たとえば、スーパーユーザーと通常のスタッフで表示する選択肢を違うものにしたい場合、以下のように記述できます:

Code

class MyModelAdmin(admin.ModelAdmin):
    def formfield_for_choice_field(self, db_field, request, **kwargs):
        if db_field.name == "status":
            kwargs["choices"] = [
                ("accepted", "Accepted"),
                ("denied", "Denied"),
            ]
            if request.user.is_superuser:
                kwargs["choices"].append(("ready", "Ready for deployment"))
        return super().formfield_for_choice_field(db_field, request, **kwargs)

ModelAdmin.get_changelist(request, **kwargs)Link to this definition#

リスト作成に使われる Changelist を返します。デフォルトでは、django.contrib.admin.views.main.ChangeList が使われます。このクラスを継承することで、リスト作成の動作を変更できます。

ModelAdmin.get_changelist_form(request, **kwargs)Link to this definition#

チェンジリストページの Formset で使うための ModelForm クラスを返します。カスタムフォームを使うには、たとえば、次のようにします。

Code

from django import forms


class MyForm(forms.ModelForm):
    pass


class MyModelAdmin(admin.ModelAdmin):
    def get_changelist_form(self, request, **kwargs):
        return MyForm

ModelAdmin.get_changelist_formset(request, **kwargs)Link to this definition#

list_editable を使っている場合、チェンジリストページで使用するための ModelFormSet クラスを返します。カスタムのフォームセットを使うには、たとえば、次のようにします。

Code

from django.forms import BaseModelFormSet


class MyAdminFormSet(BaseModelFormSet):
    pass


class MyModelAdmin(admin.ModelAdmin):
    def get_changelist_formset(self, request, **kwargs):
        kwargs["formset"] = MyAdminFormSet
        return super().get_changelist_formset(request, **kwargs)

ModelAdmin.lookup_allowed(lookup, value, request)Link to this definition#

チェンジリストページのオブジェクトは URL のクエリ文字列からルックアップしてフィルタすることができます。たとえば、list_filter はその仕組みで動作します。ルックアップは QuerySet.filter() (例 user__email=user@example.com) で使われているものと似ています。クエリ文字列のルックアップはユーザによって操作される可能性があるため、無許可のデータ漏洩を防ぐためにサニタイズする必要があります。

lookup_allowed() メソッドには、クエリ文字列 ('user__email' など)、対応する値 ('user@example.com' など)、リクエストからのルックアップパスが渡され、パラメータを使用したチェンジリストの QuerySet のフィルタリングが許可されているかどうかを示す真偽値を返します。 lookup_allowed() が False を返した場合、 DisallowedModelAdminLookup (SuspiciousOperation のサブクラス) が発生します。

デフォルトでは、 lookup_allowed() はモデルのローカルフィールド、 list_filter で使用されるフィールドパス (ただし、 get_list_filter() からのパスは使用できません)、 limit_choices_to が raw_id_fields で正しく機能するために必要なルックアップへのアクセスを許可します。

ModelAdmin サブクラスで許可されるルックアップをカスタマイズするには、このメソッドをオーバーライドします。

ModelAdmin.has_view_permission(request, obj=None)Link to this definition#

obj の閲覧が許可されている場合は True を、そうでなければ False を返します。obj が None の場合、この種類のオブジェクトの閲覧が一般的に許可されているかどうかを表すよう、True か False を指定します (たとえば、False は現在のユーザーがこの種類のすべてのオブジェクトを閲覧できないことを意味します)。

デフォルトの実装では、ユーザーが "change" か "view" 権限を持っていれば True を返します。

ModelAdmin.has_add_permission(request)Link to this definition#

オブジェクトの追加が許可されていれば True を、そうでなければ False を返します。

ModelAdmin.has_change_permission(request, obj=None)Link to this definition#

obj の編集が許可されている場合は True を、そうでなければ False を返します。obj が None の場合、この種類のオブジェクトの編集が一般的に許可されているかどうかを表すよう、True か False を指定します (たとえば、False は現在のユーザーがこの種類のすべてのオブジェクトを編集できないことを意味します)。

ModelAdmin.has_delete_permission(request, obj=None)Link to this definition#

obj の削除が許可されている場合は True を、そうでなければ False を返します。obj が None の場合、この種類のオブジェクトの削除が一般的に許可されているかどうかを表すよう、True か False を指定します (たとえば、False は現在のユーザーがこの種類のすべてのオブジェクトを削除できないことを意味します)。

ModelAdmin.has_module_permission(request)Link to this definition#

admin のインデックスページでモジュールを表示し、そのモジュールへのアクセスを許可する場合は True を、そうでなければ False を返します。デフォルトでは User.has_module_perms() を使用します。 オーバーライドしても閲覧、追加、変更、削除のアクセス権は制限しません。アクセス権の制限には has_view_permission()、has_add_permission()、has_change_permission()、has_delete_permission() を使用してください。

ModelAdmin.get_queryset(request)Link to this definition#

ModelAdmin の get_queryset メソッドは admin サイトで編集可能なモデルインスタンスのすべての QuerySet を返します。このメソッドをオーバーライドする場面の 1 つは、ログイン中のユーザーが所有するオブジェクトを表示することです:

Code

class MyModelAdmin(admin.ModelAdmin):
    def get_queryset(self, request):
        qs = super().get_queryset(request)
        if request.user.is_superuser:
            return qs
        return qs.filter(author=request.user)

ModelAdmin.message_user(request, message, level=messages.INFO, extra_tags='', fail_silently=False)Link to this definition#

django.contrib.messages バックエンドを使ってユーザーにメッセージを送ります。カスタムの ModelAdmin の例 を参照してください。

キーワード引数を使うと、メッセージレベルを変更したり、余分な CSS タグを追加したり、 contrib.message フレームワークがインストールされていない場合にサイレントエラーにしたりすることができます。これらのキーワード引数は django.contrib.messages.add_message() の引数と同じです。詳しくはその関数のドキュメントを参照してください。違いの一つは、レベルを整数/定数の他に文字列ラベルとして渡せる点です。

ModelAdmin.get_paginator(request, queryset, per_page, orphans=0, allow_empty_first_page=True)Link to this definition#

このビューで使用する paginator のインスタンスを返します。デフォルトでは paginator のインスタンスを返します。

ModelAdmin.response_add(request, obj, post_url_continue=None)Link to this definition#

add_view() ステージに対する HttpResponse を決定します。

response_add は、admin フォームが送信され、オブジェクトとすべての関係インスタンスが作成および保存された直後に呼び出されます。オーバーライドすることで、オブジェクトが作成された後のデフォルトの動作を変更できます。

ModelAdmin.response_change(request, obj)Link to this definition#

change_view() ステージに対する HttpResponse を決定します。

response_change は、admin フォームが送信され、オブジェクトとすべての関係インスタンスが保存された直後に呼び出されます。オーバーライドすることで、オブジェクトが変更された後のデフォルトの動作を変更できます。

ModelAdmin.response_delete(request, obj_display, obj_id)Link to this definition#

delete_view() ステージに対する HttpResponse を決定します。

response_delete は、オブジェクトが削除された後に呼び出されます。オーバーライドすることで、オブジェクトが削除された後のデフォルトの動作を変更できます。

obj_display は削除されたオブジェクトの名前を表す文字列です。

obj_id は削除するオブジェクトを取得するために使用するシリアライズされた識別子です。

ModelAdmin.get_formset_kwargs(request, obj, inline, prefix)Link to this definition#

フォームセットのコンストラクタに渡されるキーワード引数をカスタマイズするためのフックです。たとえばフォームセットのフォームに request を渡すには:

Code

class MyModelAdmin(admin.ModelAdmin):
    def get_formset_kwargs(self, request, obj, inline, prefix):
        return {
            **super().get_formset_kwargs(request, obj, inline, prefix),
            "form_kwargs": {"request": request},
        }

また、フォームセットのフォームに initial を指定するためにも使用できます。

ModelAdmin.get_changeform_initial_data(request)Link to this definition#

admin の変更フォームの初期データに対するフックです。デフォルトでは、フィールドには GET パラメータで初期値が与えられます。たとえば、 ?name=initial_value は name フィールドの初期値を initial_value にセットします。

このメソッドは、{'fieldname': 'fieldval'} という形式のディクショナリを返します:

Code

def get_changeform_initial_data(self, request):
    return {"name": "custom_initial_value"}

ModelAdmin.get_deleted_objects(objs, request)Link to this definition#

delete_view() と "delete selected" アクション の削除処理をカスタマイズするフックです。

引数 objs は削除するオブジェクト (QuerySet またはモデルインスタンスのリスト) の同型イテラブルで、 request は HttpRequest です。

このメソッドは (deleted_objects, model_count, perms_needed, protected) の4タプルを返さなければなりません。

deleted_objects は削除されるすべてのオブジェクトを表す文字列のリストです。削除されるオブジェクトにリレーション先オブジェクトがある場合、リストはネストされ、それらのリレーション先オブジェクトも含まれます。リストはテンプレート内で unordered_list フィルタを使ってフォーマットされます。

model_count は各モデルの verbose_name_plural と削除されるオブジェクトの数をマッピングした辞書です。

perms_need は verbose_name のセットで、ユーザが削除する権限を持っていないモデルです。

protected は削除できない保護されたリレーション先オブジェクトを表す文字列のリストです。このリストはテンプレートに表示されます。

class MyModelAdmin(admin.ModelAdmin):
    # A template for a very customized change view:
    change_form_template = "admin/myapp/extras/openstreetmap_change_form.html"

    def get_osm_info(self):
        # ...
        pass

    def change_view(self, request, object_id, form_url="", extra_context=None):
        extra_context = extra_context or {}
        extra_context["osm_data"] = self.get_osm_info()
        return super().change_view(
            request,
            object_id,
            form_url,
            extra_context=extra_context,
        )

ModelAdmin アセットの定義Link to this heading#

ビューを追加したり変更したりするために、CSS や JavaScript を追加したいことがあるかもしれません。そういうときには ModelAdmin の Media インナークラスを使用します:

class ArticleAdmin(admin.ModelAdmin):
    class Media:
        css = {
            "all": ["my_styles.css"],
        }
        js = ["my_code.js"]

staticfiles アプリ は、すべてのアセットのパスの前に STATIC_URL (STATIC_URL が None の場合は MEDIA_URL) を付与します。 フォーム上の通常のアセット定義 と同じルールが適用されます。

InlineModelAdmin のオプションLink to this heading#

InlineModelAdmin は ModelAdmin と多くの機能を共有しており、さらにいくつかの独自の機能を有しています (共有の機能は実際には BaseModelAdmin 基底クラスで定義されています)。共有の機能は下記です:

• form

• fieldsets

• fields

• formfield_overrides

• exclude

• filter_horizontal

• filter_vertical

• ordering

• prepopulated_fields

• get_fieldsets()

• get_queryset()

• radio_fields

• readonly_fields

• view_on_site

• empty_value_display

• autocomplete_fields

• raw_id_fields

• formfield_for_choice_field()

• formfield_for_foreignkey()

• formfield_for_manytomany()

• has_module_permission()

InlineModelAdmin クラスは、以下を追加またはカスタマイズしています:

InlineModelAdmin.modelLink to this definition#

インラインが使用するモデルです。これは必須です。

InlineModelAdmin.fk_nameLink to this definition#

モデルの外部キーの名前です。多くの場合、これは自動的に処理されますが、同じ親モデルに対して複数の外部キーがある場合には fk_name を明示的に指定する必要があります。

InlineModelAdmin.formsetLink to this definition#

これはデフォルトでは BaseInlineFormSet です。自分自身のフォームセットを使用すると、カスタマイズの幅が広がります。インラインは モデル フォームセット で構築されます。

InlineModelAdmin.formLink to this definition#

form に対する値で、デフォルトは ModelForm です。これは、このインラインに対してフォームセットが生成される際に inlineformset_factory() に渡されるものです。

例については カスタムのバリデーションを admin に追加する を参照してください。

InlineModelAdmin.classesLink to this definition#

インラインでレンダリングされるフィールドセットに適用する追加のCSSクラスを含むリストまたはタプルです。デフォルトは None です。fieldsets で設定されたクラスと同様に、collapse クラスが付けられたインラインは、展開可能なウィジェットを使用して初期状態で折りたたまれます。

InlineModelAdmin.extraLink to this definition#

フォームセットが初期のフォームに加えて表示する追加的なフォームの数をコントロールします。デフォルトは 3 です。詳しくは フォームセットのドキュメント を参照してください。

JavaScript が有効なブラウザを使っているユーザーに対しては、"1 つ追加" のリンクが提供され、extra 引数の結果提供されるインラインに加えていくつでもインラインを追加できます。

現在表示されているフォームの数が max_num を超えている場合、またはユーザーが JavaScript を有効にしていない場合、ダイナミックリンクは表示されません。

InlineModelAdmin.get_extra() でも追加フォームの数をカスタマイズできます。

InlineModelAdmin.max_numLink to this definition#

インラインに表示するフォームの最大数をコントロールします。オブジェクトの数と直接関係はありませんが、値が小さい場合には関係する可能性があります。詳しくは 編集可能なオブジェクトの数を制限する を参照してください。

InlineModelAdmin.get_max_num() でも追加フォームの最大数をカスタマイズできます。

InlineModelAdmin.min_numLink to this definition#

インラインに表示するフォームの最小数をコントロールします。詳しくは modelformset_factory() を参照してください。

InlineModelAdmin.get_min_num() でも追加フォームの最小数をカスタマイズできます。

InlineModelAdmin.raw_id_fieldsLink to this definition#

デフォルトでは、ForeignKey のフィールドに対して Django の admin はセレクトボックスのインターフェース (<select>) を使用します。ドロップダウン内に表示する関係インスタンスをすべて選択するオーバーヘッドから逃れたいこともあるでしょう。

raw_id_fields は、ForeignKey や ManyToManyField に対する Input ウィジェットを適用したいフィールドのリストです:

Code

class BookInline(admin.TabularInline):
    model = Book
    raw_id_fields = ["pages"]

InlineModelAdmin.templateLink to this definition#

ページ上でインラインをレンダリングするのに使われるテンプレートです。

InlineModelAdmin.verbose_nameLink to this definition#

モデル内部の Meta クラスの verbose_name のオーバーライドです。

InlineModelAdmin.verbose_name_pluralLink to this definition#

モデル内部の Meta クラスの verbose_name_plural をオーバーライドします。これが与えられず、 InlineModelAdmin.verbose_name が定義されている場合、 Django は InlineModelAdmin.verbose_name + 's' を使用します。

InlineModelAdmin.can_deleteLink to this definition#

インライン内でインラインオブジェクトを削除可能にするかどうかを指定します。デフォルトは True です。

InlineModelAdmin.show_change_linkLink to this definition#

admin 内で変更可能なインラインオブジェクトをが変更フォームへのリンクを持つかどうかを指定します。デフォルトは False です。

InlineModelAdmin.get_formset(request, obj=None, **kwargs)Link to this definition#

admin の追加/変更ビューで使用する BaseInlineFormSet クラスを返します。 obj は編集対象の親オブジェクト、または新しい親オブジェクトを追加する場合は None です。 ModelAdmin.get_formsets_with_inlines の例を参照してください。

InlineModelAdmin.get_extra(request, obj=None, **kwargs)Link to this definition#

使用する追加インラインフォームの数を返します。デフォルトでは、InlineModelAdmin.extra 属性を返します。

プログラムに従って追加インラインフォームの数を決めたい場合、このメソッドをオーバーライドしてください。たとえば、モデルインスタンス (キーワード引数の obj で渡されています) に基づいて数を決められます:

Code

class BinaryTreeAdmin(admin.TabularInline):
    model = BinaryTree

    def get_extra(self, request, obj=None, **kwargs):
        extra = 2
        if obj:
            return extra - obj.binarytree_set.count()
        return extra

InlineModelAdmin.get_max_num(request, obj=None, **kwargs)Link to this definition#

使用する追加インラインフォームの最大数を返します。デフォルトでは、InlineModelAdmin.max_num 属性を返します。

プログラムに従ってインラインフォームの最大数を決めたい場合、このメソッドをオーバーライドしてください。たとえば、モデルインスタンス (キーワード引数の obj で渡されています) に基づいて最大数を決められます:

Code

class BinaryTreeAdmin(admin.TabularInline):
    model = BinaryTree

    def get_max_num(self, request, obj=None, **kwargs):
        max_num = 10
        if obj and obj.parent:
            return max_num - 5
        return max_num

InlineModelAdmin.get_min_num(request, obj=None, **kwargs)Link to this definition#

使用する追加インラインフォームの最小数を返します。デフォルトでは、InlineModelAdmin.min_num 属性を返します。

プログラムに従ってインラインフォームの最小数を決めたい場合、このメソッドをオーバーライドしてください。たとえば、モデルインスタンス (キーワード引数の obj で渡されています) に基づいて最小数を決められます:

InlineModelAdmin.has_add_permission(request, obj)Link to this definition#

インラインオブジェクトの追加が許可されている場合 True を、そうでなければ False を返します。obj は編集される親オブジェクトか、新規追加の場合には None となります。

InlineModelAdmin.has_change_permission(request, obj=None)Link to this definition#

インラインオブジェクトの編集が許可されている場合 True を、そうでなければ False を返します。obj は編集される親オブジェクトです。

InlineModelAdmin.has_delete_permission(request, obj=None)Link to this definition#

インラインオブジェクトの削除が許可されている場合 True を、そうでなければ False を返します。obj は編集される親オブジェクトです。

同じ親モデルへの複数の外部キーを持つモデルを扱うLink to this heading#

同じモデルに対する複数の外部キーを持つこともあり得ます。例として以下のモデルを見てみましょう:

from django.db import models


class Person(models.Model):
    name = models.CharField(max_length=128)


class Friendship(models.Model):
    to_person = models.ForeignKey(
        Person, on_delete=models.CASCADE, related_name="friends"
    )
    from_person = models.ForeignKey(
        Person, on_delete=models.CASCADE, related_name="from_friends"
    )

Person の admin の追加や変更ページでインラインを表示したい場合は、自動的に判別することができないため、外部キーを明示的に定義する必要があります:

from django.contrib import admin
from myapp.models import Friendship, Person


class FriendshipInline(admin.TabularInline):
    model = Friendship
    fk_name = "to_person"


class PersonAdmin(admin.ModelAdmin):
    inlines = [
        FriendshipInline,
    ]


admin.site.register(Person, PersonAdmin)

多対多のモデルを扱うLink to this heading#

デフォルトでは、多対多のリレーションに対する管理ウィジェットは、実際に ManyToManyField への参照を含むモデルに表示されます。 ModelAdmin の定義に応じて、モデル内の各多対多フィールドは標準のHTML <select multiple>, 水平または垂直フィルタ、または raw_id_fields ウィジェットによって表されます。しかし、これらのウィジェットをインラインで置き換えることもできます。

次のようなモデルがあるとします:

from django.db import models


class Person(models.Model):
    name = models.CharField(max_length=128)


class Group(models.Model):
    name = models.CharField(max_length=128)
    members = models.ManyToManyField(Person, related_name="groups")

インラインを使用して多対多のリレーションを表示したい場合、リレーションシップに InlineModelAdmin オブジェクトを定義することで表示できます:

from django.contrib import admin
from myapp.models import Group


class MembershipInline(admin.TabularInline):
    model = Group.members.through


class GroupAdmin(admin.ModelAdmin):
    inlines = [
        MembershipInline,
    ]
    exclude = ["members"]


admin.site.register(Group, GroupAdmin)

この例で注目すべき点は2つです。

まず、 MembershipInline クラスは Group.members.through を参照しています。 through 属性は多対多のリレーションを管理するモデルへの参照です。このモデルは、多対多のフィールドを定義したときに Django が自動的に作成します。

次に、 GroupAdmin は手動で members フィールドを除外する必要があります。Django は多対多のフィールドの管理ウィジェットを、リレーションを定義するモデル (この場合は Group) 上に表示します。インラインモデルを使って多対多のリレーションを表現したい場合は、 Django の admin に、このウィジェットを 表示しない ように指示しなければなりません。

このテクニックを使う場合、 m2m_changed シグナルはトリガーされないことに注意してください。これは、admin にとっては through は多対多のリレーションではなく、2つの外部キーフィールドを持つモデルに過ぎないからです。

その他の点では InlineModelAdmin は他のものと全く同じです。通常の ModelAdmin プロパティを使用して外観をカスタマイズできます。

多対多の中間モデルとともに使うLink to this heading#

ManyToManyField の through 引数で中間モデルを指定した場合、管理画面はデフォルトではウィジェットを表示しません。これは、その中間モデルの各インスタンスは、単一のウィジェットで表示できる以上の情報を必要とし、複数のウィジェットに必要なレイアウトは中間モデルによって異なるからです。

しかし、インラインで情報を編集できるようにしたいと思うでしょう。幸いなことに、インライン admin モデルでこれを実現できます。次のようなモデルがあるとします:

from django.db import models


class Person(models.Model):
    name = models.CharField(max_length=128)


class Group(models.Model):
    name = models.CharField(max_length=128)
    members = models.ManyToManyField(Person, through="Membership")


class Membership(models.Model):
    person = models.ForeignKey(Person, on_delete=models.CASCADE)
    group = models.ForeignKey(Group, on_delete=models.CASCADE)
    date_joined = models.DateField()
    invite_reason = models.CharField(max_length=64)

    class Meta:
        constraints = [
            models.UniqueConstraint(
                fields=["person", "group"], name="unique_person_group"
            )
        ]