<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>The Django admin site — Django v1.1 documentation</title>
<link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '1.1',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<link rel="top" title="Django v1.1 documentation" href="../../../index.html" />
<link rel="up" title="contrib packages" href="../index.html" />
<link rel="next" title="Admin actions" href="actions.html" />
<link rel="prev" title="contrib packages" href="../index.html" />
<script type="text/javascript" src="../../../templatebuiltins.js"></script>
<script type="text/javascript">
(function($) {
if (!django_template_builtins) {
// templatebuiltins.js missing, do nothing.
return;
}
$(document).ready(function() {
// Hyperlink Django template tags and filters
var base = "../../templates/builtins.html";
if (base == "#") {
// Special case for builtins.html itself
base = "";
}
// Tags are keywords, class '.k'
$("div.highlight\\-html\\+django span.k").each(function(i, elem) {
var tagname = $(elem).text();
if ($.inArray(tagname, django_template_builtins.ttags) != -1) {
var fragment = tagname.replace(/_/, '-');
$(elem).html("<a href='" + base + "#" + fragment + "'>" + tagname + "</a>");
}
});
// Filters are functions, class '.nf'
$("div.highlight\\-html\\+django span.nf").each(function(i, elem) {
var filtername = $(elem).text();
if ($.inArray(filtername, django_template_builtins.tfilters) != -1) {
var fragment = filtername.replace(/_/, '-');
$(elem).html("<a href='" + base + "#" + fragment + "'>" + filtername + "</a>");
}
});
});
})(jQuery);
</script>
</head>
<body>
<div class="document">
<div id="custom-doc" class="yui-t6">
<div id="hd">
<h1><a href="../../../index.html">Django v1.1 documentation</a></h1>
<div id="global-nav">
<a title="Home page" href="../../../index.html">Home</a> |
<a title="Table of contents" href="../../../contents.html">Table of contents</a> |
<a title="Global index" href="../../../genindex.html">Index</a> |
<a title="Module index" href="../../../modindex.html">Modules</a>
</div>
<div class="nav">
« <a href="../index.html" title="<tt class="docutils literal docutils literal docutils literal"><span class="pre">contrib</span></tt> packages">previous</a>
|
<a href="../../index.html" title="API Reference" accesskey="U">up</a>
|
<a href="actions.html" title="Admin actions">next</a> »</div>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<div class="yui-g" id="ref-contrib-admin-index">
<div class="section" id="s-module-django.contrib.admin">
<span id="s-ref-contrib-admin"></span><span id="module-django.contrib.admin"></span><span id="ref-contrib-admin"></span><h1>The Django admin site<a class="headerlink" href="#module-django.contrib.admin" title="Permalink to this headline">¶</a></h1>
<p>One of the most powerful parts of Django is the automatic admin interface. It
reads metadata in your model to provide a powerful and production-ready
interface that content producers can immediately use to start adding content to
the site. In this document, we discuss how to activate, use and customize
Django’s admin interface.</p>
<div class="admonition-note admonition ">
<p class="first admonition-title">Note</p>
<p class="last">The admin site has been refactored significantly since Django 0.96. This
document describes the newest version of the admin site, which allows for
much richer customization. If you follow the development of Django itself,
you may have heard this described as “newforms-admin.”</p>
</div>
<div class="section" id="s-overview">
<span id="overview"></span><h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
<p>There are six steps in activating the Django admin site:</p>
<ol class="arabic simple">
<li>Add <tt class="docutils literal"><span class="pre">'django.contrib.admin'</span></tt> to your <a class="reference external" href="../../settings.html#setting-INSTALLED_APPS"><tt class="xref docutils literal"><span class="pre">INSTALLED_APPS</span></tt></a>
setting.</li>
<li>Admin has two dependencies - <tt class="docutils literal"><span class="pre">django.contrib.auth</span></tt> and
<tt class="docutils literal"><span class="pre">django.contrib.contenttypes</span></tt>. If these applications are not
in your <a class="reference external" href="../../settings.html#setting-INSTALLED_APPS"><tt class="xref docutils literal"><span class="pre">INSTALLED_APPS</span></tt></a> list, add them.</li>
<li>Determine which of your application’s models should be editable in the
admin interface.</li>
<li>For each of those models, optionally create a <tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> class that
encapsulates the customized admin functionality and options for that
particular model.</li>
<li>Instantiate an <tt class="docutils literal"><span class="pre">AdminSite</span></tt> and tell it about each of your models and
<tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> classes.</li>
<li>Hook the <tt class="docutils literal"><span class="pre">AdminSite</span></tt> instance into your URLconf.</li>
</ol>
<div class="section" id="s-other-topics">
<span id="other-topics"></span><h3>Other topics<a class="headerlink" href="#other-topics" title="Permalink to this headline">¶</a></h3>
<ul>
<li class="toctree-l1"><a class="reference external" href="actions.html">Admin actions</a></li>
</ul>
<div class="admonition-see-also admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last">For information about serving the media files (images, JavaScript, and CSS)
associated with the admin in production, see <a class="reference external" href="../../../howto/deployment/modpython.html#serving-media-files"><em>Serving media files</em></a>.</p>
</div>
</div>
</div>
<div class="section" id="s-modeladmin-objects">
<span id="modeladmin-objects"></span><h2><tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> objects<a class="headerlink" href="#modeladmin-objects" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="django.contrib.admin.ModelAdmin">
<em class="property">class </em><tt class="descname">ModelAdmin</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>The <tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> class is the representation of a model in the admin
interface. These are stored in a file named <tt class="docutils literal"><span class="pre">admin.py</span></tt> in your application.
Let’s take a look at a very simple example of the <tt class="docutils literal"><span class="pre">ModelAdmin</span></tt>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">django.contrib</span> <span class="kn">import</span> <span class="n">admin</span>
<span class="kn">from</span> <span class="nn">myproject.myapp.models</span> <span class="kn">import</span> <span class="n">Author</span>
<span class="k">class</span> <span class="nc">AuthorAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="k">pass</span>
<span class="n">admin</span><span class="o">.</span><span class="n">site</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">Author</span><span class="p">,</span> <span class="n">AuthorAdmin</span><span class="p">)</span>
</pre></div>
</div>
<div class="admonition-do-you-need-a-modeladmin-object-at-all admonition ">
<p class="first admonition-title">Do you need a <tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> object at all?</p>
<p>In the preceding example, the <tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> class doesn't define any
custom values (yet). As a result, the default admin interface will be
provided. If you are happy with the default admin interface, you don't
need to define a <tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> object at all -- you can register the
model class without providing a <tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> description. The
preceding example could be simplified to:</p>
<div class="last highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">django.contrib</span> <span class="kn">import</span> <span class="n">admin</span>
<span class="kn">from</span> <span class="nn">myproject.myapp.models</span> <span class="kn">import</span> <span class="n">Author</span>
<span class="n">admin</span><span class="o">.</span><span class="n">site</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">Author</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="s-modeladmin-options">
<span id="modeladmin-options"></span><h3><tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> Options<a class="headerlink" href="#modeladmin-options" title="Permalink to this headline">¶</a></h3>
<p>The <tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> is very flexible. It has several options for dealing with
customizing the interface. All options are defined on the <tt class="docutils literal"><span class="pre">ModelAdmin</span></tt>
subclass:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">AuthorAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="n">date_hierarchy</span> <span class="o">=</span> <span class="s">'pub_date'</span>
</pre></div>
</div>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.date_hierarchy">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">date_hierarchy</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.date_hierarchy" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Set <tt class="docutils literal"><span class="pre">date_hierarchy</span></tt> to the name of a <tt class="docutils literal"><span class="pre">DateField</span></tt> or <tt class="docutils literal"><span class="pre">DateTimeField</span></tt> in
your model, and the change list page will include a date-based drilldown
navigation by that field.</p>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">date_hierarchy</span> <span class="o">=</span> <span class="s">'pub_date'</span>
</pre></div>
</div>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.form">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">form</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.form" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>By default a <tt class="docutils literal"><span class="pre">ModelForm</span></tt> is dynamically created for your model. It is used
to create the form presented on both the add/change pages. You can easily
provide your own <tt class="docutils literal"><span class="pre">ModelForm</span></tt> to override any default form behavior on the
add/change pages.</p>
<p>For an example see the section <a class="reference internal" href="#adding-custom-validation-to-the-admin">Adding custom validation to the admin</a>.</p>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.fieldsets">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">fieldsets</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.fieldsets" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Set <tt class="docutils literal"><span class="pre">fieldsets</span></tt> to control the layout of admin "add" and "change" pages.</p>
<p><tt class="docutils literal"><span class="pre">fieldsets</span></tt> is a list of two-tuples, in which each two-tuple represents a
<tt class="docutils literal"><span class="pre"><fieldset></span></tt> on the admin form page. (A <tt class="docutils literal"><span class="pre"><fieldset></span></tt> is a "section" of the
form.)</p>
<p>The two-tuples are in the format <tt class="docutils literal"><span class="pre">(name,</span> <span class="pre">field_options)</span></tt>, where <tt class="docutils literal"><span class="pre">name</span></tt> is a
string representing the title of the fieldset and <tt class="docutils literal"><span class="pre">field_options</span></tt> is a
dictionary of information about the fieldset, including a list of fields to be
displayed in it.</p>
<p>A full example, taken from the <tt class="docutils literal"><span class="pre">django.contrib.flatpages.FlatPage</span></tt> model:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">FlatPageAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="n">fieldsets</span> <span class="o">=</span> <span class="p">(</span>
<span class="p">(</span><span class="bp">None</span><span class="p">,</span> <span class="p">{</span>
<span class="s">'fields'</span><span class="p">:</span> <span class="p">(</span><span class="s">'url'</span><span class="p">,</span> <span class="s">'title'</span><span class="p">,</span> <span class="s">'content'</span><span class="p">,</span> <span class="s">'sites'</span><span class="p">)</span>
<span class="p">}),</span>
<span class="p">(</span><span class="s">'Advanced options'</span><span class="p">,</span> <span class="p">{</span>
<span class="s">'classes'</span><span class="p">:</span> <span class="p">(</span><span class="s">'collapse'</span><span class="p">,),</span>
<span class="s">'fields'</span><span class="p">:</span> <span class="p">(</span><span class="s">'enable_comments'</span><span class="p">,</span> <span class="s">'registration_required'</span><span class="p">,</span> <span class="s">'template_name'</span><span class="p">)</span>
<span class="p">}),</span>
<span class="p">)</span>
</pre></div>
</div>
<p>This results in an admin page that looks like:</p>
<blockquote>
<img alt="../../../_images/flatfiles_admin.png" src="../../../_images/flatfiles_admin.png" />
</blockquote>
<p>If <tt class="docutils literal"><span class="pre">fieldsets</span></tt> isn't given, Django will default to displaying each field
that isn't an <tt class="docutils literal"><span class="pre">AutoField</span></tt> and has <tt class="docutils literal"><span class="pre">editable=True</span></tt>, in a single fieldset,
in the same order as the fields are defined in the model.</p>
<p>The <tt class="docutils literal"><span class="pre">field_options</span></tt> dictionary can have the following keys:</p>
<ul>
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">fields</span></tt></dt>
<dd><p class="first">A tuple of field names to display in this fieldset. This key is
required.</p>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
<span class="s">'fields'</span><span class="p">:</span> <span class="p">(</span><span class="s">'first_name'</span><span class="p">,</span> <span class="s">'last_name'</span><span class="p">,</span> <span class="s">'address'</span><span class="p">,</span> <span class="s">'city'</span><span class="p">,</span> <span class="s">'state'</span><span class="p">),</span>
<span class="p">}</span>
</pre></div>
</div>
<p>To display multiple fields on the same line, wrap those fields in
their own tuple. In this example, the <tt class="docutils literal"><span class="pre">first_name</span></tt> and <tt class="docutils literal"><span class="pre">last_name</span></tt>
fields will display on the same line:</p>
<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
<span class="s">'fields'</span><span class="p">:</span> <span class="p">((</span><span class="s">'first_name'</span><span class="p">,</span> <span class="s">'last_name'</span><span class="p">),</span> <span class="s">'address'</span><span class="p">,</span> <span class="s">'city'</span><span class="p">,</span> <span class="s">'state'</span><span class="p">),</span>
<span class="p">}</span>
</pre></div>
</div>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">classes</span></tt></dt>
<dd><p class="first">A list containing extra CSS classes to apply to the fieldset.</p>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
<span class="s">'classes'</span><span class="p">:</span> <span class="p">[</span><span class="s">'wide'</span><span class="p">,</span> <span class="s">'extrapretty'</span><span class="p">],</span>
<span class="p">}</span>
</pre></div>
</div>
<p class="last">Two useful classes defined by the default admin site stylesheet are
<tt class="docutils literal"><span class="pre">collapse</span></tt> and <tt class="docutils literal"><span class="pre">wide</span></tt>. Fieldsets with the <tt class="docutils literal"><span class="pre">collapse</span></tt> style will
be initially collapsed in the admin and replaced with a small
"click to expand" link. Fieldsets with the <tt class="docutils literal"><span class="pre">wide</span></tt> style will be
given extra horizontal space.</p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">description</span></tt></dt>
<dd><p class="first">A string of optional extra text to be displayed at the top of each
fieldset, under the heading of the fieldset.</p>
<p class="last">Note that this value is <em>not</em> HTML-escaped when it's displayed in
the admin interface. This lets you include HTML if you so desire.
Alternatively you can use plain text and
<tt class="docutils literal"><span class="pre">django.utils.html.escape()</span></tt> to escape any HTML special
characters.</p>
</dd>
</dl>
</li>
</ul>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.fields">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">fields</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.fields" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Use this option as an alternative to <tt class="docutils literal"><span class="pre">fieldsets</span></tt> if the layout does not
matter and if you want to only show a subset of the available fields in the
form. For example, you could define a simpler version of the admin form for
the <tt class="docutils literal"><span class="pre">django.contrib.flatpages.FlatPage</span></tt> model as follows:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">FlatPageAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="n">fields</span> <span class="o">=</span> <span class="p">(</span><span class="s">'url'</span><span class="p">,</span> <span class="s">'title'</span><span class="p">,</span> <span class="s">'content'</span><span class="p">)</span>
</pre></div>
</div>
<p>In the above example, only the fields 'url', 'title' and 'content' will be
displayed, sequentially, in the form.</p>
<div class="admonition-note admonition ">
<p class="first admonition-title">Note</p>
<p class="last">This <tt class="docutils literal"><span class="pre">fields</span></tt> option should not be confused with the <tt class="docutils literal"><span class="pre">fields</span></tt>
dictionary key that is within the <tt class="docutils literal"><span class="pre">fieldsets</span></tt> option, as described in
the previous section.</p>
</div>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.exclude">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">exclude</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.exclude" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>This attribute, if given, should be a list of field names to exclude from the
form.</p>
<p>For example, let's consider the following model:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Author</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">100</span><span class="p">)</span>
<span class="n">title</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>
<span class="n">birth_date</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">DateField</span><span class="p">(</span><span class="n">blank</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">null</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
</pre></div>
</div>
<p>If you want a form for the <tt class="docutils literal"><span class="pre">Author</span></tt> model that includes only the <tt class="docutils literal"><span class="pre">name</span></tt>
and <tt class="docutils literal"><span class="pre">title</span></tt> fields, you would specify <tt class="docutils literal"><span class="pre">fields</span></tt> or <tt class="docutils literal"><span class="pre">exclude</span></tt> like this:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">AuthorAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="n">fields</span> <span class="o">=</span> <span class="p">(</span><span class="s">'name'</span><span class="p">,</span> <span class="s">'title'</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">AuthorAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="n">exclude</span> <span class="o">=</span> <span class="p">(</span><span class="s">'birth_date'</span><span class="p">,)</span>
</pre></div>
</div>
<p>Since the Author model only has three fields, <tt class="docutils literal"><span class="pre">name</span></tt>, <tt class="docutils literal"><span class="pre">title</span></tt>, and
<tt class="docutils literal"><span class="pre">birth_date</span></tt>, the forms resulting from the above declarations will contain
exactly the same fields.</p>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.filter_horizontal">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">filter_horizontal</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.filter_horizontal" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Use a nifty unobtrusive JavaScript "filter" interface instead of the
usability-challenged <tt class="docutils literal"><span class="pre"><select</span> <span class="pre">multiple></span></tt> in the admin form. The value is a
list of fields that should be displayed as a horizontal filter interface. See
<tt class="docutils literal"><span class="pre">filter_vertical</span></tt> to use a vertical interface.</p>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.filter_vertical">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">filter_vertical</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.filter_vertical" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Same as <tt class="docutils literal"><span class="pre">filter_horizontal</span></tt>, but is a vertical display of the filter
interface.</p>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.list_display">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">list_display</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.list_display" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Set <tt class="docutils literal"><span class="pre">list_display</span></tt> to control which fields are displayed on the change list
page of the admin.</p>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">list_display</span> <span class="o">=</span> <span class="p">(</span><span class="s">'first_name'</span><span class="p">,</span> <span class="s">'last_name'</span><span class="p">)</span>
</pre></div>
</div>
<p>If you don't set <tt class="docutils literal"><span class="pre">list_display</span></tt>, the admin site will display a single column
that displays the <tt class="docutils literal"><span class="pre">__unicode__()</span></tt> representation of each object.</p>
<p>You have four possible values that can be used in <tt class="docutils literal"><span class="pre">list_display</span></tt>:</p>
<ul>
<li><p class="first">A field of the model. For example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">PersonAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="n">list_display</span> <span class="o">=</span> <span class="p">(</span><span class="s">'first_name'</span><span class="p">,</span> <span class="s">'last_name'</span><span class="p">)</span>
</pre></div>
</div>
</li>
<li><p class="first">A callable that accepts one parameter for the model instance. For
example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">def</span> <span class="nf">upper_case_name</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
<span class="k">return</span> <span class="p">(</span><span class="s">"</span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">obj</span><span class="o">.</span><span class="n">first_name</span><span class="p">,</span> <span class="n">obj</span><span class="o">.</span><span class="n">last_name</span><span class="p">))</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
<span class="n">upper_case_name</span><span class="o">.</span><span class="n">short_description</span> <span class="o">=</span> <span class="s">'Name'</span>
<span class="k">class</span> <span class="nc">PersonAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="n">list_display</span> <span class="o">=</span> <span class="p">(</span><span class="n">upper_case_name</span><span class="p">,)</span>
</pre></div>
</div>
</li>
<li><p class="first">A string representing an attribute on the <tt class="docutils literal"><span class="pre">ModelAdmin</span></tt>. This behaves
same as the callable. For example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">PersonAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="n">list_display</span> <span class="o">=</span> <span class="p">(</span><span class="s">'upper_case_name'</span><span class="p">,)</span>
<span class="k">def</span> <span class="nf">upper_case_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">):</span>
<span class="k">return</span> <span class="p">(</span><span class="s">"</span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">obj</span><span class="o">.</span><span class="n">first_name</span><span class="p">,</span> <span class="n">obj</span><span class="o">.</span><span class="n">last_name</span><span class="p">))</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
<span class="n">upper_case_name</span><span class="o">.</span><span class="n">short_description</span> <span class="o">=</span> <span class="s">'Name'</span>
</pre></div>
</div>
</li>
<li><p class="first">A string representing an attribute on the model. This behaves almost
the same as the callable, but <tt class="docutils literal"><span class="pre">self</span></tt> in this context is the model
instance. Here's a full model example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Person</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">50</span><span class="p">)</span>
<span class="n">birthday</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">DateField</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">decade_born_in</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">birthday</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s">'%Y'</span><span class="p">)[:</span><span class="mi">3</span><span class="p">]</span> <span class="o">+</span> <span class="s">"0's"</span>
<span class="n">decade_born_in</span><span class="o">.</span><span class="n">short_description</span> <span class="o">=</span> <span class="s">'Birth decade'</span>
<span class="k">class</span> <span class="nc">PersonAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="n">list_display</span> <span class="o">=</span> <span class="p">(</span><span class="s">'name'</span><span class="p">,</span> <span class="s">'decade_born_in'</span><span class="p">)</span>
</pre></div>
</div>
</li>
</ul>
<p>A few special cases to note about <tt class="docutils literal"><span class="pre">list_display</span></tt>:</p>
<ul>
<li><p class="first">If the field is a <tt class="docutils literal"><span class="pre">ForeignKey</span></tt>, Django will display the
<tt class="docutils literal"><span class="pre">__unicode__()</span></tt> of the related object.</p>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">ManyToManyField</span></tt> fields aren't supported, because that would entail
executing a separate SQL statement for each row in the table. If you
want to do this nonetheless, give your model a custom method, and add
that method's name to <tt class="docutils literal"><span class="pre">list_display</span></tt>. (See below for more on custom
methods in <tt class="docutils literal"><span class="pre">list_display</span></tt>.)</p>
</li>
<li><p class="first">If the field is a <tt class="docutils literal"><span class="pre">BooleanField</span></tt> or <tt class="docutils literal"><span class="pre">NullBooleanField</span></tt>, Django will
display a pretty "on" or "off" icon instead of <tt class="xref docutils literal"><span class="pre">True</span></tt> or <tt class="xref docutils literal"><span class="pre">False</span></tt>.</p>
</li>
<li><p class="first">If the string given is a method of the model, <tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> or a
callable, Django will HTML-escape the output by default. If you'd rather
not escape the output of the method, give the method an <tt class="docutils literal"><span class="pre">allow_tags</span></tt>
attribute whose value is <tt class="xref docutils literal"><span class="pre">True</span></tt>.</p>
<p>Here's a full example model:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Person</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
<span class="n">first_name</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">50</span><span class="p">)</span>
<span class="n">last_name</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">50</span><span class="p">)</span>
<span class="n">color_code</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">6</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">colored_name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="s">'<span style="color: #</span><span class="si">%s</span><span class="s">;"></span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s"></span>'</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">color_code</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">first_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">last_name</span><span class="p">)</span>
<span class="n">colored_name</span><span class="o">.</span><span class="n">allow_tags</span> <span class="o">=</span> <span class="bp">True</span>
<span class="k">class</span> <span class="nc">PersonAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="n">list_display</span> <span class="o">=</span> <span class="p">(</span><span class="s">'first_name'</span><span class="p">,</span> <span class="s">'last_name'</span><span class="p">,</span> <span class="s">'colored_name'</span><span class="p">)</span>
</pre></div>
</div>
</li>
<li><p class="first">If the string given is a method of the model, <tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> or a
callable that returns True or False Django will display a pretty "on" or
"off" icon if you give the method a <tt class="docutils literal"><span class="pre">boolean</span></tt> attribute whose value is
<tt class="xref docutils literal"><span class="pre">True</span></tt>.</p>
<p>Here's a full example model:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Person</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
<span class="n">first_name</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">50</span><span class="p">)</span>
<span class="n">birthday</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">DateField</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">born_in_fifties</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">birthday</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s">'%Y'</span><span class="p">)[:</span><span class="mi">3</span><span class="p">]</span> <span class="o">==</span> <span class="s">'195'</span>
<span class="n">born_in_fifties</span><span class="o">.</span><span class="n">boolean</span> <span class="o">=</span> <span class="bp">True</span>
<span class="k">class</span> <span class="nc">PersonAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="n">list_display</span> <span class="o">=</span> <span class="p">(</span><span class="s">'name'</span><span class="p">,</span> <span class="s">'born_in_fifties'</span><span class="p">)</span>
</pre></div>
</div>
</li>
<li><p class="first">The <tt class="docutils literal"><span class="pre">__str__()</span></tt> and <tt class="docutils literal"><span class="pre">__unicode__()</span></tt> methods are just as valid in
<tt class="docutils literal"><span class="pre">list_display</span></tt> as any other model method, so it's perfectly OK to do
this:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">list_display</span> <span class="o">=</span> <span class="p">(</span><span class="s">'__unicode__'</span><span class="p">,</span> <span class="s">'some_other_field'</span><span class="p">)</span>
</pre></div>
</div>
</li>
<li><p class="first">Usually, elements of <tt class="docutils literal"><span class="pre">list_display</span></tt> that aren't actual database fields
can't be used in sorting (because Django does all the sorting at the
database level).</p>
<p>However, if an element of <tt class="docutils literal"><span class="pre">list_display</span></tt> represents a certain database
field, you can indicate this fact by setting the <tt class="docutils literal"><span class="pre">admin_order_field</span></tt>
attribute of the item.</p>
<p>For example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Person</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
<span class="n">first_name</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">50</span><span class="p">)</span>
<span class="n">color_code</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">6</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">colored_first_name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="s">'<span style="color: #</span><span class="si">%s</span><span class="s">;"></span><span class="si">%s</span><span class="s"></span>'</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">color_code</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">first_name</span><span class="p">)</span>
<span class="n">colored_first_name</span><span class="o">.</span><span class="n">allow_tags</span> <span class="o">=</span> <span class="bp">True</span>
<span class="n">colored_first_name</span><span class="o">.</span><span class="n">admin_order_field</span> <span class="o">=</span> <span class="s">'first_name'</span>
<span class="k">class</span> <span class="nc">PersonAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="n">list_display</span> <span class="o">=</span> <span class="p">(</span><span class="s">'first_name'</span><span class="p">,</span> <span class="s">'colored_first_name'</span><span class="p">)</span>
</pre></div>
</div>
<p>The above will tell Django to order by the <tt class="docutils literal"><span class="pre">first_name</span></tt> field when
trying to sort by <tt class="docutils literal"><span class="pre">colored_first_name</span></tt> in the admin.</p>
</li>
</ul>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.list_display_links">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">list_display_links</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.list_display_links" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Set <tt class="docutils literal"><span class="pre">list_display_links</span></tt> to control which fields in <tt class="docutils literal"><span class="pre">list_display</span></tt> should
be linked to the "change" page for an object.</p>
<p>By default, the change list page will link the first column -- the first field
specified in <tt class="docutils literal"><span class="pre">list_display</span></tt> -- to the change page for each item. But
<tt class="docutils literal"><span class="pre">list_display_links</span></tt> lets you change which columns are linked. Set
<tt class="docutils literal"><span class="pre">list_display_links</span></tt> to a list or tuple of field names (in the same format as
<tt class="docutils literal"><span class="pre">list_display</span></tt>) to link.</p>
<p><tt class="docutils literal"><span class="pre">list_display_links</span></tt> can specify one or many field names. As long as the
field names appear in <tt class="docutils literal"><span class="pre">list_display</span></tt>, Django doesn't care how many (or how
few) fields are linked. The only requirement is: If you want to use
<tt class="docutils literal"><span class="pre">list_display_links</span></tt>, you must define <tt class="docutils literal"><span class="pre">list_display</span></tt>.</p>
<p>In this example, the <tt class="docutils literal"><span class="pre">first_name</span></tt> and <tt class="docutils literal"><span class="pre">last_name</span></tt> fields will be linked on
the change list page:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">PersonAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="n">list_display</span> <span class="o">=</span> <span class="p">(</span><span class="s">'first_name'</span><span class="p">,</span> <span class="s">'last_name'</span><span class="p">,</span> <span class="s">'birthday'</span><span class="p">)</span>
<span class="n">list_display_links</span> <span class="o">=</span> <span class="p">(</span><span class="s">'first_name'</span><span class="p">,</span> <span class="s">'last_name'</span><span class="p">)</span>
</pre></div>
</div>
<span class="target" id="admin-list-editable"></span><dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.list_editable">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">list_editable</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.list_editable" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<div class="versionadded">
<span class="title">New in Django 1.1:</span> <a class="reference external" href="../../../releases/1.1.html#releases-1-1"><em>Please, see the release notes</em></a></div>
<p>Set <tt class="docutils literal"><span class="pre">list_editable</span></tt> to a list of field names on the model which will allow
editing on the change list page. That is, fields listed in <tt class="docutils literal"><span class="pre">list_editable</span></tt>
will be displayed as form widgets on the change list page, allowing users to
edit and save multiple rows at once.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p><tt class="docutils literal"><span class="pre">list_editable</span></tt> interacts with a couple of other options in particular
ways; you should note the following rules:</p>
<ul class="simple">
<li>Any field in <tt class="docutils literal"><span class="pre">list_editable</span></tt> must also be in <tt class="docutils literal"><span class="pre">list_display</span></tt>. You
can't edit a field that's not displayed!</li>
<li>The same field can't be listed in both <tt class="docutils literal"><span class="pre">list_editable</span></tt> and
<tt class="docutils literal"><span class="pre">list_display_links</span></tt> -- a field can't be both a form and a link.</li>
</ul>
<p class="last">You'll get a validation error if either of these rules are broken.</p>
</div>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.list_filter">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">list_filter</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.list_filter" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Set <tt class="docutils literal"><span class="pre">list_filter</span></tt> to activate filters in the right sidebar of the change list
page of the admin. This should be a list of field names, and each specified
field should be either a <tt class="docutils literal"><span class="pre">BooleanField</span></tt>, <tt class="docutils literal"><span class="pre">CharField</span></tt>, <tt class="docutils literal"><span class="pre">DateField</span></tt>,
<tt class="docutils literal"><span class="pre">DateTimeField</span></tt>, <tt class="docutils literal"><span class="pre">IntegerField</span></tt> or <tt class="docutils literal"><span class="pre">ForeignKey</span></tt>.</p>
<p>This example, taken from the <tt class="docutils literal"><span class="pre">django.contrib.auth.models.User</span></tt> model, shows
how both <tt class="docutils literal"><span class="pre">list_display</span></tt> and <tt class="docutils literal"><span class="pre">list_filter</span></tt> work:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">UserAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="n">list_display</span> <span class="o">=</span> <span class="p">(</span><span class="s">'username'</span><span class="p">,</span> <span class="s">'email'</span><span class="p">,</span> <span class="s">'first_name'</span><span class="p">,</span> <span class="s">'last_name'</span><span class="p">,</span> <span class="s">'is_staff'</span><span class="p">)</span>
<span class="n">list_filter</span> <span class="o">=</span> <span class="p">(</span><span class="s">'is_staff'</span><span class="p">,</span> <span class="s">'is_superuser'</span><span class="p">)</span>
</pre></div>
</div>
<p>The above code results in an admin change list page that looks like this:</p>
<blockquote>
<img alt="../../../_images/users_changelist.png" src="../../../_images/users_changelist.png" />
</blockquote>
<p>(This example also has <tt class="docutils literal"><span class="pre">search_fields</span></tt> defined. See below.)</p>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.list_per_page">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">list_per_page</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.list_per_page" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Set <tt class="docutils literal"><span class="pre">list_per_page</span></tt> to control how many items appear on each paginated admin
change list page. By default, this is set to <tt class="docutils literal"><span class="pre">100</span></tt>.</p>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.list_select_related">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">list_select_related</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.list_select_related" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Set <tt class="docutils literal"><span class="pre">list_select_related</span></tt> to tell Django to use <tt class="docutils literal"><span class="pre">select_related()</span></tt> in
retrieving the list of objects on the admin change list page. This can save you
a bunch of database queries.</p>
<p>The value should be either <tt class="xref docutils literal"><span class="pre">True</span></tt> or <tt class="xref docutils literal"><span class="pre">False</span></tt>. Default is <tt class="xref docutils literal"><span class="pre">False</span></tt>.</p>
<p>Note that Django will use <tt class="docutils literal"><span class="pre">select_related()</span></tt>, regardless of this setting,
if one of the <tt class="docutils literal"><span class="pre">list_display</span></tt> fields is a <tt class="docutils literal"><span class="pre">ForeignKey</span></tt>.</p>
<p>For more on <tt class="docutils literal"><span class="pre">select_related()</span></tt>, see
<a class="reference external" href="../../models/querysets.html#select-related"><em>the select_related() docs</em></a>.</p>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.inlines">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">inlines</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.inlines" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>See <tt class="docutils literal"><span class="pre">InlineModelAdmin</span></tt> objects below.</p>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.ordering">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">ordering</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.ordering" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Set <tt class="docutils literal"><span class="pre">ordering</span></tt> to specify how objects on the admin change list page should be
ordered. This should be a list or tuple in the same format as a model's
<tt class="docutils literal"><span class="pre">ordering</span></tt> parameter.</p>
<p>If this isn't provided, the Django admin will use the model's default ordering.</p>
<div class="admonition-note admonition ">
<p class="first admonition-title">Note</p>
<p class="last">Django will only honor the first element in the list/tuple; any others
will be ignored.</p>
</div>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.prepopulated_fields">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">prepopulated_fields</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.prepopulated_fields" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Set <tt class="docutils literal"><span class="pre">prepopulated_fields</span></tt> to a dictionary mapping field names to the fields
it should prepopulate from:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">ArticleAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="n">prepopulated_fields</span> <span class="o">=</span> <span class="p">{</span><span class="s">"slug"</span><span class="p">:</span> <span class="p">(</span><span class="s">"title"</span><span class="p">,)}</span>
</pre></div>
</div>
<p>When set, the given fields will use a bit of JavaScript to populate from the
fields assigned. The main use for this functionality is to automatically
generate the value for <tt class="docutils literal"><span class="pre">SlugField</span></tt> fields from one or more other fields. The
generated value is produced by concatenating the values of the source fields,
and then by transforming that result into a valid slug (e.g. substituting
dashes for spaces).</p>
<p><tt class="docutils literal"><span class="pre">prepopulated_fields</span></tt> doesn't accept <tt class="docutils literal"><span class="pre">DateTimeField</span></tt>, <tt class="docutils literal"><span class="pre">ForeignKey</span></tt>, nor
<tt class="docutils literal"><span class="pre">ManyToManyField</span></tt> fields.</p>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.radio_fields">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">radio_fields</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.radio_fields" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>By default, Django's admin uses a select-box interface (<select>) for
fields that are <tt class="docutils literal"><span class="pre">ForeignKey</span></tt> or have <tt class="docutils literal"><span class="pre">choices</span></tt> set. If a field is present
in <tt class="docutils literal"><span class="pre">radio_fields</span></tt>, Django will use a radio-button interface instead.
Assuming <tt class="docutils literal"><span class="pre">group</span></tt> is a <tt class="docutils literal"><span class="pre">ForeignKey</span></tt> on the <tt class="docutils literal"><span class="pre">Person</span></tt> model:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">PersonAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="n">radio_fields</span> <span class="o">=</span> <span class="p">{</span><span class="s">"group"</span><span class="p">:</span> <span class="n">admin</span><span class="o">.</span><span class="n">VERTICAL</span><span class="p">}</span>
</pre></div>
</div>
<p>You have the choice of using <tt class="docutils literal"><span class="pre">HORIZONTAL</span></tt> or <tt class="docutils literal"><span class="pre">VERTICAL</span></tt> from the
<tt class="docutils literal"><span class="pre">django.contrib.admin</span></tt> module.</p>
<p>Don't include a field in <tt class="docutils literal"><span class="pre">radio_fields</span></tt> unless it's a <tt class="docutils literal"><span class="pre">ForeignKey</span></tt> or has
<tt class="docutils literal"><span class="pre">choices</span></tt> set.</p>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.raw_id_fields">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">raw_id_fields</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.raw_id_fields" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>By default, Django's admin uses a select-box interface (<select>) for
fields that are <tt class="docutils literal"><span class="pre">ForeignKey</span></tt>. Sometimes you don't want to incur the
overhead of having to select all the related instances to display in the
drop-down.</p>
<p><tt class="docutils literal"><span class="pre">raw_id_fields</span></tt> is a list of fields you would like to change
into a <tt class="docutils literal"><span class="pre">Input</span></tt> widget for either a <tt class="docutils literal"><span class="pre">ForeignKey</span></tt> or <tt class="docutils literal"><span class="pre">ManyToManyField</span></tt>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">ArticleAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="n">raw_id_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s">"newspaper"</span><span class="p">,)</span>
</pre></div>
</div>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.save_as">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">save_as</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.save_as" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Set <tt class="docutils literal"><span class="pre">save_as</span></tt> to enable a "save as" feature on admin change forms.</p>
<p>Normally, objects have three save options: "Save", "Save and continue editing"
and "Save and add another". If <tt class="docutils literal"><span class="pre">save_as</span></tt> is <tt class="xref docutils literal"><span class="pre">True</span></tt>, "Save and add another"
will be replaced by a "Save as" button.</p>
<p>"Save as" means the object will be saved as a new object (with a new ID),
rather than the old object.</p>
<p>By default, <tt class="docutils literal"><span class="pre">save_as</span></tt> is set to <tt class="xref docutils literal"><span class="pre">False</span></tt>.</p>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.save_on_top">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">save_on_top</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.save_on_top" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Set <tt class="docutils literal"><span class="pre">save_on_top</span></tt> to add save buttons across the top of your admin change
forms.</p>
<p>Normally, the save buttons appear only at the bottom of the forms. If you set
<tt class="docutils literal"><span class="pre">save_on_top</span></tt>, the buttons will appear both on the top and the bottom.</p>
<p>By default, <tt class="docutils literal"><span class="pre">save_on_top</span></tt> is set to <tt class="xref docutils literal"><span class="pre">False</span></tt>.</p>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.search_fields">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">search_fields</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.search_fields" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Set <tt class="docutils literal"><span class="pre">search_fields</span></tt> to enable a search box on the admin change list page.
This should be set to a list of field names that will be searched whenever
somebody submits a search query in that text box.</p>
<p>These fields should be some kind of text field, such as <tt class="docutils literal"><span class="pre">CharField</span></tt> or
<tt class="docutils literal"><span class="pre">TextField</span></tt>. You can also perform a related lookup on a <tt class="docutils literal"><span class="pre">ForeignKey</span></tt> with
the lookup API "follow" notation:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">search_fields</span> <span class="o">=</span> <span class="p">[</span><span class="s">'foreign_key__related_fieldname'</span><span class="p">]</span>
</pre></div>
</div>
<p>When somebody does a search in the admin search box, Django splits the search
query into words and returns all objects that contain each of the words, case
insensitive, where each word must be in at least one of <tt class="docutils literal"><span class="pre">search_fields</span></tt>. For
example, if <tt class="docutils literal"><span class="pre">search_fields</span></tt> is set to <tt class="docutils literal"><span class="pre">['first_name',</span> <span class="pre">'last_name']</span></tt> and a
user searches for <tt class="docutils literal"><span class="pre">john</span> <span class="pre">lennon</span></tt>, Django will do the equivalent of this SQL
<tt class="docutils literal"><span class="pre">WHERE</span></tt> clause:</p>
<div class="highlight-python"><pre>WHERE (first_name ILIKE '%john%' OR last_name ILIKE '%john%')
AND (first_name ILIKE '%lennon%' OR last_name ILIKE '%lennon%')</pre>
</div>
<p>For faster and/or more restrictive searches, prefix the field name
with an operator:</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">^</span></tt></dt>
<dd><p class="first">Matches the beginning of the field. For example, if <tt class="docutils literal"><span class="pre">search_fields</span></tt> is
set to <tt class="docutils literal"><span class="pre">['^first_name',</span> <span class="pre">'^last_name']</span></tt> and a user searches for
<tt class="docutils literal"><span class="pre">john</span> <span class="pre">lennon</span></tt>, Django will do the equivalent of this SQL <tt class="docutils literal"><span class="pre">WHERE</span></tt>
clause:</p>
<div class="highlight-python"><pre>WHERE (first_name ILIKE 'john%' OR last_name ILIKE 'john%')
AND (first_name ILIKE 'lennon%' OR last_name ILIKE 'lennon%')</pre>
</div>
<p class="last">This query is more efficient than the normal <tt class="docutils literal"><span class="pre">'%john%'</span></tt> query, because
the database only needs to check the beginning of a column's data, rather
than seeking through the entire column's data. Plus, if the column has an
index on it, some databases may be able to use the index for this query,
even though it's a <tt class="docutils literal"><span class="pre">LIKE</span></tt> query.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">=</span></tt></dt>
<dd><p class="first">Matches exactly, case-insensitive. For example, if
<tt class="docutils literal"><span class="pre">search_fields</span></tt> is set to <tt class="docutils literal"><span class="pre">['=first_name',</span> <span class="pre">'=last_name']</span></tt> and
a user searches for <tt class="docutils literal"><span class="pre">john</span> <span class="pre">lennon</span></tt>, Django will do the equivalent
of this SQL <tt class="docutils literal"><span class="pre">WHERE</span></tt> clause:</p>
<div class="highlight-python"><pre>WHERE (first_name ILIKE 'john' OR last_name ILIKE 'john')
AND (first_name ILIKE 'lennon' OR last_name ILIKE 'lennon')</pre>
</div>
<p class="last">Note that the query input is split by spaces, so, following this example,
it's currently not possible to search for all records in which
<tt class="docutils literal"><span class="pre">first_name</span></tt> is exactly <tt class="docutils literal"><span class="pre">'john</span> <span class="pre">winston'</span></tt> (containing a space).</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">@</span></tt></dt>
<dd>Performs a full-text match. This is like the default search method but uses
an index. Currently this is only available for MySQL.</dd>
</dl>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.formfield_overrides">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">formfield_overrides</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.formfield_overrides" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<div class="versionadded">
<span class="title">New in Django 1.1:</span> <a class="reference external" href="../../../releases/1.1.html#releases-1-1"><em>Please, see the release notes</em></a></div>
<p>This provides a quick-and-dirty way to override some of the
<a title="django.forms.Field" class="reference external" href="../../forms/fields.html#django.forms.Field"><tt class="xref docutils literal"><span class="pre">Field</span></tt></a> options for use in the admin.
<tt class="docutils literal"><span class="pre">formfield_overrides</span></tt> is a dictionary mapping a field class to a dict of
arguments to pass to the field at construction time.</p>
<p>Since that's a bit abstract, let's look at a concrete example. The most common
use of <tt class="docutils literal"><span class="pre">formfield_overrides</span></tt> is to add a custom widget for a certain type of
field. So, imagine we've written a <tt class="docutils literal"><span class="pre">RichTextEditorWidget</span></tt> that we'd like to
use for large text fields instead of the default <tt class="docutils literal"><span class="pre"><textarea></span></tt>. Here's how we'd
do that:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">django.db</span> <span class="kn">import</span> <span class="n">models</span>
<span class="kn">from</span> <span class="nn">django.contrib</span> <span class="kn">import</span> <span class="n">admin</span>
<span class="c"># Import our custom widget and our model from where they're defined</span>
<span class="kn">from</span> <span class="nn">myapp.widgets</span> <span class="kn">import</span> <span class="n">RichTextEditorWidget</span>
<span class="kn">from</span> <span class="nn">myapp.models</span> <span class="kn">import</span> <span class="n">MyModel</span>
<span class="k">class</span> <span class="nc">MyModelAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="n">formfield_overrides</span> <span class="o">=</span> <span class="p">{</span>
<span class="n">models</span><span class="o">.</span><span class="n">TextField</span><span class="p">:</span> <span class="p">{</span><span class="s">'widget'</span><span class="p">:</span> <span class="n">RichTextEditorWidget</span><span class="p">},</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Note that the key in the dictionary is the actual field class, <em>not</em> a string.
The value is another dictionary; these arguments will be passed to
<tt class="xref docutils literal"><span class="pre">__init__()</span></tt>. See <a class="reference external" href="../../forms/api.html#ref-forms-api"><em>The Forms API</em></a> for details.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p>If you want to use a custom widget with a relation field (i.e.
<a title="django.db.models.ForeignKey" class="reference external" href="../../models/fields.html#django.db.models.ForeignKey"><tt class="xref docutils literal"><span class="pre">ForeignKey</span></tt></a> or
<a title="django.db.models.ManyToManyField" class="reference external" href="../../models/fields.html#django.db.models.ManyToManyField"><tt class="xref docutils literal"><span class="pre">ManyToManyField</span></tt></a>), make sure you haven't included
that field's name in <tt class="docutils literal"><span class="pre">raw_id_fields</span></tt> or <tt class="docutils literal"><span class="pre">radio_fields</span></tt>.</p>
<p class="last"><tt class="docutils literal"><span class="pre">formfield_overrides</span></tt> won't let you change the widget on relation fields
that have <tt class="docutils literal"><span class="pre">raw_id_fields</span></tt> or <tt class="docutils literal"><span class="pre">radio_fields</span></tt> set. That's because
<tt class="docutils literal"><span class="pre">raw_id_fields</span></tt> and <tt class="docutils literal"><span class="pre">radio_fields</span></tt> imply custom widgets of their own.</p>
</div>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.actions">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">actions</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.actions" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<div class="versionadded">
<span class="title">New in Django 1.1:</span> <a class="reference external" href="../../../releases/1.1.html#releases-1-1"><em>Please, see the release notes</em></a></div>
<p>A list of actions to make available on the change list page. See
<a class="reference external" href="actions.html#ref-contrib-admin-actions"><em>Admin actions</em></a> for details.</p>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.actions_on_top">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">actions_on_top</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.actions_on_top" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.actions_on_bottom">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">actions_on_bottom</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.actions_on_bottom" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<div class="versionadded">
<span class="title">New in Django 1.1:</span> <a class="reference external" href="../../../releases/1.1.html#releases-1-1"><em>Please, see the release notes</em></a></div>
<p>Controls where on the page the actions bar appears. By default, the admin
changelist displays actions at the top of the page (<tt class="docutils literal"><span class="pre">actions_on_top</span> <span class="pre">=</span> <span class="pre">True;</span>
<span class="pre">actions_on_bottom</span> <span class="pre">=</span> <span class="pre">False</span></tt>).</p>
<div class="section" id="s-custom-template-options">
<span id="custom-template-options"></span><h4>Custom template options<a class="headerlink" href="#custom-template-options" title="Permalink to this headline">¶</a></h4>
<p>The <a class="reference internal" href="#overriding-admin-templates">Overriding Admin Templates</a> section describes how to override or extend
the default admin templates. Use the following options to override the default
templates used by the <a title="django.contrib.admin.ModelAdmin" class="reference internal" href="#django.contrib.admin.ModelAdmin"><tt class="xref docutils literal"><span class="pre">ModelAdmin</span></tt></a> views:</p>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.change_form_template">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">change_form_template</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.change_form_template" title="Permalink to this definition">¶</a></dt>
<dd>Path to a custom template, used by <a title="django.contrib.admin.ModelAdmin.change_view" class="reference internal" href="#django.contrib.admin.ModelAdmin.change_view"><tt class="xref docutils literal"><span class="pre">change_view()</span></tt></a>.</dd></dl>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.change_list_template">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">change_list_template</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.change_list_template" title="Permalink to this definition">¶</a></dt>
<dd>Path to a custom template, used by <a title="django.contrib.admin.ModelAdmin.changelist_view" class="reference internal" href="#django.contrib.admin.ModelAdmin.changelist_view"><tt class="xref docutils literal"><span class="pre">changelist_view()</span></tt></a>.</dd></dl>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.delete_confirmation_template">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">delete_confirmation_template</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.delete_confirmation_template" title="Permalink to this definition">¶</a></dt>
<dd>Path to a custom template, used by <a title="django.contrib.admin.ModelAdmin.delete_view" class="reference internal" href="#django.contrib.admin.ModelAdmin.delete_view"><tt class="xref docutils literal"><span class="pre">delete_view()</span></tt></a> for displaying a
confirmation page when deleting one or more objects.</dd></dl>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.delete_selected_confirmation_template">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">delete_selected_confirmation_template</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.delete_selected_confirmation_template" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
<span class="title">New in Django 1.1.2:</span> <a class="reference external" href="../../../releases/1.1.2.html#releases-1-1-2"><em>Please, see the release notes</em></a></div>
<p>Path to a custom template, used by the <tt class="xref docutils literal"><span class="pre">delete_selected()</span></tt>
action method for displaying a confirmation page when deleting one
or more objects. See the <a class="reference external" href="actions.html#ref-contrib-admin-actions"><em>actions
documentation</em></a>.</p>
</dd></dl>
<dl class="attribute">
<dt id="django.contrib.admin.ModelAdmin.object_history_template">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">object_history_template</tt><a class="headerlink" href="#django.contrib.admin.ModelAdmin.object_history_template" title="Permalink to this definition">¶</a></dt>
<dd>Path to a custom template, used by <a title="django.contrib.admin.ModelAdmin.history_view" class="reference internal" href="#django.contrib.admin.ModelAdmin.history_view"><tt class="xref docutils literal"><span class="pre">history_view()</span></tt></a>.</dd></dl>
</div>
</div>
<div class="section" id="s-modeladmin-methods">
<span id="s-model-admin-methods"></span><span id="modeladmin-methods"></span><span id="model-admin-methods"></span><h3><tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> methods<a class="headerlink" href="#modeladmin-methods" title="Permalink to this headline">¶</a></h3>
<dl class="method">
<dt id="django.contrib.admin.ModelAdmin.save_model">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">save_model</tt>(<em>self</em>, <em>request</em>, <em>obj</em>, <em>form</em>, <em>change</em>)<a class="headerlink" href="#django.contrib.admin.ModelAdmin.save_model" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>The <tt class="docutils literal"><span class="pre">save_model</span></tt> method is given the <tt class="docutils literal"><span class="pre">HttpRequest</span></tt>, a model instance,
a <tt class="docutils literal"><span class="pre">ModelForm</span></tt> instance and a boolean value based on whether it is adding or
changing the object. Here you can do any pre- or post-save operations.</p>
<p>For example to attach <tt class="docutils literal"><span class="pre">request.user</span></tt> to the object prior to saving:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">ArticleAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">save_model</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">form</span><span class="p">,</span> <span class="n">change</span><span class="p">):</span>
<span class="n">obj</span><span class="o">.</span><span class="n">user</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">user</span>
<span class="n">obj</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
</pre></div>
</div>
<dl class="method">
<dt id="django.contrib.admin.ModelAdmin.save_formset">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">save_formset</tt>(<em>self</em>, <em>request</em>, <em>form</em>, <em>formset</em>, <em>change</em>)<a class="headerlink" href="#django.contrib.admin.ModelAdmin.save_formset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>The <tt class="docutils literal"><span class="pre">save_formset</span></tt> method is given the <tt class="docutils literal"><span class="pre">HttpRequest</span></tt>, the parent
<tt class="docutils literal"><span class="pre">ModelForm</span></tt> instance and a boolean value based on whether it is adding or
changing the parent object.</p>
<p>For example to attach <tt class="docutils literal"><span class="pre">request.user</span></tt> to each changed formset
model instance:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">ArticleAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">save_formset</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">form</span><span class="p">,</span> <span class="n">formset</span><span class="p">,</span> <span class="n">change</span><span class="p">):</span>
<span class="n">instances</span> <span class="o">=</span> <span class="n">formset</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">commit</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span>
<span class="k">for</span> <span class="n">instance</span> <span class="ow">in</span> <span class="n">instances</span><span class="p">:</span>
<span class="n">instance</span><span class="o">.</span><span class="n">user</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">user</span>
<span class="n">instance</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
<span class="n">formset</span><span class="o">.</span><span class="n">save_m2m</span><span class="p">()</span>
</pre></div>
</div>
<dl class="method">
<dt id="django.contrib.admin.ModelAdmin.get_urls">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">get_urls</tt>(<em>self</em>)<a class="headerlink" href="#django.contrib.admin.ModelAdmin.get_urls" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<div class="versionadded">
<span class="title">New in Django 1.1:</span> <a class="reference external" href="../../../releases/1.1.html#releases-1-1"><em>Please, see the release notes</em></a></div>
<p>The <tt class="docutils literal"><span class="pre">get_urls</span></tt> method on a <tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> returns the URLs to be used for
that ModelAdmin in the same way as a URLconf. Therefore you can extend them as
documented in <a class="reference external" href="../../../topics/http/urls.html#topics-http-urls"><em>URL dispatcher</em></a>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">MyModelAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">get_urls</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">urls</span> <span class="o">=</span> <span class="nb">super</span><span class="p">(</span><span class="n">MyModelAdmin</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">get_urls</span><span class="p">()</span>
<span class="n">my_urls</span> <span class="o">=</span> <span class="n">patterns</span><span class="p">(</span><span class="s">''</span><span class="p">,</span>
<span class="p">(</span><span class="s">r'^my_view/$'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">my_view</span><span class="p">)</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">my_urls</span> <span class="o">+</span> <span class="n">urls</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Notice that the custom patterns are included <em>before</em> the regular admin
URLs: the admin URL patterns are very permissive and will match nearly
anything, so you'll usually want to prepend your custom URLs to the built-in
ones.</p>
</div>
<p>However, the <tt class="docutils literal"><span class="pre">self.my_view</span></tt> function registered above suffers from two
problems:</p>
<ul class="simple">
<li>It will <em>not</em> perform any permission checks, so it will be accessible to
the general public.</li>
<li>It will <em>not</em> provide any header details to prevent caching. This means if
the page retrieves data from the database, and caching middleware is
active, the page could show outdated information.</li>
</ul>
<p>Since this is usually not what you want, Django provides a convenience wrapper
to check permissions and mark the view as non-cacheable. This wrapper is
<tt class="xref docutils literal"><span class="pre">AdminSite.admin_view()</span></tt> (i.e. <tt class="docutils literal"><span class="pre">self.admin_site.admin_view</span></tt> inside a
<tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> instance); use it like so:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">MyModelAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">get_urls</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">urls</span> <span class="o">=</span> <span class="nb">super</span><span class="p">(</span><span class="n">MyModelAdmin</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">get_urls</span><span class="p">()</span>
<span class="n">my_urls</span> <span class="o">=</span> <span class="n">patterns</span><span class="p">(</span><span class="s">''</span><span class="p">,</span>
<span class="p">(</span><span class="s">r'^my_view/$'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">admin_site</span><span class="o">.</span><span class="n">admin_view</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">my_view</span><span class="p">))</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">my_urls</span> <span class="o">+</span> <span class="n">urls</span>
</pre></div>
</div>
<p>Notice the wrapped view in the fifth line above:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">(</span><span class="s">r'^my_view/$'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">admin_site</span><span class="o">.</span><span class="n">admin_view</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">my_view</span><span class="p">))</span>
</pre></div>
</div>
<p>This wrapping will protect <tt class="docutils literal"><span class="pre">self.my_view</span></tt> from unauthorized access and will
apply the <tt class="docutils literal"><span class="pre">django.views.decorators.cache.never_cache</span></tt> decorator to make sure
it is not cached if the cache middleware is active.</p>
<p>If the page is cacheable, but you still want the permission check to be performed,
you can pass a <tt class="docutils literal"><span class="pre">cacheable=True</span></tt> argument to <tt class="xref docutils literal"><span class="pre">AdminSite.admin_view()</span></tt>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">(</span><span class="s">r'^my_view/$'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">admin_site</span><span class="o">.</span><span class="n">admin_view</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">my_view</span><span class="p">,</span> <span class="n">cacheable</span><span class="o">=</span><span class="bp">True</span><span class="p">))</span>
</pre></div>
</div>
<dl class="method">
<dt id="django.contrib.admin.ModelAdmin.formfield_for_foreignkey">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">formfield_for_foreignkey</tt>(<em>self</em>, <em>db_field</em>, <em>request</em>, <em>**kwargs</em>)<a class="headerlink" href="#django.contrib.admin.ModelAdmin.formfield_for_foreignkey" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<div class="versionadded">
<span class="title">New in Django 1.1:</span> <a class="reference external" href="../../../releases/1.1.html#releases-1-1"><em>Please, see the release notes</em></a></div>
<p>The <tt class="docutils literal"><span class="pre">formfield_for_foreignkey</span></tt> method on a <tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> allows you to
override the default formfield for a foreign key field. For example, to
return a subset of objects for this foreign key field based on the user:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">MyModelAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">formfield_for_foreignkey</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">db_field</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">if</span> <span class="n">db_field</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="s">"car"</span><span class="p">:</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s">"queryset"</span><span class="p">]</span> <span class="o">=</span> <span class="n">Car</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">owner</span><span class="o">=</span><span class="n">request</span><span class="o">.</span><span class="n">user</span><span class="p">)</span>
<span class="k">return</span> <span class="n">db_field</span><span class="o">.</span><span class="n">formfield</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">super</span><span class="p">(</span><span class="n">MyModelAdmin</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">formfield_for_foreignkey</span><span class="p">(</span><span class="n">db_field</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<p>This uses the <tt class="docutils literal"><span class="pre">HttpRequest</span></tt> instance to filter the <tt class="docutils literal"><span class="pre">Car</span></tt> foreign key field
to only the cars owned by the <tt class="docutils literal"><span class="pre">User</span></tt> instance.</p>
<dl class="method">
<dt id="django.contrib.admin.ModelAdmin.queryset">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">queryset</tt>(<em>self</em>, <em>request</em>)<a class="headerlink" href="#django.contrib.admin.ModelAdmin.queryset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>The <tt class="docutils literal"><span class="pre">queryset</span></tt> method on a <tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> returns a
<tt class="xref docutils literal"><span class="pre">QuerySet</span></tt> of all model instances that can be
edited by the admin site. One use case for overriding this method is
to show objects owned by the logged-in user:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">MyModelAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">queryset</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span>
<span class="n">qs</span> <span class="o">=</span> <span class="nb">super</span><span class="p">(</span><span class="n">MyModelAdmin</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">queryset</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
<span class="k">if</span> <span class="n">request</span><span class="o">.</span><span class="n">user</span><span class="o">.</span><span class="n">is_superuser</span><span class="p">:</span>
<span class="k">return</span> <span class="n">qs</span>
<span class="k">return</span> <span class="n">qs</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">author</span><span class="o">=</span><span class="n">request</span><span class="o">.</span><span class="n">user</span><span class="p">)</span>
</pre></div>
</div>
<div class="section" id="s-other-methods">
<span id="other-methods"></span><h4>Other methods<a class="headerlink" href="#other-methods" title="Permalink to this headline">¶</a></h4>
<dl class="method">
<dt id="django.contrib.admin.ModelAdmin.add_view">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">add_view</tt>(<em>self</em>, <em>request</em>, <em>form_url=''</em>, <em>extra_context=None</em>)<a class="headerlink" href="#django.contrib.admin.ModelAdmin.add_view" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Django view for the model instance addition page. See note below.</p>
<dl class="method">
<dt id="django.contrib.admin.ModelAdmin.change_view">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">change_view</tt>(<em>self</em>, <em>request</em>, <em>object_id</em>, <em>extra_context=None</em>)<a class="headerlink" href="#django.contrib.admin.ModelAdmin.change_view" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Django view for the model instance edition page. See note below.</p>
<dl class="method">
<dt id="django.contrib.admin.ModelAdmin.changelist_view">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">changelist_view</tt>(<em>self</em>, <em>request</em>, <em>extra_context=None</em>)<a class="headerlink" href="#django.contrib.admin.ModelAdmin.changelist_view" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Django view for the model instances change list/actions page. See note below.</p>
<dl class="method">
<dt id="django.contrib.admin.ModelAdmin.delete_view">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">delete_view</tt>(<em>self</em>, <em>request</em>, <em>object_id</em>, <em>extra_context=None</em>)<a class="headerlink" href="#django.contrib.admin.ModelAdmin.delete_view" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Django view for the model instance(s) deletion confirmation page. See note below.</p>
<dl class="method">
<dt id="django.contrib.admin.ModelAdmin.history_view">
<tt class="descclassname">ModelAdmin.</tt><tt class="descname">history_view</tt>(<em>self</em>, <em>request</em>, <em>object_id</em>, <em>extra_context=None</em>)<a class="headerlink" href="#django.contrib.admin.ModelAdmin.history_view" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Django view for the page that shows the modification history for a given model
instance.</p>
<p>Unlike the hook-type <tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> methods detailed in the previous section,
these five methods are in reality designed to be invoked as Django views from
the admin application URL dispatching handler to render the pages that deal
with model instances CRUD operations. As a result, completely overriding these
methods will significantly change the behavior of the admin application.</p>
<p>One common reason for overriding these methods is to augment the context data
that is provided to the template that renders the view. In the following
example, the change view is overridden so that the rendered template is
provided some extra mapping data that would not otherwise be available:</p>
<div class="highlight-python"><pre>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):
# ...
def change_view(self, request, object_id, extra_context=None):
my_context = {
'osm_data': self.get_osm_info(),
}
return super(MyModelAdmin, self).change_view(request, object_id,
extra_context=my_context)</pre>
</div>
</div>
</div>
<div class="section" id="s-modeladmin-media-definitions">
<span id="modeladmin-media-definitions"></span><h3><tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> media definitions<a class="headerlink" href="#modeladmin-media-definitions" title="Permalink to this headline">¶</a></h3>
<p>There are times where you would like add a bit of CSS and/or JavaScript to
the add/change views. This can be accomplished by using a Media inner class
on your <tt class="docutils literal"><span class="pre">ModelAdmin</span></tt>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">ArticleAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="k">class</span> <span class="nc">Media</span><span class="p">:</span>
<span class="n">css</span> <span class="o">=</span> <span class="p">{</span>
<span class="s">"all"</span><span class="p">:</span> <span class="p">(</span><span class="s">"my_styles.css"</span><span class="p">,)</span>
<span class="p">}</span>
<span class="n">js</span> <span class="o">=</span> <span class="p">(</span><span class="s">"my_code.js"</span><span class="p">,)</span>
</pre></div>
</div>
<p>Keep in mind that this will be prepended with <tt class="docutils literal"><span class="pre">MEDIA_URL</span></tt>. The same rules
apply as <a class="reference external" href="../../../topics/forms/media.html#topics-forms-media"><em>regular media definitions on forms</em></a>.</p>
</div>
<div class="section" id="s-adding-custom-validation-to-the-admin">
<span id="adding-custom-validation-to-the-admin"></span><h3>Adding custom validation to the admin<a class="headerlink" href="#adding-custom-validation-to-the-admin" title="Permalink to this headline">¶</a></h3>
<p>Adding custom validation of data in the admin is quite easy. The automatic admin
interface reuses <tt class="xref docutils literal"><span class="pre">django.forms</span></tt>, and the <tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> class gives you
the ability define your own form:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">ArticleAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="n">form</span> <span class="o">=</span> <span class="n">MyArticleAdminForm</span>
</pre></div>
</div>
<p><tt class="docutils literal"><span class="pre">MyArticleAdminForm</span></tt> can be defined anywhere as long as you import where
needed. Now within your form you can add your own custom validation for
any field:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">MyArticleAdminForm</span><span class="p">(</span><span class="n">forms</span><span class="o">.</span><span class="n">ModelForm</span><span class="p">):</span>
<span class="k">class</span> <span class="nc">Meta</span><span class="p">:</span>
<span class="n">model</span> <span class="o">=</span> <span class="n">Article</span>
<span class="k">def</span> <span class="nf">clean_name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c"># do something that validates your data</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">cleaned_data</span><span class="p">[</span><span class="s">"name"</span><span class="p">]</span>
</pre></div>
</div>
<p>It is important you use a <tt class="docutils literal"><span class="pre">ModelForm</span></tt> here otherwise things can break. See the
<a class="reference external" href="../../forms/index.html#ref-forms-index"><em>forms</em></a> documentation on <a class="reference external" href="../../forms/validation.html#ref-forms-validation"><em>custom validation</em></a> and, more specifically, the
<a class="reference external" href="../../../topics/forms/modelforms.html#overriding-modelform-clean-method"><em>model form validation notes</em></a> for more
information.</p>
</div>
</div>
<div class="section" id="s-inlinemodeladmin-objects">
<span id="s-admin-inlines"></span><span id="inlinemodeladmin-objects"></span><span id="admin-inlines"></span><h2><tt class="docutils literal"><span class="pre">InlineModelAdmin</span></tt> objects<a class="headerlink" href="#inlinemodeladmin-objects" title="Permalink to this headline">¶</a></h2>
<p>The admin interface has the ability to edit models on the same page as a
parent model. These are called inlines. Suppose you have these two models:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Author</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">100</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">Book</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
<span class="n">author</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">ForeignKey</span><span class="p">(</span><span class="n">Author</span><span class="p">)</span>
<span class="n">title</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">100</span><span class="p">)</span>
</pre></div>
</div>
<p>You can edit the books authored by an author on the author page. You add
inlines to a model by specifying them in a <tt class="docutils literal"><span class="pre">ModelAdmin.inlines</span></tt>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">BookInline</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">TabularInline</span><span class="p">):</span>
<span class="n">model</span> <span class="o">=</span> <span class="n">Book</span>
<span class="k">class</span> <span class="nc">AuthorAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="n">inlines</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">BookInline</span><span class="p">,</span>
<span class="p">]</span>
</pre></div>
</div>
<p>Django provides two subclasses of <tt class="docutils literal"><span class="pre">InlineModelAdmin</span></tt> and they are:</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">TabularInline</span></tt></li>
<li><tt class="docutils literal"><span class="pre">StackedInline</span></tt></li>
</ul>
<p>The difference between these two is merely the template used to render them.</p>
<div class="section" id="s-inlinemodeladmin-options">
<span id="inlinemodeladmin-options"></span><h3><tt class="docutils literal"><span class="pre">InlineModelAdmin</span></tt> options<a class="headerlink" href="#inlinemodeladmin-options" title="Permalink to this headline">¶</a></h3>
<p>The <tt class="docutils literal"><span class="pre">InlineModelAdmin</span></tt> class is a subclass of <tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> so it inherits
all the same functionality as well as some of its own:</p>
<div class="section" id="s-model">
<span id="model"></span><h4><tt class="docutils literal"><span class="pre">model</span></tt><a class="headerlink" href="#model" title="Permalink to this headline">¶</a></h4>
<p>The model in which the inline is using. This is required.</p>
</div>
<div class="section" id="s-fk-name">
<span id="fk-name"></span><h4><tt class="docutils literal"><span class="pre">fk_name</span></tt><a class="headerlink" href="#fk-name" title="Permalink to this headline">¶</a></h4>
<p>The name of the foreign key on the model. In most cases this will be dealt
with automatically, but <tt class="docutils literal"><span class="pre">fk_name</span></tt> must be specified explicitly if there are
more than one foreign key to the same parent model.</p>
</div>
<div class="section" id="s-formset">
<span id="formset"></span><h4><tt class="docutils literal"><span class="pre">formset</span></tt><a class="headerlink" href="#formset" title="Permalink to this headline">¶</a></h4>
<p>This defaults to <tt class="docutils literal"><span class="pre">BaseInlineFormSet</span></tt>. Using your own formset can give you
many possibilities of customization. Inlines are built around
<a class="reference external" href="../../../topics/forms/modelforms.html#model-formsets"><em>model formsets</em></a>.</p>
</div>
<div class="section" id="s-form">
<span id="form"></span><h4><tt class="docutils literal"><span class="pre">form</span></tt><a class="headerlink" href="#form" title="Permalink to this headline">¶</a></h4>
<p>The value for <tt class="docutils literal"><span class="pre">form</span></tt> defaults to <tt class="docutils literal"><span class="pre">ModelForm</span></tt>. This is what is
passed through to <tt class="docutils literal"><span class="pre">inlineformset_factory</span></tt> when creating the formset for this
inline.</p>
</div>
<div class="section" id="s-extra">
<span id="extra"></span><h4><tt class="docutils literal"><span class="pre">extra</span></tt><a class="headerlink" href="#extra" title="Permalink to this headline">¶</a></h4>
<p>This controls the number of extra forms the formset will display in addition
to the initial forms. See the
<a class="reference external" href="../../../topics/forms/formsets.html#topics-forms-formsets"><em>formsets documentation</em></a> for more information.</p>
</div>
<div class="section" id="s-max-num">
<span id="max-num"></span><h4><tt class="docutils literal"><span class="pre">max_num</span></tt><a class="headerlink" href="#max-num" title="Permalink to this headline">¶</a></h4>
<p>This controls the maximum number of forms to show in the inline. This doesn't
directly correlate to the number of objects, but can if the value is small
enough. See <a class="reference external" href="../../../topics/forms/modelforms.html#model-formsets-max-num"><em>Limiting the number of editable objects</em></a> for more information.</p>
</div>
<div class="section" id="s-raw-id-fields">
<span id="raw-id-fields"></span><h4><tt class="docutils literal"><span class="pre">raw_id_fields</span></tt><a class="headerlink" href="#raw-id-fields" title="Permalink to this headline">¶</a></h4>
<p>By default, Django's admin uses a select-box interface (<select>) for
fields that are <tt class="docutils literal"><span class="pre">ForeignKey</span></tt>. Sometimes you don't want to incur the
overhead of having to select all the related instances to display in the
drop-down.</p>
<p><tt class="docutils literal"><span class="pre">raw_id_fields</span></tt> is a list of fields you would like to change
into a <tt class="docutils literal"><span class="pre">Input</span></tt> widget for either a <tt class="docutils literal"><span class="pre">ForeignKey</span></tt> or <tt class="docutils literal"><span class="pre">ManyToManyField</span></tt>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">BookInline</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">TabularInline</span><span class="p">):</span>
<span class="n">model</span> <span class="o">=</span> <span class="n">Book</span>
<span class="n">raw_id_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s">"pages"</span><span class="p">,)</span>
</pre></div>
</div>
</div>
<div class="section" id="s-template">
<span id="template"></span><h4><tt class="docutils literal"><span class="pre">template</span></tt><a class="headerlink" href="#template" title="Permalink to this headline">¶</a></h4>
<p>The template used to render the inline on the page.</p>
</div>
<div class="section" id="s-verbose-name">
<span id="verbose-name"></span><h4><tt class="docutils literal"><span class="pre">verbose_name</span></tt><a class="headerlink" href="#verbose-name" title="Permalink to this headline">¶</a></h4>
<p>An override to the <tt class="docutils literal"><span class="pre">verbose_name</span></tt> found in the model's inner <tt class="docutils literal"><span class="pre">Meta</span></tt> class.</p>
</div>
<div class="section" id="s-verbose-name-plural">
<span id="verbose-name-plural"></span><h4><tt class="docutils literal"><span class="pre">verbose_name_plural</span></tt><a class="headerlink" href="#verbose-name-plural" title="Permalink to this headline">¶</a></h4>
<p>An override to the <tt class="docutils literal"><span class="pre">verbose_name_plural</span></tt> found in the model's inner <tt class="docutils literal"><span class="pre">Meta</span></tt>
class.</p>
</div>
</div>
<div class="section" id="s-working-with-a-model-with-two-or-more-foreign-keys-to-the-same-parent-model">
<span id="working-with-a-model-with-two-or-more-foreign-keys-to-the-same-parent-model"></span><h3>Working with a model with two or more foreign keys to the same parent model<a class="headerlink" href="#working-with-a-model-with-two-or-more-foreign-keys-to-the-same-parent-model" title="Permalink to this headline">¶</a></h3>
<p>It is sometimes possible to have more than one foreign key to the same model.
Take this model for instance:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Friendship</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
<span class="n">to_person</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">ForeignKey</span><span class="p">(</span><span class="n">Person</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s">"friends"</span><span class="p">)</span>
<span class="n">from_person</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">ForeignKey</span><span class="p">(</span><span class="n">Person</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s">"from_friends"</span><span class="p">)</span>
</pre></div>
</div>
<p>If you wanted to display an inline on the <tt class="docutils literal"><span class="pre">Person</span></tt> admin add/change pages
you need to explicitly define the foreign key since it is unable to do so
automatically:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">FriendshipInline</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">TabularInline</span><span class="p">):</span>
<span class="n">model</span> <span class="o">=</span> <span class="n">Friendship</span>
<span class="n">fk_name</span> <span class="o">=</span> <span class="s">"to_person"</span>
<span class="k">class</span> <span class="nc">PersonAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="n">inlines</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">FriendshipInline</span><span class="p">,</span>
<span class="p">]</span>
</pre></div>
</div>
</div>
<div class="section" id="s-working-with-many-to-many-intermediary-models">
<span id="working-with-many-to-many-intermediary-models"></span><h3>Working with Many-to-Many Intermediary Models<a class="headerlink" href="#working-with-many-to-many-intermediary-models" title="Permalink to this headline">¶</a></h3>
<p>By default, admin widgets for many-to-many relations will be displayed inline
on whichever model contains the actual reference to the <tt class="docutils literal"><span class="pre">ManyToManyField</span></tt>.
However, when you specify an intermediary model using the <tt class="docutils literal"><span class="pre">through</span></tt>
argument to a <tt class="docutils literal"><span class="pre">ManyToManyField</span></tt>, the admin will not display a widget by
default. This is because each instance of that intermediary model requires
more information than could be displayed in a single widget, and the layout
required for multiple widgets will vary depending on the intermediate model.</p>
<p>However, we still want to be able to edit that information inline. Fortunately,
this is easy to do with inline admin models. Suppose we have the following
models:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Person</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">128</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">Group</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">128</span><span class="p">)</span>
<span class="n">members</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">ManyToManyField</span><span class="p">(</span><span class="n">Person</span><span class="p">,</span> <span class="n">through</span><span class="o">=</span><span class="s">'Membership'</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">Membership</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
<span class="n">person</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">ForeignKey</span><span class="p">(</span><span class="n">Person</span><span class="p">)</span>
<span class="n">group</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">ForeignKey</span><span class="p">(</span><span class="n">Group</span><span class="p">)</span>
<span class="n">date_joined</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">DateField</span><span class="p">()</span>
<span class="n">invite_reason</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">64</span><span class="p">)</span>
</pre></div>
</div>
<p>The first step in displaying this intermediate model in the admin is to
define an inline class for the <tt class="docutils literal"><span class="pre">Membership</span></tt> model:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">MembershipInline</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">TabularInline</span><span class="p">):</span>
<span class="n">model</span> <span class="o">=</span> <span class="n">Membership</span>
<span class="n">extra</span> <span class="o">=</span> <span class="mi">1</span>
</pre></div>
</div>
<p>This simple example uses the default <tt class="docutils literal"><span class="pre">InlineModelAdmin</span></tt> values for the
<tt class="docutils literal"><span class="pre">Membership</span></tt> model, and limits the extra add forms to one. This could be
customized using any of the options available to <tt class="docutils literal"><span class="pre">InlineModelAdmin</span></tt> classes.</p>
<p>Now create admin views for the <tt class="docutils literal"><span class="pre">Person</span></tt> and <tt class="docutils literal"><span class="pre">Group</span></tt> models:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">PersonAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="n">inlines</span> <span class="o">=</span> <span class="p">(</span><span class="n">MembershipInline</span><span class="p">,)</span>
<span class="k">class</span> <span class="nc">GroupAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="n">inlines</span> <span class="o">=</span> <span class="p">(</span><span class="n">MembershipInline</span><span class="p">,)</span>
</pre></div>
</div>
<p>Finally, register your <tt class="docutils literal"><span class="pre">Person</span></tt> and <tt class="docutils literal"><span class="pre">Group</span></tt> models with the admin site:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">admin</span><span class="o">.</span><span class="n">site</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">Person</span><span class="p">,</span> <span class="n">PersonAdmin</span><span class="p">)</span>
<span class="n">admin</span><span class="o">.</span><span class="n">site</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">Group</span><span class="p">,</span> <span class="n">GroupAdmin</span><span class="p">)</span>
</pre></div>
</div>
<p>Now your admin site is set up to edit <tt class="docutils literal"><span class="pre">Membership</span></tt> objects inline from
either the <tt class="docutils literal"><span class="pre">Person</span></tt> or the <tt class="docutils literal"><span class="pre">Group</span></tt> detail pages.</p>
</div>
<div class="section" id="s-using-generic-relations-as-an-inline">
<span id="using-generic-relations-as-an-inline"></span><h3>Using generic relations as an inline<a class="headerlink" href="#using-generic-relations-as-an-inline" title="Permalink to this headline">¶</a></h3>
<p>It is possible to use an inline with generically related objects. Let's say
you have the following models:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Image</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
<span class="n">image</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">ImageField</span><span class="p">(</span><span class="n">upload_to</span><span class="o">=</span><span class="s">"images"</span><span class="p">)</span>
<span class="n">content_type</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">ForeignKey</span><span class="p">(</span><span class="n">ContentType</span><span class="p">)</span>
<span class="n">object_id</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">PositiveIntegerField</span><span class="p">()</span>
<span class="n">content_object</span> <span class="o">=</span> <span class="n">generic</span><span class="o">.</span><span class="n">GenericForeignKey</span><span class="p">(</span><span class="s">"content_type"</span><span class="p">,</span> <span class="s">"object_id"</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">Product</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">100</span><span class="p">)</span>
</pre></div>
</div>
<p>If you want to allow editing and creating <tt class="docutils literal"><span class="pre">Image</span></tt> instance on the <tt class="docutils literal"><span class="pre">Product</span></tt>
add/change views you can simply use <tt class="docutils literal"><span class="pre">GenericInlineModelAdmin</span></tt> provided by
<tt class="docutils literal"><span class="pre">django.contrib.contenttypes.generic</span></tt>. In your <tt class="docutils literal"><span class="pre">admin.py</span></tt> for this
example app:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">django.contrib</span> <span class="kn">import</span> <span class="n">admin</span>
<span class="kn">from</span> <span class="nn">django.contrib.contenttypes</span> <span class="kn">import</span> <span class="n">generic</span>
<span class="kn">from</span> <span class="nn">myproject.myapp.models</span> <span class="kn">import</span> <span class="n">Image</span><span class="p">,</span> <span class="n">Product</span>
<span class="k">class</span> <span class="nc">ImageInline</span><span class="p">(</span><span class="n">generic</span><span class="o">.</span><span class="n">GenericTabularInline</span><span class="p">):</span>
<span class="n">model</span> <span class="o">=</span> <span class="n">Image</span>
<span class="k">class</span> <span class="nc">ProductAdmin</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">ModelAdmin</span><span class="p">):</span>
<span class="n">inlines</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">ImageInline</span><span class="p">,</span>
<span class="p">]</span>
<span class="n">admin</span><span class="o">.</span><span class="n">site</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">Product</span><span class="p">,</span> <span class="n">ProductAdmin</span><span class="p">)</span>
</pre></div>
</div>
<p><tt class="docutils literal"><span class="pre">django.contrib.contenttypes.generic</span></tt> provides both a <tt class="docutils literal"><span class="pre">GenericTabularInline</span></tt>
and <tt class="docutils literal"><span class="pre">GenericStackedInline</span></tt> and behave just like any other inline. See the
<a class="reference external" href="../contenttypes.html#ref-contrib-contenttypes"><em>contenttypes documentation</em></a> for more specific
information.</p>
</div>
</div>
<div class="section" id="s-overriding-admin-templates">
<span id="overriding-admin-templates"></span><h2>Overriding Admin Templates<a class="headerlink" href="#overriding-admin-templates" title="Permalink to this headline">¶</a></h2>
<p>It is relatively easy to override many of the templates which the admin module
uses to generate the various pages of an admin site. You can even override a few
of these templates for a specific app, or a specific model.</p>
<div class="section" id="s-set-up-your-projects-admin-template-directories">
<span id="set-up-your-projects-admin-template-directories"></span><h3>Set up your projects admin template directories<a class="headerlink" href="#set-up-your-projects-admin-template-directories" title="Permalink to this headline">¶</a></h3>
<p>The admin template files are located in the <tt class="docutils literal"><span class="pre">contrib/admin/templates/admin</span></tt>
directory.</p>
<p>In order to override one or more of them, first create an <tt class="docutils literal"><span class="pre">admin</span></tt> directory in
your project's <tt class="docutils literal"><span class="pre">templates</span></tt> directory. This can be any of the directories you
specified in <tt class="docutils literal"><span class="pre">TEMPLATE_DIRS</span></tt>.</p>
<p>Within this <tt class="docutils literal"><span class="pre">admin</span></tt> directory, create sub-directories named after your app.
Within these app subdirectories create sub-directories named after your models.
Note, that the admin app will lowercase the model name when looking for the
directory, so make sure you name the directory in all lowercase if you are going
to run your app on a case-sensitive filesystem.</p>
<p>To override an admin template for a specific app, copy and edit the template
from the <tt class="docutils literal"><span class="pre">django/contrib/admin/templates/admin</span></tt> directory, and save it to one
of the directories you just created.</p>
<p>For example, if we wanted to add a tool to the change list view for all the
models in an app named <tt class="docutils literal"><span class="pre">my_app</span></tt>, we would copy
<tt class="docutils literal"><span class="pre">contrib/admin/templates/admin/change_list.html</span></tt> to the
<tt class="docutils literal"><span class="pre">templates/admin/my_app/</span></tt> directory of our project, and make any necessary
changes.</p>
<p>If we wanted to add a tool to the change list view for only a specific model
named 'Page', we would copy that same file to the
<tt class="docutils literal"><span class="pre">templates/admin/my_app/page</span></tt> directory of our project.</p>
</div>
<div class="section" id="s-overriding-vs-replacing-an-admin-template">
<span id="overriding-vs-replacing-an-admin-template"></span><h3>Overriding vs. replacing an admin template<a class="headerlink" href="#overriding-vs-replacing-an-admin-template" title="Permalink to this headline">¶</a></h3>
<p>Because of the modular design of the admin templates, it is usually neither
necessary nor advisable to replace an entire template. It is almost always
better to override only the section of the template which you need to change.</p>
<p>To continue the example above, we want to add a new link next to the <tt class="docutils literal"><span class="pre">History</span></tt>
tool for the <tt class="docutils literal"><span class="pre">Page</span></tt> model. After looking at <tt class="docutils literal"><span class="pre">change_form.html</span></tt> we determine
that we only need to override the <tt class="docutils literal"><span class="pre">object-tools</span></tt> block. Therefore here is our
new <tt class="docutils literal"><span class="pre">change_form.html</span></tt> :</p>
<div class="highlight-html+django"><div class="highlight"><pre><span class="cp">{%</span> <span class="k">extends</span> <span class="s2">"admin/change_form.html"</span> <span class="cp">%}</span>
<span class="cp">{%</span> <span class="k">load</span> <span class="nv">i18n</span> <span class="cp">%}</span>
<span class="cp">{%</span> <span class="k">block</span> <span class="nv">object</span><span class="o">-</span><span class="nv">tools</span> <span class="cp">%}</span>
<span class="cp">{%</span> <span class="k">if</span> <span class="nv">change</span> <span class="cp">%}{%</span> <span class="k">if</span> <span class="k">not</span> <span class="nv">is_popup</span> <span class="cp">%}</span>
<span class="nt"><ul</span> <span class="na">class=</span><span class="s">"object-tools"</span><span class="nt">></span>
<span class="nt"><li><a</span> <span class="na">href=</span><span class="s">"history/"</span> <span class="na">class=</span><span class="s">"historylink"</span><span class="nt">></span><span class="cp">{%</span> <span class="k">trans</span> <span class="s2">"History"</span> <span class="cp">%}</span><span class="nt"></a></li></span>
<span class="nt"><li><a</span> <span class="na">href=</span><span class="s">"mylink/"</span> <span class="na">class=</span><span class="s">"historylink"</span><span class="nt">></span>My Link<span class="nt"></a></li></span>
<span class="cp">{%</span> <span class="k">if</span> <span class="nv">has_absolute_url</span> <span class="cp">%}</span>
<span class="nt"><li><a</span> <span class="na">href=</span><span class="s">"../../../r/</span><span class="cp">{{</span> <span class="nv">content_type_id</span> <span class="cp">}}</span><span class="s">/</span><span class="cp">{{</span> <span class="nv">object_id</span> <span class="cp">}}</span><span class="s">/"</span> <span class="na">class=</span><span class="s">"viewsitelink"</span><span class="nt">></span>
<span class="cp">{%</span> <span class="k">trans</span> <span class="s2">"View on site"</span> <span class="cp">%}</span><span class="nt"></a></span>
<span class="nt"></li></span>
<span class="cp">{%</span> <span class="k">endif</span><span class="cp">%}</span>
<span class="nt"></ul></span>
<span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}{%</span> <span class="k">endif</span> <span class="cp">%}</span>
<span class="cp">{%</span> <span class="k">endblock</span> <span class="cp">%}</span>
</pre></div>
</div>
<p>And that's it! If we placed this file in the <tt class="docutils literal"><span class="pre">templates/admin/my_app</span></tt>
directory, our link would appear on every model's change form.</p>
</div>
<div class="section" id="s-templates-which-may-be-overridden-per-app-or-model">
<span id="templates-which-may-be-overridden-per-app-or-model"></span><h3>Templates which may be overridden per app or model<a class="headerlink" href="#templates-which-may-be-overridden-per-app-or-model" title="Permalink to this headline">¶</a></h3>
<p>Not every template in <tt class="docutils literal"><span class="pre">contrib/admin/templates/admin</span></tt> may be overridden per
app or per model. The following can:</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">app_index.html</span></tt></li>
<li><tt class="docutils literal"><span class="pre">change_form.html</span></tt></li>
<li><tt class="docutils literal"><span class="pre">change_list.html</span></tt></li>
<li><tt class="docutils literal"><span class="pre">delete_confirmation.html</span></tt></li>
<li><tt class="docutils literal"><span class="pre">object_history.html</span></tt></li>
</ul>
<p>For those templates that cannot be overridden in this way, you may still
override them for your entire project. Just place the new version in your
<tt class="docutils literal"><span class="pre">templates/admin</span></tt> directory. This is particularly useful to create custom 404
and 500 pages.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Some of the admin templates, such as <tt class="docutils literal"><span class="pre">change_list_request.html</span></tt> are used
to render custom inclusion tags. These may be overridden, but in such cases
you are probably better off creating your own version of the tag in question
and giving it a different name. That way you can use it selectively.</p>
</div>
</div>
<div class="section" id="s-root-and-login-templates">
<span id="root-and-login-templates"></span><h3>Root and login templates<a class="headerlink" href="#root-and-login-templates" title="Permalink to this headline">¶</a></h3>
<p>If you wish to change the index or login templates, you are better off creating
your own <tt class="docutils literal"><span class="pre">AdminSite</span></tt> instance (see below), and changing the <a title="django.contrib.admin.AdminSite.index_template" class="reference internal" href="#django.contrib.admin.AdminSite.index_template"><tt class="xref docutils literal"><span class="pre">AdminSite.index_template</span></tt></a>
or <a title="django.contrib.admin.AdminSite.login_template" class="reference internal" href="#django.contrib.admin.AdminSite.login_template"><tt class="xref docutils literal"><span class="pre">AdminSite.login_template</span></tt></a> properties.</p>
</div>
</div>
<div class="section" id="s-adminsite-objects">
<span id="adminsite-objects"></span><h2><tt class="docutils literal"><span class="pre">AdminSite</span></tt> objects<a class="headerlink" href="#adminsite-objects" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="django.contrib.admin.AdminSite">
<em class="property">class </em><tt class="descname">AdminSite</tt>(<em>name=None</em>)<a class="headerlink" href="#django.contrib.admin.AdminSite" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>A Django administrative site is represented by an instance of
<tt class="docutils literal"><span class="pre">django.contrib.admin.sites.AdminSite</span></tt>; by default, an instance of
this class is created as <tt class="docutils literal"><span class="pre">django.contrib.admin.site</span></tt> and you can
register your models and <tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> instances with it.</p>
<p>If you'd like to set up your own administrative site with custom
behavior, however, you're free to subclass <tt class="docutils literal"><span class="pre">AdminSite</span></tt> and override
or add anything you like. Then, simply create an instance of your
<tt class="docutils literal"><span class="pre">AdminSite</span></tt> subclass (the same way you'd instantiate any other
Python class), and register your models and <tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> subclasses
with it instead of using the default.</p>
<div class="versionadded">
<span class="title">New in Django 1.1:</span> <a class="reference external" href="../../../releases/1.1.html#releases-1-1"><em>Please, see the release notes</em></a></div>
<p>When constructing an instance of an <tt class="docutils literal"><span class="pre">AdminSite</span></tt>, you are able to provide
a unique instance name using the <tt class="docutils literal"><span class="pre">name</span></tt> argument to the constructor. This
instance name is used to identify the instance, especially when
<a class="reference internal" href="#admin-reverse-urls"><em>reversing admin URLs</em></a>. If no instance name is
provided, a default instance name of <tt class="docutils literal"><span class="pre">admin</span></tt> will be used.</p>
<div class="section" id="s-adminsite-attributes">
<span id="adminsite-attributes"></span><h3><tt class="docutils literal"><span class="pre">AdminSite</span></tt> attributes<a class="headerlink" href="#adminsite-attributes" title="Permalink to this headline">¶</a></h3>
<dl class="attribute">
<dt id="django.contrib.admin.AdminSite.index_template">
<tt class="descclassname">AdminSite.</tt><tt class="descname">index_template</tt><a class="headerlink" href="#django.contrib.admin.AdminSite.index_template" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Path to a custom template that will be used by the admin site main index view.
Templates can override or extend base admin templates as described in
<a class="reference internal" href="#overriding-admin-templates">Overriding Admin Templates</a>.</p>
<dl class="attribute">
<dt id="django.contrib.admin.AdminSite.login_template">
<tt class="descclassname">AdminSite.</tt><tt class="descname">login_template</tt><a class="headerlink" href="#django.contrib.admin.AdminSite.login_template" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Path to a custom template that will be used by the admin site login view.
Templates can override or extend base admin templates as described in
<a class="reference internal" href="#overriding-admin-templates">Overriding Admin Templates</a>.</p>
</div>
<div class="section" id="s-hooking-adminsite-instances-into-your-urlconf">
<span id="hooking-adminsite-instances-into-your-urlconf"></span><h3>Hooking <tt class="docutils literal"><span class="pre">AdminSite</span></tt> instances into your URLconf<a class="headerlink" href="#hooking-adminsite-instances-into-your-urlconf" title="Permalink to this headline">¶</a></h3>
<p>The last step in setting up the Django admin is to hook your <tt class="docutils literal"><span class="pre">AdminSite</span></tt>
instance into your URLconf. Do this by pointing a given URL at the
<tt class="docutils literal"><span class="pre">AdminSite.urls</span></tt> method.</p>
<p>In this example, we register the default <tt class="docutils literal"><span class="pre">AdminSite</span></tt> instance
<tt class="docutils literal"><span class="pre">django.contrib.admin.site</span></tt> at the URL <tt class="docutils literal"><span class="pre">/admin/</span></tt></p>
<div class="highlight-python"><div class="highlight"><pre><span class="c"># urls.py</span>
<span class="kn">from</span> <span class="nn">django.conf.urls.defaults</span> <span class="kn">import</span> <span class="o">*</span>
<span class="kn">from</span> <span class="nn">django.contrib</span> <span class="kn">import</span> <span class="n">admin</span>
<span class="n">admin</span><span class="o">.</span><span class="n">autodiscover</span><span class="p">()</span>
<span class="n">urlpatterns</span> <span class="o">=</span> <span class="n">patterns</span><span class="p">(</span><span class="s">''</span><span class="p">,</span>
<span class="p">(</span><span class="s">'^admin/'</span><span class="p">,</span> <span class="n">include</span><span class="p">(</span><span class="n">admin</span><span class="o">.</span><span class="n">site</span><span class="o">.</span><span class="n">urls</span><span class="p">)),</span>
<span class="p">)</span>
</pre></div>
</div>
<p>Above we used <tt class="docutils literal"><span class="pre">admin.autodiscover()</span></tt> to automatically load the
<tt class="docutils literal"><span class="pre">INSTALLED_APPS</span></tt> admin.py modules.</p>
<p>In this example, we register the <tt class="docutils literal"><span class="pre">AdminSite</span></tt> instance
<tt class="docutils literal"><span class="pre">myproject.admin.admin_site</span></tt> at the URL <tt class="docutils literal"><span class="pre">/myadmin/</span></tt></p>
<div class="highlight-python"><div class="highlight"><pre><span class="c"># urls.py</span>
<span class="kn">from</span> <span class="nn">django.conf.urls.defaults</span> <span class="kn">import</span> <span class="o">*</span>
<span class="kn">from</span> <span class="nn">myproject.admin</span> <span class="kn">import</span> <span class="n">admin_site</span>
<span class="n">urlpatterns</span> <span class="o">=</span> <span class="n">patterns</span><span class="p">(</span><span class="s">''</span><span class="p">,</span>
<span class="p">(</span><span class="s">'^myadmin/'</span><span class="p">,</span> <span class="n">include</span><span class="p">(</span><span class="n">admin_site</span><span class="o">.</span><span class="n">urls</span><span class="p">)),</span>
<span class="p">)</span>
</pre></div>
</div>
<p>There is really no need to use autodiscover when using your own <tt class="docutils literal"><span class="pre">AdminSite</span></tt>
instance since you will likely be importing all the per-app admin.py modules
in your <tt class="docutils literal"><span class="pre">myproject.admin</span></tt> module.</p>
</div>
<div class="section" id="s-multiple-admin-sites-in-the-same-urlconf">
<span id="multiple-admin-sites-in-the-same-urlconf"></span><h3>Multiple admin sites in the same URLconf<a class="headerlink" href="#multiple-admin-sites-in-the-same-urlconf" title="Permalink to this headline">¶</a></h3>
<p>It's easy to create multiple instances of the admin site on the same
Django-powered Web site. Just create multiple instances of <tt class="docutils literal"><span class="pre">AdminSite</span></tt> and
root each one at a different URL.</p>
<div class="versionchanged">
<span class="title">Changed in Django 1.1:</span> The method for hooking <tt class="docutils literal"><span class="pre">AdminSite</span></tt> instances into urls has changed in
Django 1.1.</div>
<p>In this example, the URLs <tt class="docutils literal"><span class="pre">/basic-admin/</span></tt> and <tt class="docutils literal"><span class="pre">/advanced-admin/</span></tt> feature
separate versions of the admin site -- using the <tt class="docutils literal"><span class="pre">AdminSite</span></tt> instances
<tt class="docutils literal"><span class="pre">myproject.admin.basic_site</span></tt> and <tt class="docutils literal"><span class="pre">myproject.admin.advanced_site</span></tt>,
respectively:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c"># urls.py</span>
<span class="kn">from</span> <span class="nn">django.conf.urls.defaults</span> <span class="kn">import</span> <span class="o">*</span>
<span class="kn">from</span> <span class="nn">myproject.admin</span> <span class="kn">import</span> <span class="n">basic_site</span><span class="p">,</span> <span class="n">advanced_site</span>
<span class="n">urlpatterns</span> <span class="o">=</span> <span class="n">patterns</span><span class="p">(</span><span class="s">''</span><span class="p">,</span>
<span class="p">(</span><span class="s">'^basic-admin/'</span><span class="p">,</span> <span class="n">include</span><span class="p">(</span><span class="n">basic_site</span><span class="o">.</span><span class="n">urls</span><span class="p">)),</span>
<span class="p">(</span><span class="s">'^advanced-admin/'</span><span class="p">,</span> <span class="n">include</span><span class="p">(</span><span class="n">advanced_site</span><span class="o">.</span><span class="n">urls</span><span class="p">)),</span>
<span class="p">)</span>
</pre></div>
</div>
<p><tt class="docutils literal"><span class="pre">AdminSite</span></tt> instances take a single argument to their constructor, their
name, which can be anything you like. This argument becomes the prefix to the
URL names for the purposes of <a class="reference internal" href="#admin-reverse-urls"><em>reversing them</em></a>. This
is only necessary if you are using more than one <tt class="docutils literal"><span class="pre">AdminSite</span></tt>.</p>
</div>
<div class="section" id="s-adding-views-to-admin-sites">
<span id="adding-views-to-admin-sites"></span><h3>Adding views to admin sites<a class="headerlink" href="#adding-views-to-admin-sites" title="Permalink to this headline">¶</a></h3>
<div class="versionadded">
<span class="title">New in Django 1.1:</span> <a class="reference external" href="../../../releases/1.1.html#releases-1-1"><em>Please, see the release notes</em></a></div>
<p>Just like <a title="django.contrib.admin.ModelAdmin" class="reference internal" href="#django.contrib.admin.ModelAdmin"><tt class="xref docutils literal"><span class="pre">ModelAdmin</span></tt></a>, <a title="django.contrib.admin.AdminSite" class="reference internal" href="#django.contrib.admin.AdminSite"><tt class="xref docutils literal"><span class="pre">AdminSite</span></tt></a> provides a
<a title="django.contrib.admin.ModelAdmin.get_urls" class="reference internal" href="#django.contrib.admin.ModelAdmin.get_urls"><tt class="xref docutils literal"><span class="pre">get_urls()</span></tt></a> method
that can be overridden to define additional views for the site. To add
a new view to your admin site, extend the base
<a title="django.contrib.admin.ModelAdmin.get_urls" class="reference internal" href="#django.contrib.admin.ModelAdmin.get_urls"><tt class="xref docutils literal"><span class="pre">get_urls()</span></tt></a> method to include
a pattern for your new view.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Any view you render that uses the admin templates, or extends the base
admin template, should provide the <tt class="docutils literal"><span class="pre">current_app</span></tt> argument to
<tt class="docutils literal"><span class="pre">RequestContext</span></tt> or <tt class="docutils literal"><span class="pre">Context</span></tt> when rendering the template. It should
be set to either <tt class="docutils literal"><span class="pre">self.name</span></tt> if your view is on an <tt class="docutils literal"><span class="pre">AdminSite</span></tt> or
<tt class="docutils literal"><span class="pre">self.admin_site.name</span></tt> if your view is on a <tt class="docutils literal"><span class="pre">ModelAdmin</span></tt>.</p>
</div>
</div>
</div>
<div class="section" id="s-reversing-admin-urls">
<span id="s-admin-reverse-urls"></span><span id="reversing-admin-urls"></span><span id="admin-reverse-urls"></span><h2>Reversing Admin URLs<a class="headerlink" href="#reversing-admin-urls" title="Permalink to this headline">¶</a></h2>
<div class="versionadded">
<span class="title">New in Django 1.1:</span> <a class="reference external" href="../../../releases/1.1.html#releases-1-1"><em>Please, see the release notes</em></a></div>
<p>When an <a title="django.contrib.admin.AdminSite" class="reference internal" href="#django.contrib.admin.AdminSite"><tt class="xref docutils literal"><span class="pre">AdminSite</span></tt></a> is deployed, the views provided by that site are
accessible using Django's <a class="reference external" href="../../../topics/http/urls.html#naming-url-patterns"><em>URL reversing system</em></a>.</p>
<p>The <a title="django.contrib.admin.AdminSite" class="reference internal" href="#django.contrib.admin.AdminSite"><tt class="xref docutils literal"><span class="pre">AdminSite</span></tt></a> provides the following named URL patterns:</p>
<table class="docutils">
<colgroup>
<col width="37%" />
<col width="41%" />
<col width="22%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Page</th>
<th class="head">URL name</th>
<th class="head">Parameters</th>
</tr>
</thead>
<tbody valign="top">
<tr><td>Index</td>
<td><tt class="docutils literal"><span class="pre">index</span></tt></td>
<td> </td>
</tr>
<tr><td>Logout</td>
<td><tt class="docutils literal"><span class="pre">logout</span></tt></td>
<td> </td>
</tr>
<tr><td>Password change</td>
<td><tt class="docutils literal"><span class="pre">password_change</span></tt></td>
<td> </td>
</tr>
<tr><td>Password change done</td>
<td><tt class="docutils literal"><span class="pre">password_change_done</span></tt></td>
<td> </td>
</tr>
<tr><td>i18n javascript</td>
<td><tt class="docutils literal"><span class="pre">jsi18n</span></tt></td>
<td> </td>
</tr>
<tr><td>Application index page</td>
<td><tt class="docutils literal"><span class="pre">app_list</span></tt></td>
<td><tt class="docutils literal"><span class="pre">app_label</span></tt></td>
</tr>
</tbody>
</table>
<p>Each <a title="django.contrib.admin.ModelAdmin" class="reference internal" href="#django.contrib.admin.ModelAdmin"><tt class="xref docutils literal"><span class="pre">ModelAdmin</span></tt></a> instance provides an additional set of named URLs:</p>
<table class="docutils">
<colgroup>
<col width="27%" />
<col width="57%" />
<col width="16%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Page</th>
<th class="head">URL name</th>
<th class="head">Parameters</th>
</tr>
</thead>
<tbody valign="top">
<tr><td>Changelist</td>
<td><tt class="docutils literal"><span class="pre">{{</span> <span class="pre">app_label</span> <span class="pre">}}_{{</span> <span class="pre">model_name</span> <span class="pre">}}_changelist</span></tt></td>
<td> </td>
</tr>
<tr><td>Add</td>
<td><tt class="docutils literal"><span class="pre">{{</span> <span class="pre">app_label</span> <span class="pre">}}_{{</span> <span class="pre">model_name</span> <span class="pre">}}_add</span></tt></td>
<td> </td>
</tr>
<tr><td>History</td>
<td><tt class="docutils literal"><span class="pre">{{</span> <span class="pre">app_label</span> <span class="pre">}}_{{</span> <span class="pre">model_name</span> <span class="pre">}}_history</span></tt></td>
<td><tt class="docutils literal"><span class="pre">object_id</span></tt></td>
</tr>
<tr><td>Delete</td>
<td><tt class="docutils literal"><span class="pre">{{</span> <span class="pre">app_label</span> <span class="pre">}}_{{</span> <span class="pre">model_name</span> <span class="pre">}}_delete</span></tt></td>
<td><tt class="docutils literal"><span class="pre">object_id</span></tt></td>
</tr>
<tr><td>Change</td>
<td><tt class="docutils literal"><span class="pre">{{</span> <span class="pre">app_label</span> <span class="pre">}}_{{</span> <span class="pre">model_name</span> <span class="pre">}}_change</span></tt></td>
<td><tt class="docutils literal"><span class="pre">object_id</span></tt></td>
</tr>
</tbody>
</table>
<p>These named URLs are registered with the application namespace <tt class="docutils literal"><span class="pre">admin</span></tt>, and
with an instance namespace corresponding to the name of the Site instance.</p>
<p>So - if you wanted to get a reference to the Change view for a particular
<tt class="docutils literal"><span class="pre">Choice</span></tt> object (from the polls application) in the default admin, you would
call:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">django.core</span> <span class="kn">import</span> <span class="n">urlresolvers</span>
<span class="gp">>>> </span><span class="n">c</span> <span class="o">=</span> <span class="n">Choice</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="o">...</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">change_url</span> <span class="o">=</span> <span class="n">urlresolvers</span><span class="o">.</span><span class="n">reverse</span><span class="p">(</span><span class="s">'admin:polls_choice_change'</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">id</span><span class="p">,))</span>
</pre></div>
</div>
<p>This will find the first registered instance of the admin application (whatever the instance
name), and resolve to the view for changing <tt class="docutils literal"><span class="pre">poll.Choice</span></tt> instances in that instance.</p>
<p>If you want to find a URL in a specific admin instance, provide the name of that instance
as a <tt class="docutils literal"><span class="pre">current_app</span></tt> hint to the reverse call. For example, if you specifically wanted
the admin view from the admin instance named <tt class="docutils literal"><span class="pre">custom</span></tt>, you would need to call:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">change_url</span> <span class="o">=</span> <span class="n">urlresolvers</span><span class="o">.</span><span class="n">reverse</span><span class="p">(</span><span class="s">'custom:polls_choice_change'</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">id</span><span class="p">,))</span>
</pre></div>
</div>
<p>For more details, see the documentation on <a class="reference external" href="../../../topics/http/urls.html#topics-http-reversing-url-namespaces"><em>reversing namespaced URLs</em></a>.</p>
</div>
</div>
</div>
</div>
</div>
<div class="yui-b" id="sidebar">
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../../../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference external" href="#">The Django admin site</a><ul>
<li><a class="reference external" href="#overview">Overview</a><ul>
<li><a class="reference external" href="#other-topics">Other topics</a><ul>
</ul>
</li>
</ul>
</li>
<li><a class="reference external" href="#modeladmin-objects"><tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> objects</a><ul>
<li><a class="reference external" href="#modeladmin-options"><tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> Options</a><ul>
<li><a class="reference external" href="#custom-template-options">Custom template options</a></li>
</ul>
</li>
<li><a class="reference external" href="#modeladmin-methods"><tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> methods</a><ul>
<li><a class="reference external" href="#other-methods">Other methods</a></li>
</ul>
</li>
<li><a class="reference external" href="#modeladmin-media-definitions"><tt class="docutils literal"><span class="pre">ModelAdmin</span></tt> media definitions</a></li>
<li><a class="reference external" href="#adding-custom-validation-to-the-admin">Adding custom validation to the admin</a></li>
</ul>
</li>
<li><a class="reference external" href="#inlinemodeladmin-objects"><tt class="docutils literal"><span class="pre">InlineModelAdmin</span></tt> objects</a><ul>
<li><a class="reference external" href="#inlinemodeladmin-options"><tt class="docutils literal"><span class="pre">InlineModelAdmin</span></tt> options</a><ul>
<li><a class="reference external" href="#model"><tt class="docutils literal"><span class="pre">model</span></tt></a></li>
<li><a class="reference external" href="#fk-name"><tt class="docutils literal"><span class="pre">fk_name</span></tt></a></li>
<li><a class="reference external" href="#formset"><tt class="docutils literal"><span class="pre">formset</span></tt></a></li>
<li><a class="reference external" href="#form"><tt class="docutils literal"><span class="pre">form</span></tt></a></li>
<li><a class="reference external" href="#extra"><tt class="docutils literal"><span class="pre">extra</span></tt></a></li>
<li><a class="reference external" href="#max-num"><tt class="docutils literal"><span class="pre">max_num</span></tt></a></li>
<li><a class="reference external" href="#raw-id-fields"><tt class="docutils literal"><span class="pre">raw_id_fields</span></tt></a></li>
<li><a class="reference external" href="#template"><tt class="docutils literal"><span class="pre">template</span></tt></a></li>
<li><a class="reference external" href="#verbose-name"><tt class="docutils literal"><span class="pre">verbose_name</span></tt></a></li>
<li><a class="reference external" href="#verbose-name-plural"><tt class="docutils literal"><span class="pre">verbose_name_plural</span></tt></a></li>
</ul>
</li>
<li><a class="reference external" href="#working-with-a-model-with-two-or-more-foreign-keys-to-the-same-parent-model">Working with a model with two or more foreign keys to the same parent model</a></li>
<li><a class="reference external" href="#working-with-many-to-many-intermediary-models">Working with Many-to-Many Intermediary Models</a></li>
<li><a class="reference external" href="#using-generic-relations-as-an-inline">Using generic relations as an inline</a></li>
</ul>
</li>
<li><a class="reference external" href="#overriding-admin-templates">Overriding Admin Templates</a><ul>
<li><a class="reference external" href="#set-up-your-projects-admin-template-directories">Set up your projects admin template directories</a></li>
<li><a class="reference external" href="#overriding-vs-replacing-an-admin-template">Overriding vs. replacing an admin template</a></li>
<li><a class="reference external" href="#templates-which-may-be-overridden-per-app-or-model">Templates which may be overridden per app or model</a></li>
<li><a class="reference external" href="#root-and-login-templates">Root and login templates</a></li>
</ul>
</li>
<li><a class="reference external" href="#adminsite-objects"><tt class="docutils literal"><span class="pre">AdminSite</span></tt> objects</a><ul>
<li><a class="reference external" href="#adminsite-attributes"><tt class="docutils literal"><span class="pre">AdminSite</span></tt> attributes</a></li>
<li><a class="reference external" href="#hooking-adminsite-instances-into-your-urlconf">Hooking <tt class="docutils literal"><span class="pre">AdminSite</span></tt> instances into your URLconf</a></li>
<li><a class="reference external" href="#multiple-admin-sites-in-the-same-urlconf">Multiple admin sites in the same URLconf</a></li>
<li><a class="reference external" href="#adding-views-to-admin-sites">Adding views to admin sites</a></li>
</ul>
</li>
<li><a class="reference external" href="#reversing-admin-urls">Reversing Admin URLs</a></li>
</ul>
</li>
</ul>
<h3>Browse</h3>
<ul>
<li>Prev: <a href="../index.html"><tt class="docutils literal docutils literal docutils literal"><span class="pre">contrib</span></tt> packages</a></li>
<li>Next: <a href="actions.html">Admin actions</a></li>
</ul>
<h3>You are here:</h3>
<ul>
<li>
<a href="../../../index.html">Django v1.1 documentation</a>
<ul><li><a href="../../index.html">API Reference</a>
<ul><li><a href="../index.html"><tt class="docutils literal docutils literal docutils literal docutils literal"><span class="pre">contrib</span></tt> packages</a>
<ul><li>The Django admin site</li></ul>
</li></ul></li></ul>
</li>
</ul>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/ref/contrib/admin/index.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<h3>Last update:</h3>
<p class="topless">Feb 18, 2011</p>
</div>
</div>
<div id="ft">
<div class="nav">
« <a href="../index.html" title="<tt class="docutils literal docutils literal docutils literal"><span class="pre">contrib</span></tt> packages">previous</a>
|
<a href="../../index.html" title="API Reference" accesskey="U">up</a>
|
<a href="actions.html" title="Admin actions">next</a> »</div>
</div>
</div>
<div class="clearer"></div>
</div>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
57efe471f3561e70a829edf1b0e9f507
>
files
>
2283
