このドキュメントでは、 Django の組み込みテンプレートタグとフィルタについて述べます。 また automatic documentation を使えばインストールされている組み込みタグとカスタムタグのドキュメントを読めるのでお勧めです。
\nautoescapeLink to this heading#自動エスケープ機能を制御します。このタグは引数に on または off を取り、ブロック内の自動エスケープの有効・無効を決定します。ブロックの最後は endautoescape タグで閉じるようにします。
Sample usage:
\n{% autoescape on %}\n {{ body }}\n{% endautoescape %}\nWhen auto-escaping is in effect, all content derived from variables has HTML\nescaping applied before placing the result into the output (but after any\nfilters are applied). This is equivalent to manually applying the\nescape filter to each variable.
The only exceptions are variables already marked as "safe" from escaping.\nVariables could be marked as "safe" by the code which populated the variable,\nby applying the safe or escape filters, or because it's\nthe result of a previous filter that marked the string as "safe".
Within the scope of disabled auto-escaping, chaining filters, including\nescape, may cause unexpected (but documented) results such as the\nfollowing:
{% autoescape off %}\n {{ my_list|join:", "|escape }}\n{% endautoescape %}\nThe above code will output the joined elements of my_list unescaped. This\nis because the filter chaining sequence executes first join on\nmy_list (without applying escaping to each item since autoescape is\noff), marking the result as safe. Subsequently, this safe result will be\nfed to escape filter, which does not apply a second round of\nescaping.
blockLink to this heading#子テンプレートによってオーバーライドされる部分を定義します。詳しくは Template inheritance を参照してください。
\ncommentLink to this heading#{% comment %} ～ {% endcomment %} で囲まれた部分はすべて無視されます。最初のタグには追加の説明文を含めるすることができます。例えばコードの一部をコメント化した際、その部分を無効にした理由を記述したいときなどに便利です。
Sample usage:
\n<p>Rendered text with {{ pub_date|date:"c" }}</p>\n{% comment "Optional note" %}\n <p>Commented out text with {{ create_date|date:"c" }}</p>\n{% endcomment %}\ncomment タグを入れ子にすることはできません。
csrf_tokenLink to this heading#このタグは CSRF の防止のために使用します。詳細は Cross Site Request Forgeries を参照してください。.
\ncycleLink to this heading#タグを実行するごとに、引数の文字列や変数から、順に一つずつ値を出力します。最初の処理では 1 番目の値が、その次に 2 番目の値、以下、4 個まで同様に処理されます。サイクルのすべての値を出力すると、再び 1 番目に戻って出力します。
\nThis tag is particularly useful in a loop:
\n{% for o in some_list %}\n <tr class="{% cycle 'row1' 'row2' %}">\n ...\n </tr>\n{% endfor %}\nこの例では、繰り返しの最初の実行では row1 クラスを参照する HTML が生成されます。 2 回目には row2、 3 回目は再び row1 というように、ループを繰り返すたびに交互に処理されます。
You can use variables, too. For example, if you have two template variables,\nrowvalue1 and rowvalue2, you can alternate between their values like\nthis:
{% for o in some_list %}\n <tr class="{% cycle rowvalue1 rowvalue2 %}">\n ...\n </tr>\n{% endfor %}\nVariables included in the cycle will be escaped. You can disable auto-escaping\nwith:
\n{% for o in some_list %}\n <tr class="{% autoescape off %}{% cycle rowvalue1 rowvalue2 %}{% endautoescape %}">\n ...\n </tr>\n{% endfor %}\nYou can mix variables and strings:
\n{% for o in some_list %}\n <tr class="{% cycle 'row1' rowvalue2 'row3' %}">\n ...\n </tr>\n{% endfor %}\nIn some cases you might want to refer to the current value of a cycle\nwithout advancing to the next value. To do this,\ngive the {% cycle %} tag a name, using "as", like this:
{% cycle 'row1' 'row2' as rowcolors %}\nFrom then on, you can insert the current value of the cycle wherever you'd like\nin your template by referencing the cycle name as a context variable. If you\nwant to move the cycle to the next value independently of the original\ncycle tag, you can use another cycle tag and specify the name of the\nvariable. So, the following template:
<tr>\n <td class="{% cycle 'row1' 'row2' as rowcolors %}">...</td>\n <td class="{{ rowcolors }}">...</td>\n</tr>\n<tr>\n <td class="{% cycle rowcolors %}">...</td>\n <td class="{{ rowcolors }}">...</td>\n</tr>\nwould output:
\n<tr>\n <td class="row1">...</td>\n <td class="row1">...</td>\n</tr>\n<tr>\n <td class="row2">...</td>\n <td class="row2">...</td>\n</tr>\ncycle タグ内では、空白で区切ることでいくつでも値を使うことができます。一重引用符 ( ' ) または二重引用符 ( " ) で囲まれた値は文字列リテラルとして扱われ、引用符のない値はテンプレート変数として扱われます。
By default, when you use the as keyword with the cycle tag, the\nusage of {% cycle %} that initiates the cycle will itself produce\nthe first value in the cycle. This could be a problem if you want to\nuse the value in a nested loop or an included template. If you only want\nto declare the cycle but not produce the first value, you can add a\nsilent keyword as the last keyword in the tag. For example:
{% for obj in some_list %}\n {% cycle 'row1' 'row2' as rowcolors silent %}\n <tr class="{{ rowcolors }}">{% include "subtemplate.html" %}</tr>\n{% endfor %}\nこれは <tr> エレメントのリストを出力し、 class には row1 と row2 が交互に設定されます。サブテンプレートではそのコンテキスト内で rowcolors にアクセスし、値はそれを取り囲む <tr> のクラスに一致します。ここでもし silent キーワードが無かったら、 row1 と row2 は <tr> エレメントの外側で通常のテキストとして発行されます。
When the silent keyword is used on a cycle definition, the silence\nautomatically applies to all subsequent uses of that specific cycle tag.\nThe following template would output nothing, even though the second\ncall to {% cycle %} doesn't specify silent:
{% cycle 'row1' 'row2' as rowcolors silent %}\n{% cycle rowcolors %}\nYou can use the resetcycle tag to make a {% cycle %} tag restart\nfrom its first value when it's next encountered.
debugLink to this heading#Outputs a whole load of debugging information, including the current context\nand imported modules. {% debug %} outputs nothing when the DEBUG\nsetting is False.
extendsLink to this heading#このテンプレートが親テンプレートからの拡張であることを指示します。
\nこのタグには 2 種類の使い方があります:
\n{% extends "base.html" %} (引用符つき) の場合、リテラル値 "base.html" を親テンプレートの名前として使います。
{% extends variable %} とした場合、変数 variable の値を親テンプレートの名前として使います。変数の値が文字列の場合、 Django はその文字列を親テンプレートの名前として使います。値が Template オブジェクトの場合、Django はそのオブジェクトを親テンプレートにします。
詳しくは テンプレートの継承 を参照してください。
\nNormally the template name is relative to the template loader's root directory.\nA string argument may also be a relative path starting with ./ or ../.\nFor example, assume the following directory structure:
dir1/\n template.html\n base2.html\n my/\n base3.html\nbase1.html\nIn template.html, the following paths would be valid:
{% extends "./base2.html" %}\n{% extends "../base1.html" %}\n{% extends "./my/base3.html" %}\nfilterLink to this heading#タグブロック内のコンテンツを、1 つまたは複数のフィルタに通します。複数のフィルタを使うときはパイプ（ " | " ）を使って連結します。フィルタには変数のように引数を与えることができます。
\nfilter タグと endfilter タグに囲まれたテキストは、すべて ブロックに含まれることに注意しましょう。
Sample usage:
\n{% filter force_escape|lower %}\n This text will be HTML-escaped, and will appear in all lowercase.\n{% endfilter %}\nfirstofLink to this heading#Outputs the first argument variable that is not "false" (i.e. exists, is not\nempty, is not a false boolean value, and is not a zero numeric value). Outputs\nnothing if all the passed variables are "false".
\nSample usage:
\n{% firstof var1 var2 var3 %}\nThis is equivalent to:
\n{% if var1 %}\n {{ var1 }}\n{% elif var2 %}\n {{ var2 }}\n{% elif var3 %}\n {{ var3 }}\n{% endif %}\nYou can also use a literal string as a fallback value in case all\npassed variables are False:
\n{% firstof var1 var2 var3 "fallback value" %}\nThis tag auto-escapes variable values. You can disable auto-escaping with:
\n{% autoescape off %}\n {% firstof var1 var2 var3 "<strong>fallback value</strong>" %}\n{% endautoescape %}\nOr if only some variables should be escaped, you can use:
\n{% firstof var1 var2|safe var3 "<strong>fallback value</strong>"|safe %}\n{% firstof var1 var2 var3 as value %} と記述することで、出力を 1 つの変数内に格納することができます。
forLink to this heading#Loops over each item in an array, making the item available in a context\nvariable. For example, to display a list of athletes provided in\nathlete_list:
<ul>\n{% for athlete in athlete_list %}\n <li>{{ athlete.name }}</li>\n{% endfor %}\n</ul>\n{% for obj in list reversed %} で、リストに対して逆順のループを実行できます。
If you need to loop over a list of lists, you can unpack the values\nin each sublist into individual variables. For example, if your context\ncontains a list of (x,y) coordinates called points, you could use the\nfollowing to output the list of points:
{% for x, y in points %}\n There is a point at {{ x }},{{ y }}\n{% endfor %}\nThis can also be useful if you need to access the items in a dictionary.\nFor example, if your context contained a dictionary data, the following\nwould display the keys and values of the dictionary:
{% for key, value in data.items %}\n {{ key }}: {{ value }}\n{% endfor %}\nドット演算子を使う場合、メソッドよりも辞書キーへの参照が優先することに注意してください。したがって、もしも data 辞書が 'items' という名前のキーを持っていたなら、 data.items は data.items() ではなく data['items'] の値を出力します。テンプレート内で辞書のメソッドを使いたい場合、そのような名前のキー (items、values、keys など) を辞書に追加しないでください。ドット演算子による参照の優先順位についての詳細は documentation of template variables を参照してください。
for ループには、ループ内で使える多くの変数が設定されています:
\n変数 | \n説明 | \n
|---|---|
| \n現在のループカウンタ番号 ( 1 から順にカウント ) | \n
| \n現在のループカウンタ番号 ( 0 から順にカウント ) | \n
| \n現在のループカウンタ値 ( 1 から順に、末尾からカウント) | \n
| \n現在のループカウンタ値 ( 0 から順に、末尾からカウント) | \n
| \n最初のループであれば True | \n
| \n最後のループであれば True | \n
| \n入れ子のループであるとき、現在のループを囲んでいる 1 つ上のループを表します。 | \n
for ... emptyLink to this heading#The for tag can take an optional {% empty %} clause whose text is\ndisplayed if the given array is empty or could not be found:
<ul>\n{% for athlete in athlete_list %}\n <li>{{ athlete.name }}</li>\n{% empty %}\n <li>Sorry, no athletes in this list.</li>\n{% endfor %}\n</ul>\nThe above is equivalent to -- but shorter, cleaner, and possibly faster\nthan -- the following:
\n<ul>\n {% if athlete_list %}\n {% for athlete in athlete_list %}\n <li>{{ athlete.name }}</li>\n {% endfor %}\n {% else %}\n <li>Sorry, no athletes in this list.</li>\n {% endif %}\n</ul>\nifLink to this heading#The {% if %} tag evaluates a variable, and if that variable is "true" (i.e.\nexists, is not empty, and is not a false boolean value) the contents of the\nblock are output:
{% if athlete_list %}\n Number of athletes: {{ athlete_list|length }}\n{% elif athlete_in_locker_room_list %}\n Athletes should be out of the locker room soon!\n{% else %}\n No athletes.\n{% endif %}\n上の例では、 athlete_list が空でなければ、アスリートの人数を {{ athlete_list|length }} 変数で表示します。
例にもあるように if タグはオプションで 1 個以上の {% elif %} 節、および 1 個の {% else %} 節をつけることができます。 {% else %} はそれまでの評価結果がすべて True でなかった場合に表示されるコンテンツを定義します。
if tags may use and, or or not to test a number of\nvariables or to negate a given variable:
{% if athlete_list and coach_list %}\n Both athletes and coaches are available.\n{% endif %}\n\n{% if not athlete_list %}\n There are no athletes.\n{% endif %}\n\n{% if athlete_list or coach_list %}\n There are some athletes or some coaches.\n{% endif %}\n\n{% if not athlete_list or coach_list %}\n There are no athletes or there are some coaches.\n{% endif %}\n\n{% if athlete_list and not coach_list %}\n There are some athletes and absolutely no coaches.\n{% endif %}\nUse of both and and or clauses within the same tag is allowed, with\nand having higher precedence than or e.g.:
{% if athlete_list and coach_list or cheerleader_list %}\nこれは以下のように解釈されます:
\nif (athlete_list and coach_list) or cheerleader_list\n実際には if タグの中で丸括弧を使うことはできません。優先順位を示す必要がある場合には、if タグを入れ子にして表してください。
if タグは演算子 ==, !=, <, >, <=, >=, in, not in, is, and is not が使え、以下のように機能します:
== 演算子Link to this heading#Equality. Example:
\n{% if somevar == "x" %}\n This appears if variable somevar equals the string "x"\n{% endif %}\n!= 演算子Link to this heading#Inequality. Example:
\n{% if somevar != "x" %}\n This appears if variable somevar does not equal the string "x",\n or if somevar is not found in the context\n{% endif %}\n< 演算子Link to this heading#Less than. Example:
\n{% if somevar < 100 %}\n This appears if variable somevar is less than 100.\n{% endif %}\n> 演算子Link to this heading#Greater than. Example:
\n{% if somevar > 0 %}\n This appears if variable somevar is greater than 0.\n{% endif %}\n<= 演算子Link to this heading#Less than or equal to. Example:
\n{% if somevar <= 100 %}\n This appears if variable somevar is less than 100 or equal to 100.\n{% endif %}\n>= 演算子Link to this heading#Greater than or equal to. Example:
\n{% if somevar >= 1 %}\n This appears if variable somevar is greater than 1 or equal to 1.\n{% endif %}\nin 演算子Link to this heading#Contained within. This operator is supported by many Python containers to test\nwhether the given value is in the container. The following are some examples\nof how x in y will be interpreted:
{% if "bc" in "abcdef" %}\n This appears since "bc" is a substring of "abcdef"\n{% endif %}\n\n{% if "hello" in greetings %}\n If greetings is a list or set, one element of which is the string\n "hello", this will appear.\n{% endif %}\n\n{% if user in users %}\n If users is a QuerySet, this will appear if user is an\n instance that belongs to the QuerySet.\n{% endif %}\nnot in 演算子Link to this heading#コンテナに含まれていない場合。これは in 演算子の逆です。
is 演算子Link to this heading#Object identity. Tests if two values are the same object. Example:
\n{% if somevar is True %}\n This appears if and only if somevar is True.\n{% endif %}\n\n{% if somevar is None %}\n This appears if somevar is None, or if somevar is not found in the context.\n{% endif %}\nis not operatorLink to this heading#Negated object identity. Tests if two values are not the same object. This is\nthe negation of the is operator. Example:
{% if somevar is not True %}\n This appears if somevar is not True, or if somevar is not found in the\n context.\n{% endif %}\n\n{% if somevar is not None %}\n This appears if and only if somevar is not None.\n{% endif %}\nYou can also use filters in the if expression. For example:
{% if messages|length >= 100 %}\n You have lots of messages today!\n{% endif %}\nここまでのすべてを組み合わせて複雑な式を作ることができます。このような式では、式を評価するときに演算子がどのようにグループ化されるか、すなわち優先順位の規則を理解することが重要です。演算子の優先順位は次のようになっています:
\nor
and
not
in
==, !=, <, >, <=, >=
(This follows Python exactly). So, for example, the following complex\nif tag:
{% if a == b or c == d and e %}\n...次のように解釈されます:
\n(a == b) or ((c == d) and e)\nもしこれと違った優先順位が必要ならば、if タグを入れ子にして使う必要があります。優先順位の規則がはっきりしない場合には、こうした方がより明確な表現になることもあるでしょう。
The comparison operators cannot be 'chained' like in Python or in mathematical\nnotation. For example, instead of using:
\n{% if a > b > c %} (WRONG)\nyou should use:
\n{% if a > b and b > c %}\nifchangedLink to this heading#値が前回のループ実行時から変わっているかどうかを調べます。
\n{% ifchanged %} ブロックタグはループの内部で使います。このタグには 2 通りの使い方があります。
Checks its own rendered contents against its previous state and only\ndisplays the content if it has changed. For example, this displays a list of\ndays, only displaying the month if it changes:
\n<h1>Archive for {{ year }}</h1>\n\n{% for date in days %}\n {% ifchanged %}<h3>{{ date|date:"F" }}</h3>{% endifchanged %}\n <a href="{{ date|date:"M/d"|lower }}/">{{ date|date:"j" }}</a>\n{% endfor %}\nIf given one or more variables, check whether any variable has changed.\nFor example, the following shows the date every time it changes, while\nshowing the hour if either the hour or the date has changed:
\n{% for date in days %}\n {% ifchanged date.date %} {{ date.date }} {% endifchanged %}\n {% ifchanged date.hour date.date %}\n {{ date.hour }}\n {% endifchanged %}\n{% endfor %}\nThe ifchanged tag can also take an optional {% else %} clause that\nwill be displayed if the value has not changed:
{% for match in matches %}\n <div style="background-color:\n {% ifchanged match.ballot_id %}\n {% cycle "red" "blue" %}\n {% else %}\n gray\n {% endifchanged %}\n ">{{ match }}</div>\n{% endfor %}\nincludeLink to this heading#テンプレートをロードし、現在のコンテキストを使って出力します。これはテンプレート内に他のテンプレートを取り込む（ “include” ）方法の一つです。
\nテンプレート名はハードコードされた (引用符で囲った) 文字列でもよく、引用符は一重引用符 （'...'）でも二重引用符（"..."）でもかまいません。
\nThis example includes the contents of the template "foo/bar.html":
{% include "foo/bar.html" %}\nNormally the template name is relative to the template loader's root directory.\nA string argument may also be a relative path starting with ./ or ../\nas described in the extends tag.
This example includes the contents of the template whose name is contained in\nthe variable template_name:
{% include template_name %}\n変数は、コンテキストを受け取る render() メソッドを持っていればオブジェクトでも構いません。これによって、コンテキスト内のコンパイル済みの Template を参照することができます。
Additionally, the variable may be an iterable of template names, in which case\nthe first that can be loaded will be used, as per\nselect_template().
include されたテンプレートは、include した側のコンテキストにおいて解釈されます。以下の例は "Hello, John!" を出力します:
コンテキスト: 変数 person に "John" を、変数 greeting に "Hello" をセット。
Template:
\n{% include "name_snippet.html" %}\nThe name_snippet.html template:
{{ greeting }}, {{ person|default:"friend" }}!\nYou can pass additional context to the template using keyword arguments:
\n{% include "name_snippet.html" with person="Jane" greeting="Hello" %}\nIf you want to render the context only with the variables provided (or even\nno variables at all), use the only option. No other variables are\navailable to the included template:
{% include "name_snippet.html" with greeting="Hi" only %}\nloadLink to this heading#カスタムのテンプレートタグセットを読み込みます。
\nFor example, the following template would load all the tags and filters\nregistered in somelibrary and otherlibrary located in package\npackage:
{% load somelibrary package.otherlibrary %}\nYou can also selectively load individual filters or tags from a library, using\nthe from argument. In this example, the template tags/filters named foo\nand bar will be loaded from somelibrary:
{% load foo bar from somelibrary %}\n詳しくは Custom tag and filter libraries を参照してください。
\nloremLink to this heading#ランダムな"lorem ipsum" のラテン語テキストを表示させます。テンプレート内でサンプルデータを用意するのに便利です。
\nUsage:
\n{% lorem [count] [method] [random] %}\n{% lorem %} タグは 0 から 3 個の引数をとります:
Argument | \n説明 | \n
|---|---|
| \n生成する単語または段落の数を指定する、数値または変数 (デフォルトは 1 ) 。 | \n
| \n
| \n
| \n
| \n
例:
\n{% lorem %} は、一般的な "lorem ipsum" を出力します。
{% lorem 3 p %} は一般的な "lorem ipsum" と 2 個のランダムな文章を、それぞれ HTML の <p> タグで括って出力します。
{% lorem 2 w random %} は 2 個のランダムなラテン単語を出力します。
nowLink to this heading#指定したフォーマット文字列にしたがって現在の日付や時刻を表示します。フォーマット文字列で使われる文字については、 date フィルタの項で説明しています。
Example:
\nIt is {% now "jS F Y H:i" %}\nNote that you can backslash-escape a format string if you want to use the\n"raw" value. In this example, both "o" and "f" are backslash-escaped, because\notherwise each is a format string that displays the year and the time,\nrespectively:
\nIt is the {% now "jS \\o\\f F" %}\nこの表示結果は "It is the 4th of September" となります。
\n\nYou can also use the syntax {% now "Y" as current_year %} to store the\noutput (as a string) inside a variable. This is useful if you want to use\n{% now %} inside a template tag like blocktranslate for example:
{% now "Y" as current_year %}\n{% blocktranslate %}Copyright {{ current_year }}{% endblocktranslate %}\nregroupLink to this heading#オブジェクトのリストから、同じ属性値を持つオブジェクトのグループを作ります。
\nこの複雑なタグは例を通して説明するのがいいでしょう: cities は "name", "population", and "country" をキーとして含むディクショナリによって表された都市のリストとします:
cities = [\n {"name": "Mumbai", "population": "19,000,000", "country": "India"},\n {"name": "Calcutta", "population": "15,000,000", "country": "India"},\n {"name": "New York", "population": "20,000,000", "country": "USA"},\n {"name": "Chicago", "population": "7,000,000", "country": "USA"},\n {"name": "Tokyo", "population": "33,000,000", "country": "Japan"},\n]\n...そして、あなたは次のように、国別に並べた一覧を表示させたいものとしましょう:
\nIndia
\nMumbai: 19,000,000
Calcutta: 15,000,000
USA
\nNew York: 20,000,000
Chicago: 7,000,000
Japan
\nTokyo: 33,000,000
You can use the {% regroup %} tag to group the list of cities by country.\nThe following snippet of template code would accomplish this:
{% regroup cities by country as country_list %}\n\n<ul>\n{% for country in country_list %}\n <li>{{ country.grouper }}\n <ul>\n {% for city in country.list %}\n <li>{{ city.name }}: {{ city.population }}</li>\n {% endfor %}\n </ul>\n </li>\n{% endfor %}\n</ul>\n順に追ってみましょう。{% regroup %} タグは 3 つの引数を持ちます: グループ分けを行うリスト、グループ分けに使う属性の名前、そして結果とするリストの名前の 3 つです。ここでは cities リストを country 属性を使ってグループに分け、その結果を country_list と呼ぶことにしています。
{% regroup %} produces a list (in this case, country_list) of\ngroup objects. Group objects are instances of\nnamedtuple() with two fields:
grouper -- グループ分けに使われた要素 ( ここでは "India" "Japan" といった文字列 )
list -- このグループ内のすべての要素からなるリスト ( たとえば country='India' であるすべての都市のリスト)
Because {% regroup %} produces namedtuple() objects,\nyou can also write the previous example as:
{% regroup cities by country as country_list %}\n\n<ul>\n{% for country, local_cities in country_list %}\n <li>{{ country }}\n <ul>\n {% for city in local_cities %}\n <li>{{ city.name }}: {{ city.population }}</li>\n {% endfor %}\n </ul>\n </li>\n{% endfor %}\n</ul>\n{% regroup %} は入力をソートしないことに注意してください! 上の例では、 リスト cities は、あらかじめ country の順でソート済みだという前提です。 cities が country の順に並べられて いなかった 場合、 regroup はそのまま何も考えずに 1 つの国に対してグループを 1 つ以上作ってしまうかもしれません。例えばリスト cities が、次のように ( リスト内で国ごとにまとまっていない状態に ) なっていたとしましょう:
cities = [\n {"name": "Mumbai", "population": "19,000,000", "country": "India"},\n {"name": "New York", "population": "20,000,000", "country": "USA"},\n {"name": "Calcutta", "population": "15,000,000", "country": "India"},\n {"name": "Chicago", "population": "7,000,000", "country": "USA"},\n {"name": "Tokyo", "population": "33,000,000", "country": "Japan"},\n]\nこの cities を入力に使うと、先ほどの {% regroup %} テンプレートコードは次のような結果を出力するでしょう:
India
\nMumbai: 19,000,000
USA
\nNew York: 20,000,000
India
\nCalcutta: 15,000,000
USA
\nChicago: 7,000,000
Japan
\nTokyo: 33,000,000
このような落し穴を解決するには、ビューコード内であらかじめデータを表示したい順番に並べておくのが最も簡単でしょう。
\nAnother solution is to sort the data in the template using the\ndictsort filter, if your data is in a list of dictionaries:
{% regroup cities|dictsort:"country" by country as country_list %}\nAny valid template lookup is a legal grouping attribute for the regroup\ntag, including methods, attributes, dictionary keys and list items. For\nexample, if the "country" field is a foreign key to a class with\nan attribute "description," you could use:
\n{% regroup cities by country.description as country_list %}\nOr, if country is a field with choices, it will have a\nget_FOO_display() method available as an\nattribute, allowing you to group on the display string rather than the\nchoices key:
{% regroup cities by get_country_display as country_list %}\nこのとき {{ country.grouper }} は choices の辞書から、キーではなく値のフィールドを表示することでしょう。
resetcycleLink to this heading#Resets a previous cycle so that it restarts from its first item at its next\nencounter. Without arguments, {% resetcycle %} will reset the last\n{% cycle %} defined in the template.
Example usage:
\n{% for coach in coach_list %}\n <h1>{{ coach.name }}</h1>\n {% for athlete in coach.athlete_set.all %}\n <p class="{% cycle 'odd' 'even' %}">{{ athlete.name }}</p>\n {% endfor %}\n {% resetcycle %}\n{% endfor %}\nThis example would return this HTML:
\n<h1>Gareth</h1>\n<p class="odd">Harry</p>\n<p class="even">John</p>\n<p class="odd">Nick</p>\n\n<h1>John</h1>\n<p class="odd">Andrea</p>\n<p class="even">Melissa</p>\nNotice how the first block ends with class="odd" and the new one starts\nwith class="odd". Without the {% resetcycle %} tag, the second block\nwould start with class="even".
You can also reset named cycle tags:
\n{% for item in list %}\n <p class="{% cycle 'odd' 'even' as stripe %} {% cycle 'major' 'minor' 'minor' 'minor' 'minor' as tick %}">\n {{ item.data }}\n </p>\n {% ifchanged item.category %}\n <h1>{{ item.category }}</h1>\n {% if not forloop.first %}{% resetcycle tick %}{% endif %}\n {% endifchanged %}\n{% endfor %}\nIn this example, we have both the alternating odd/even rows and a "major" row\nevery fifth row. Only the five-row cycle is reset when a category changes.
\nspacelessLink to this heading#ブロック内の HTML タグ間にある空白文字を除去します。タブ文字や改行も含みます。
\nExample usage:
\n{% spaceless %}\n <p>\n <a href="foo/">Foo</a>\n </p>\n{% endspaceless %}\nThis example would return this HTML:
\n<p><a href="foo/">Foo</a></p>\nOnly space between tags is removed -- not space between tags and text. In\nthis example, the space around Hello won't be stripped:
{% spaceless %}\n <strong>\n Hello\n </strong>\n{% endspaceless %}\ntemplatetagLink to this heading#テンプレートタグの構文で使われる文字を、通常の文字として出力します。
\nThe template system has no concept of "escaping" individual characters.\nHowever, you can use the {% templatetag %} tag to display one of the\ntemplate tag character combinations.
どの要素を出力するかは、引数で指定します:
\nArgument | \n出力 | \n
|---|---|
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
Sample usage:
\nThe {% templatetag openblock %} characters open a block.\nSee also the verbatim tag for another way of including these\ncharacters.
urlLink to this heading#ビューとオプションの引数を指定して、これとマッチする絶対パスへの参照 ( ドメイン部分を除いた URL ) を返します。結果のパスに特殊文字が含まれる場合、 iri_to_uri() を使ってエンコードされます。
This is a way to output links without violating the DRY principle by having to\nhard-code URLs in your templates:
\n{% url 'some-url-name' v1 v2 %}\nThe first argument is a URL pattern name. It can\nbe a quoted literal or any other context variable. Additional arguments are\noptional and should be space-separated values that will be used as arguments in\nthe URL. The example above shows passing positional arguments. Alternatively\nyou may use keyword syntax:
\n{% url 'some-url-name' arg1=v1 arg2=v2 %}\n1 つの呼び出しのなかで、固定引数とキーワード引数を混ぜることはできません。また URLconf で必要とされる引数はすべて指定しなければなりません。
\n例えば app_views.client という名前のビューがあって、クライアントの ID を引数に取るとしましょう ( client() は、 views ファイル app_views.py の中で定義されているメソッドです ) 。 URLconf は以下のようなものになるでしょう:
path("client/<int:id>/", app_views.client, name="app-views-client")\nこのアプリケーションの URLconf が、プロジェクトの URLconf の中に次のような形で include されていたとします:
\npath("clients/", include("project_name.app_name.urls"))\n...then, in a template, you can create a link to this view like this:
\n{% url 'app-views-client' client.id %}\nテンプレートタグの出力は、文字列 /clients/client/123/ となります。
Note that if the URL you're reversing doesn't exist, you'll get an\nNoReverseMatch exception raised, which will cause your\nsite to display an error page.
If you'd like to retrieve a URL without displaying it, you can use a slightly\ndifferent call:
\n{% url 'some-url-name' arg arg2 as the_url %}\n\n<a href="{{ the_url }}">I'm linking to {{ the_url }}</a>\n`` ～ as 変数`` の構文で作られた変数は、 {% url %} タグのある {% block %} 内がスコープとなります。
This {% url ... as var %} syntax will not cause an error if the view is\nmissing. In practice you'll use this to link to views that are optional:
{% url 'some-url-name' as the_url %}\n{% if the_url %}\n <a href="{{ the_url }}">Link to optional stuff</a>\n{% endif %}\nIf you'd like to retrieve a namespaced URL, specify the fully qualified name:
\n{% url 'myapp:view-name' %}\nこれは通常の namespaced URL resolution strategy に従います。ここには現在のアプリケーションに関してコンテキストから得られる様々なヒントについて書かれています。
\n\nverbatimLink to this heading#このブロックタグ内では、テンプレートエンジンによる解釈を行いません。
\nA common use is to allow a JavaScript template layer that collides with\nDjango's syntax. For example:
\n{% verbatim %}\n {{if dying}}Still alive.{{/if}}\n{% endverbatim %}\nYou can also designate a specific closing tag, allowing the use of\n{% endverbatim %} as part of the unrendered contents:
{% verbatim myblock %}\n Avoid template rendering via the {% verbatim %}{% endverbatim %} block.\n{% endverbatim myblock %}\nwidthratioLink to this heading#バーチャートなどを生成する場合のために、指定した値と最大値との比を計算し、 定数に掛けた値を返します。
\n例えば:
\n<img src="bar.png" alt="Bar"\n height="10" width="{% widthratio this_value max_value max_width %}">\nここで this_value = 175 、 max_value = 200 であるとき、画像の幅は 88 ピクセルになります (175 / 200 = .875、 .875 * 100 = 87.5 から四捨五入して 88 )。
\nIn some cases you might want to capture the result of widthratio in a\nvariable. It can be useful, for instance, in a blocktranslate like this:
{% widthratio this_value max_value max_width as width %}\n{% blocktranslate %}The width is: {{ width }}{% endblocktranslate %}\nwithLink to this heading#複雑な表現の変数の値をキャッシュし、簡単な名前で参照できるようにします。呼出しコストの高いメソッド (例えばデータベースを操作するようなメソッド) に何度もアクセスする際に便利です。
\n例えば:
\n{% with total=business.employees.count %}\n {{ total }} employee{{ total|pluralize }}\n{% endwith %}\n値を組み込んだ変数 (上の例でいえば total ) は {% with %} と {% endwith %} タグの間でだけ有効です。
You can assign more than one context variable:
\n{% with alpha=1 beta=2 %}\n ...\n{% endwith %}\naddLink to this heading#入力値に対して引数の値を加算します。
\n例えば:
\n{{ value|add:"2" }}\nvalue が 4 なら、出力は 6 になるでしょう。
\nこのフィルタは、まず両方の値を強制的に整数とみなして加算しようとします。失敗した場合は、とにかく値を足し合わせることを試みます。これはいくつかのデータ型 (文字列、リストなど) では動作しますが、それ以外では失敗します。失敗した場合、結果は空の文字列になります。
\nFor example, if we have:
\n{{ first|add:second }}\nfirst が [1, 2, 3] 、 second が [4, 5, 6] であった場合、出力は [1, 2, 3, 4, 5, 6] になります。
addslashesLink to this heading#引用符の前にスラッシュを追加します。CSV などの文字列をエスケープする際に便利です。
\n例えば:
\n{{ value|addslashes }}\nvalue の値が "I'm using Django" のとき、出力は "I\\'m using Django" となります。
capfirstLink to this heading#入力値の先頭の文字を大文字に変換します。最初の文字がアルファベットでなければ効果はありません。
\n例えば:
\n{{ value|capfirst }}\nIf value is "django", the output will be "Django".
centerLink to this heading#入力値を引数で指定された幅のフィールド内に中央寄せします。
\n例えば:
\n"{{ value|center:"15" }}"\nvalue の値が "django" のとき、出力は " Django " となります。
cutLink to this heading#入力値の中から、引数に指定した値を全て取り除きます。
\n例えば:
\n{{ value|cut:" " }}\nvalue の値が "String with spaces" のとき、出力は "Stringwithspaces" となります。
dateLink to this heading#引数に指定した書式で日付をフォーマットします。
\nUses a similar format to PHP's date() function with some\ndifferences.
\n\n利用可能なフォーマット文字:
\nフォーマット文字 | \n説明 | \n出力の例 | \n
|---|---|---|
Day | \n\n | \n |
| \n日。 2 桁のゼロ詰め表示です。 | \n
| \n
| \n日。ゼロ埋め表示なし。 | \n
| \n
| \n曜日。 アルファベット 3 文字のテキスト形式です。 | \n
| \n
| \n曜日。長いテキスト形式です。 | \n
| \n
| \n日を表わす数字につける、英語特有の接尾辞。アルファベット 2 文字です。 | \n
| \n
| \n曜日（数字 1 桁）。 | \n
| \n
| \n日（１年間における） | \n
| \n
Week | \n\n | \n |
| \nISO-8601 による年間の週番号。 週は月曜日から始まります。 | \n
| \n
Month | \n\n | \n |
| \n月。数字 2 桁で、ゼロ埋め表示します。 | \n
| \n
| \n月。ゼロ埋め表示しません。 | \n
| \n
| \n月。アルファベット 3 文字のテキスト形式です。 | \n
| \n
| \n月。アルファベット（小文字） 3 文字のテキスト形式です。 | \n
| \n
| \n月。ロケールが定義する代替表現が使われ、通常は長いテキスト形式になります。 | \n
| \n
| \n月。長いテキスト形式で表したものです。 | \n
| \n
| \nAP スタイルブックによる月の省略表記。独自の拡張です。 | \n
| \n
| \nその月の日数。 | \n
| \n
Year | \n\n | \n |
| \nYear, 2 digits with leading zeros. | \n
| \n
| \nYear, 4 digits with leading zeros. | \n
| \n
| \nうるう年かどうかを表すブール値です。 | \n
| \n
| \nISO-8601 の週番号付き記法による年。うるう週を用いた ISO-8601 週番号 (W) に対応します。一般的な年のフォーマットは Y を参照してください。 | \n
| \n
Time | \n\n | \n |
| \n時（ 12 時間表記）。ゼロ埋め表示なし。 | \n
| \n
| \n時（ 24 時間表記）。ゼロ埋め表示なし。 | \n
| \n
| \n時（ 12 時間表記）。 | \n
| \n
| \n時（ 24 時間表記）。 | \n
| \n
| \n分。 | \n
| \n
| \n秒。数字 2 桁で、ゼロ埋め表示です。 | \n
| \n
| \nマイクロ秒。 | \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n時と分（12 時間表記）。ただしゼロ分であるときは時間だけを表示します。これは独自の拡張です。 | \n
| \n
| \n時刻。12 時間表記による 時間:分 に続けて ‘a.m.’ または ’p.m.’ を表示します。ゼロ分である場合には分の表示が省略され、必要に応じて ‘midnight’ または ‘noon’ の表示になります。 独自の拡張です。 | \n
| \n
Timezone | \n\n | \n |
| \nタイムゾーン名。どのフォーマットでも使えますが、 datetime によっては空の文字列を返す場合もあります。 | \n
| \n
| \nDaylight saving time, whether it's in\neffect or not. | \n
| \n
| \nグリニッジ標準時からの時差。 | \n
| \n
| \n計算機のタイムゾーン設定。 | \n
| \n
| \nタイムゾーンオフセットを秒であらわしたもの。UTC よりも西側のタイムゾーン値は全て負の値になり、東側の値は常に正になります。 | \n
| \n
Date/Time | \n\n | \n |
| \nISO 8601 format. (Note: unlike other\nformatters, such as "Z", "O" or "r",\nthe "c" formatter will not add timezone\noffset if value is a naive datetime\n(see | \n
| \n
| \nRFC 5322\nformatted date. | \n
| \n
| \nUnix エポック時 ( UTC 協定世界時 1970年1月1日 00:00:00 ) からの秒数。 | \n\n |
例えば:
\n{{ value|date:"D d M Y" }}\n上の例で、値が datetime オブジェクトである場合 ( 例えば datetime.datetime.now() の結果など ) 、出力は 'Wed 09 Jan 2008' となります。
フォーマットには、プリセット（ DATE_FORMAT, DATETIME_FORMAT, SHORT_DATE_FORMAT or SHORT_DATETIME_FORMAT ）のうちの１つ、または上記の表で示したフォーマット指定文字を使ったカスタムフォーマットが使えます。プリセットのフォーマットは、現在のロケールに応じて表示が変化することに注意してください。
Assuming that USE_L10N is True and LANGUAGE_CODE is,\nfor example, "es", then for:
{{ value|date:"SHORT_DATE_FORMAT" }}\n上記の出力は、文字列 "09/01/2008" となります ( es ロケールの "SHORT_DATE_FORMAT" フォーマットは、 Django の初期設定では "d/m/Y" です)。
When used without a format string, the DATE_FORMAT format specifier is\nused. Assuming the same settings as the previous example:
{{ value|date }}\noutputs 9 de Enero de 2008 (the DATE_FORMAT format specifier for the\nes locale is r'j \\d\\e F \\d\\e Y'). Both "d" and "e" are\nbackslash-escaped, because otherwise each is a format string that displays the\nday and the timezone name, respectively.
You can combine date with the time filter to render a full\nrepresentation of a datetime value. E.g.:
{{ value|date:"D d M Y" }} {{ value|time:"H:i" }}\ndefaultLink to this heading#入力の評価値が False の場合、引数に指定したデフォルト値を使います。そうでなければ、入力値を使います。
例えば:
\n{{ value|default:"nothing" }}\nvalue が "" ( 空の文字列 ) のとき、出力は nothing になります。
default_if_noneLink to this heading#入力値が None であるとき ( None であるときのみ ) 、引数に指定したデフォルト値を使いま す。そうでなければ、入力値を使います。
空の文字列が入力された場合は、デフォルト値を 使わない ことに注意してください。空文字列をフォールバックしたければ default フィルタを使ってください。
例えば:
\n{{ value|default_if_none:"nothing" }}\nIf value is None, the output will be nothing.
dictsortLink to this heading#辞書のリストを入力として、引数に指定したキーでリストをソートして返します。
\n例えば:
\n{{ value|dictsort:"name" }}\nvalue が以下の内容であるとします:
[\n {"name": "zed", "age": 19},\n {"name": "amy", "age": 22},\n {"name": "joe", "age": 31},\n]\nこのとき出力は以下のようになるでしょう:
\n[\n {"name": "amy", "age": 22},\n {"name": "joe", "age": 31},\n {"name": "zed", "age": 19},\n]\nYou can also do more complicated things like:
\n{% for book in books|dictsort:"author.age" %}\n * {{ book.title }} ({{ book.author.name }})\n{% endfor %}\nここで books が以下の内容だとします:
[\n {"title": "1984", "author": {"name": "George", "age": 45}},\n {"title": "Timequake", "author": {"name": "Kurt", "age": 75}},\n {"title": "Alice", "author": {"name": "Lewis", "age": 33}},\n]\nこのとき出力は以下のようになるでしょう:
\n* Alice (Lewis)\n* 1984 (George)\n* Timequake (Kurt)\ndictsort can also order a list of lists (or any other object implementing\n__getitem__()) by elements at specified index. For example:
{{ value|dictsort:0 }}\nvalue が以下の内容であるとします:
[\n ("a", "42"),\n ("c", "string"),\n ("b", "foo"),\n]\nこのとき出力は以下のようになるでしょう:
\n[\n ("a", "42"),\n ("b", "foo"),\n ("c", "string"),\n]\nYou must pass the index as an integer rather than a string. The following\nproduce empty output:
\n{{ values|dictsort:"0" }}\nOrdering by elements at specified index is not supported on dictionaries.
\n\ndictsortreversedLink to this heading#辞書のリストを入力に取り、引数に指定したキーでリストを逆順にソートして返します。これは上のフィルタと全く同じ処理をしますが、返す値は逆順です。
\ndivisiblebyLink to this heading#値が引数の値で割り切れる場合に True を返します。
例えば:
\n{{ value|divisibleby:"3" }}\nvalue が 21 であるとき、出力は True です。
escapeLink to this heading#入力文字中にある HTML の特殊文字をエスケープします。具体的には、以下のような置換を行います:
\n< を < に変換
> を > に変換
' (single quote) is converted to '
" ( ダブルクォート ) を " に変換
& を & に変換
escape を変数に適用するとき、変数にはすでに自動エスケープが適用されているかもしれませんが、エスケープが二重に実行されることはありません。したがって自動エスケープ環境であっても、この機能は安全に使用できます。複数回のエスケープが適用されるようにしたい場合は force_escape フィルターを使用してください。
For example, you can apply escape to fields when autoescape is off:
{% autoescape off %}\n {{ title|escape }}\n{% endautoescape %}\nescapejsLink to this heading#Escapes characters for use as a whole JavaScript string literal, within single\nor double quotes, as below. This filter does not make the string safe for use\nin "JavaScript template literals" (the JavaScript backtick syntax). Any other\nuses not listed above are not supported. It is generally recommended that data\nshould be passed using HTML data- attributes, or the json_script\nfilter, rather than in embedded JavaScript.
例えば:
\n<script>\nlet myValue = '{{ value|escapejs }}'\nfilesizeformatLink to this heading#入力値を、人間が読みやすいファイルサイズ表現 ('13 KB', '4.1 MB', '102 bytes' など) に変換します。
\n例えば:
\n{{ value|filesizeformat }}\nvalue が 123456789 のとき、出力は 117.7 MB になります。
firstLink to this heading#リスト中の最初の要素を返します。
\n例えば:
\n{{ value|first }}\nvalue がリスト ['a', 'b', 'c'] であるとき、出力は 'a' になります。
floatformatLink to this heading#引数なしで使った場合、浮動小数点数を小数点以下１桁に丸めます。ただし小数部分がない時には整数部分だけを表示します。例を示します:
\n
| \nテンプレート | \n出力 | \n
|---|---|---|
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
引数に１以上の整数を指定した場合、 floatformat は小数部分を指定された桁数で丸めます。以下に例を示します:
| \nテンプレート | \n出力 | \n
|---|---|---|
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
特に便利な使い方として、引数に 0 (ゼロ) を指定した場合、入力値を一番近い整数に丸めます。
\n
| \nテンプレート | \n出力 | \n
|---|---|---|
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
引数に負の数を指定した場合、小数部分を指定された桁数（指定された数の絶対値）で丸めます。ただし小数部分がない時には整数部分だけを表示します。例を示します:
\n
| \nテンプレート | \n出力 | \n
|---|---|---|
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
If the argument passed to floatformat has the g suffix, it will force\ngrouping by the THOUSAND_SEPARATOR for the active locale. For\nexample, when the active locale is en (English):
| \nテンプレート | \n出力 | \n
|---|---|---|
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
Output is always localized (independently of the {% localize off %} tag) unless the argument passed to floatformat has the u\nsuffix, which will force disabling localization. For example, when the active\nlocale is pl (Polish):
| \nテンプレート | \n出力 | \n
|---|---|---|
| \n
| \n
| \n
| \n
| \n
| \n
floatformat を引数なしで使用した場合の動作は、引数に -1 を指定した場合と同じです。
force_escapeLink to this heading#文字列に HTML エスケープを適用します。 ( 詳しくは escape フィルタを参照してください )。フィルタは 即座に 適用され、新たなエスケープ済みの文字列を返します。このタグが有用となるケースは稀で、複数回のエスケープが必要な場合や、エスケープされた結果に対して他のフィルタを適用したい場合に使います。通常は escape フィルタを使うことになるでしょう。
For example, if you want to catch the <p> HTML elements created by\nthe linebreaks filter:
{% autoescape off %}\n {{ body|linebreaks|force_escape }}\n{% endautoescape %}\nget_digitLink to this heading#入力値が整数であるとき、引数で指定された桁にある数字を返します。例えば引数が 1 のとき右端の桁、 2 のとき右から 2 桁目が指定されます。入力が整数でない場合には、入力値をそのまま返します。
\n例えば:
\n{{ value|get_digit:"2" }}\nvalue が 123456789 のとき、出力は 8 です。
iriencodeLink to this heading#IRI (国際化リソース識別子 Internationalized Resource Identifier) を URL に適した文字列に変換します。これは非 ASCII 文字列を URL に埋め込む場合に必要なフィルタです。
\nurlencode フィルタを通した後の文字列を、このフィルタに通しても問題はありません。
例えば:
\n{{ value|iriencode }}\nvalue の値が "?test=1&me=2" のとき、出力は "?test=1&me=2" になります。
joinLink to this heading#Python の str.join(list) と同じく、リストを文字列でつなぎます。
例えば:
\n{{ value|join:" // " }}\nvalue の値がリスト ['a', 'b', 'c'] であるとき、出力は文字列 "a // b // c" となります。
json_scriptLink to this heading#Safely outputs a Python object as JSON, wrapped in a <script> tag, ready\nfor use with JavaScript.
Argument: The optional HTML "id" of the <script> tag.
例えば:
\n{{ value|json_script:"hello-data" }}\nIf value is the dictionary {'hello': 'world'}, the output will be:
<script id="hello-data" type="application/json">{"hello": "world"}</script>\nThe resulting data can be accessed in JavaScript like this:
\nconst value = JSON.parse(document.getElementById('hello-data').textContent);\nXSS attacks are mitigated by escaping the characters "<", ">" and "&". For\nexample if value is {'hello': 'world</script>&'}, the output is:
<script id="hello-data" type="application/json">{"hello": "world\\\\u003C/script\\\\u003E\\\\u0026amp;"}</script>\nThis is compatible with a strict Content Security Policy that prohibits in-page\nscript execution. It also maintains a clean separation between passive data and\nexecutable code.
\n\nlastLink to this heading#リストの末尾の要素を返します。
\n例えば:
\n{{ value|last }}\nvalue の値がリスト ['a', 'b', 'c', 'd'] のとき、出力は文字列 "d" です。
lengthLink to this heading#入力値の長さを返します。これは、文字列とリストの両方で動作します。
\n例えば:
\n{{ value|length }}\nvalue が ['a', 'b', 'c', 'd'] 、 "abcd" であるとき、それぞれ出力は 4 になります。
The filter returns 0 for an undefined variable.
length_isLink to this heading#入力値の長さと引数が等しければ True を返し、そうでなければ False を返します。
例えば:
\n{{ value|length_is:"4" }}\nvalue が ['a', 'b', 'c', 'd'] あるいは "abcd" であるとき、それぞれ出力は True です。
linebreaksLink to this heading#Replaces line breaks in plain text with appropriate HTML; a single\nnewline becomes an HTML line break (<br>) and a new line\nfollowed by a blank line becomes a paragraph break (</p>).
例えば:
\n{{ value|linebreaks }}\nIf value is Joel\\nis a slug, the output will be <p>Joel<br>is a\nslug</p>.
linebreaksbrLink to this heading#Converts all newlines in a piece of plain text to HTML line breaks\n(<br>).
例えば:
\n{{ value|linebreaksbr }}\nIf value is Joel\\nis a slug, the output will be Joel<br>is a\nslug.
linenumbersLink to this heading#テキストを行番号付きで表示します。
\n例えば:
\n{{ value|linenumbers }}\nvalue が以下の内容であるとします:
one\ntwo\nthree\nthe output will be:
\n1. one\n2. two\n3. three\nljustLink to this heading#入力値を指定した幅のフィールド内で左詰めします。
\n引数: フィールドの幅
\n例えば:
\n"{{ value|ljust:"10" }}"\nvalue が Django であるとき、出力は "Django " となります。
lowerLink to this heading#文字列を全て小文字に変換します。
\n例えば:
\n{{ value|lower }}\nvalue が Totally LOVING this Album! であるとき、出力は totally loving this album! となります。
make_listLink to this heading#Returns the value turned into a list. For a string, it's a list of characters.\nFor an integer, the argument is cast to a string before creating a list.
\n例えば:
\n{{ value|make_list }}\nvalue の値が文字列 "Joel" であるとき、出力はリスト ['J', 'o', 'e', 'l'] です。 value が 123 のとき、出力はリスト ['1', '2', '3'] となります。
phone2numericLink to this heading#電話番号 (文字を含む場合もあります) を数値だけの番号に変換します。
\n入力値は正しい電話番号でなくてもかまいません。このフィルタはどんな文字列でも変換します。
\n例えば:
\n{{ value|phone2numeric }}\nvalue が 800-COLLECT のとき、出力は 800-2655328 となります。
pluralizeLink to this heading#Returns a plural suffix if the value is not 1, '1', or an object of\nlength 1. By default, this suffix is 's'.
Example:
\nYou have {{ num_messages }} message{{ num_messages|pluralize }}.\nnum_messages が 1 のとき、出力は You have 1 message. です。 num_messages が 2 のとき、出力は You have 2 messages. となります。
's' 以外の接尾辞が必要な場合は、代わりの接尾辞をフィルタの引数で指定できます。
Example:
\nYou have {{ num_walruses }} walrus{{ num_walruses|pluralize:"es" }}.\n単純な接尾辞では複数形にできない単語の場合、単数形と複数形の接尾辞の両方をコンマで区切って指定できます。
\nExample:
\nYou have {{ num_cherries }} cherr{{ num_cherries|pluralize:"y,ies" }}.\npprintLink to this heading#pprint.pprint() のラッパーです -– 実のところ、これはデバッグ用です。
randomLink to this heading#与えられたリストからランダムな要素を返します。
\n例えば:
\n{{ value|random }}\nvalue の値がリスト ['a', 'b', 'c', 'd'] であるとき、出力は "b" かもしれません。
rjustLink to this heading#入力値を指定した幅のフィールド内で右詰めします。
\n引数: フィールドの幅
\n例えば:
\n"{{ value|rjust:"10" }}"\nvalue が Django であるとき、出力は " Django" となります。
safeLink to this heading#文字列に対して、さらなる HTML エスケープが必要でないことをマークするのに使います。 autoescaping がオフの場合、このフィルタは何もしません。
\n\nsafeseqLink to this heading#Applies the safe filter to each element of a sequence. Useful in\nconjunction with other filters that operate on sequences, such as\njoin. For example:
{{ some_list|safeseq|join:", " }}\nこの場合、直接 safe フィルタを使用すると正しく動作しないかもしれません。シーケンスの個々の要素に対して作用するのではなく、まず変数を文字列に変換して処理するからです。
sliceLink to this heading#リストに対するスライスを返します。
\nUses the same syntax as Python's list slicing. See\nhttps://diveinto.org/python3/native-datatypes.html#slicinglists for an\nintroduction.
\nExample:
\n{{ some_list|slice:":2" }}\nsome_list が ['a', 'b', 'c'] ならば、出力は ['a', 'b'] となります。
slugifyLink to this heading#ASCIIに変換します。スペースをハイフンに変換します。英数字以外の文字、アンダースコア、ハイフンは削除します。小文字に変換します。また、先頭と末尾の空白を取り除きます。
\n例えば:
\n{{ value|slugify }}\nvalue が "Joel is a slug" であるとき、出力は "joel-is-a-slug" となります。
stringformatLink to this heading#引数 (表示形式を指定する文字列) に応じて、変数の表示形式を変更します。指定方法には、printf-style String Formatting シンタックスを使います。例外として、最初の ''%'' は無視されます。
\n例えば:
\n{{ value|stringformat:"E" }}\n例えば value が 10 の場合、出力は 1.000000E+01 となります。
timeLink to this heading#時刻を指定の書式にしたがってフォーマットします。
\nフォーマットは date と同様に、あらかじめ定義された TIME_FORMAT のプリセット、またはカスタムフォーマットを使うこともできます。この定義はロケールに依存することに注意してください。
例えば:
\n{{ value|time:"H:i" }}\nvalue が datetime.datetime.now() の値であるとき、出力は "01:23" といった文字列になります。
Note that you can backslash-escape a format string if you want to use the\n"raw" value. In this example, both "h" and "m" are backslash-escaped, because\notherwise each is a format string that displays the hour and the month,\nrespectively:
\n{{ value|time:"H\\h i\\m" }}\nThis would display as "01h 23m".
\nその他の例:
\nAssuming that USE_L10N is True and LANGUAGE_CODE is,\nfor example, "de", then for:
{{ value|time:"TIME_FORMAT" }}\nthe output will be the string "01:23" (The "TIME_FORMAT" format\nspecifier for the de locale as shipped with Django is "H:i").
The time filter will only accept parameters in the format string that\nrelate to the time of day, not the date. If you need to format a date\nvalue, use the date filter instead (or along with time if\nyou need to render a full datetime value).
上記のルールにはひとつ例外があります。タイムゾーン情報つきの datetime の値 (a time-zone-aware datetime instance) を渡した場合、 time フィルタはタイムゾーン関連の format specifiers である 'e'、'O'、'T'、'Z' を受け付けます。
When used without a format string, the TIME_FORMAT format specifier is\nused:
{{ value|time }}\nis the same as:
\n{{ value|time:"TIME_FORMAT" }}\ntimesinceLink to this heading#日付を経過時間の形式にフォーマットします (例えば、 “4 days, 6 hours”) 。
\nTakes an optional argument that is a variable containing the date to use as\nthe comparison point (without the argument, the comparison point is now).\nFor example, if blog_date is a date instance representing midnight on 1\nJune 2006, and comment_date is a date instance for 08:00 on 1 June 2006,\nthen the following would return "8 hours":
{{ blog_date|timesince:comment_date }}\nタイムゾーン情報を持たない値（offset-naive）と、タイムゾーン情報つき（offset-aware）の値とを比較した場合は、空の文字列を返します。
\n最小単位は "分" です。比較対象からみて未来にある日時に対しては "0 minutes" を返します。
\ntimeuntilLink to this heading#timesince に似ていますが、現在時刻を起点として指定の日付または日時までの時刻を計算します。例えば今日が 2006年 6月 1日で conference_date が 2006年 6月 29日の値を保持する日付インスタンスだったとすれば、 {{ conference_date|timeuntil }} は "4 weeks" を返します。
Takes an optional argument that is a variable containing the date to use as\nthe comparison point (instead of now). If from_date contains 22 June\n2006, then the following will return "1 week":
{{ conference_date|timeuntil:from_date }}\nタイムゾーン情報を持たない値（offset-naive）と、タイムゾーン情報つき（offset-aware）の値とを比較した場合は、空の文字列を返します。
\n最小単位は "分" です。比較対象からみて過去にある日時に対しては “0 minutes” を返します。
\ntitleLink to this heading#文字列中の単語に対して、それぞれ先頭の文字を大文字に、残りを小文字にすることで文字列をタイトルケースに変換します。"主要でない単語" については小文字を維持できないこともあります。
\n例えば:
\n{{ value|title }}\nvalue が "my FIRST post" であるとき、出力は "My First Post" となります。
truncatecharsLink to this heading#Truncates a string if it is longer than the specified number of characters.\nTruncated strings will end with a translatable ellipsis character ("…").
\n引数: 切り詰める文字数
\n例えば:
\n{{ value|truncatechars:7 }}\nvalue が "Joel is a slug" であるとき、出力は "Joel i…" となります。
truncatechars_htmlLink to this heading#truncatechars に似ていますが、 HTML タグを認識します。切り詰めを行う時点で閉じていないタグがあれば、切り詰めた文字の直後に全て閉じます。
例えば:
\n{{ value|truncatechars_html:7 }}\nIf value is "<p>Joel is a slug</p>", the output will be\n"<p>Joel i…</p>".
HTML コンテンツ内の改行は保持されます。
\n\n\ntruncatewordsLink to this heading#文字列を指定された単語数以内に切り詰めます。
\n引数: 切り詰めた後の単語数
\n例えば:
\n{{ value|truncatewords:2 }}\nIf value is "Joel is a slug", the output will be "Joel is …".
文字列中の改行は取り除かれます。
\ntruncatewords_htmlLink to this heading#truncatewords に似ていますが、 HTML タグを認識します。切り詰めを行う時点で閉じていないタグがあれば、切り詰めた文字の直後に全て閉じます。
このタグの処理は truncatewords よりも効率が悪いため、 HTML テキストを 渡す場合にだけ使うようにしてください。
例えば:
\n{{ value|truncatewords_html:2 }}\nIf value is "<p>Joel is a slug</p>", the output will be\n"<p>Joel is …</p>".
HTML コンテンツ内の改行は保持されます。
\n\n\nunordered_listLink to this heading#Recursively takes a self-nested list and returns an HTML unordered list --\nWITHOUT opening and closing <ul> tags.
The list is assumed to be in the proper format. For example, if var\ncontains ['States', ['Kansas', ['Lawrence', 'Topeka'], 'Illinois']], then\n{{ var|unordered_list }} would return:
<li>States\n<ul>\n <li>Kansas\n <ul>\n <li>Lawrence</li>\n <li>Topeka</li>\n </ul>\n </li>\n <li>Illinois</li>\n</ul>\n</li>\nupperLink to this heading#入力値をすべて大文字に変換します。
\n例えば:
\n{{ value|upper }}\nvalue が "Joel is a slug" であるとき、出力は "JOEL IS A SLUG" となります。
urlencodeLink to this heading#入力値を URL で使えるようにエスケープします。
\n例えば:
\n{{ value|urlencode }}\nvalue が "https://www.example.org/foo?a=b&c=d" のとき、出力は "https%3A//www.example.org/foo%3Fa%3Db%26c%3Dd" となります。
オプションの引数で、エスケープさせない文字を指定できます。
\nIf not provided, the '/' character is assumed safe. An empty string can be\nprovided when all characters should be escaped. For example:
\n{{ value|urlencode:"" }}\nここで value が "https://www.example.org/" であるとき、出力は "https%3A%2F%2Fwww.example.org%2F" となります。
urlizeLink to this heading#テキスト内の URL と Email アドレスをクリック可能なリンクに変換します。
\nこのテンプレートタグは http://、https://、www. で始まるリンクに作用します。例えば https://goo.gl/aia1t は変換されます。しかし goo.gl/aia1t はそのままです。
末尾が .com、.edu、.gov、.int、.mil、.net、.org である場合は、ドメイン名のみのリンクもサポートします。例えば djangoproject.com は変換されます。
Links can have trailing punctuation (periods, commas, close-parens) and leading\npunctuation (opening parens), and urlize will still do the right thing.
urlize が生成したリンクにはアトリビュート rel="nofollow" が加えられています。
例えば:
\n{{ value|urlize }}\nvalue が "Check out www.djangoproject.com" であるとき、出力は "Check out <a href="http://www.djangoproject.com" rel="nofollow">www.djangoproject.com</a>" となります。
ウェブリンクに加えて、 urlize は email アドレスも mailto: リンクに変換できます。value が "Send questions to foo@example.com" であるとき、出力は "Send questions to <a href="mailto:foo@example.com">foo@example.com</a>" となります。
urlize フィルタはオプションの引数 autoescape をとることができます。autoescape が True のとき、リンクテキストと URL は Django の組み込みフィルタ escape でエスケープされます。指定しない場合の autoescape の値は True です。
urlizetruncLink to this heading#urlize と同じように、URL と email アドレスをクリック可能なリンクに変換します。ただし、指定の文字数以上の表示を切り詰めます。
\n引数: URL を切り詰める長さ。省略記号の長さを含みます。省略記号は省略が必要な場合につけられます。
\n例えば:
\n{{ value|urlizetrunc:15 }}\nIf value is "Check out www.djangoproject.com", the output would be\n'Check out <a href="http://www.djangoproject.com"\nrel="nofollow">www.djangoproj…</a>'.
urlize と同じく、このフィルタはプレーンテキストに対してだけ使ってください。
\nwordcountLink to this heading#ワード数を返します。
\n例えば:
\n{{ value|wordcount }}\nvalue が "Joel is a slug" のとき、出力は 4 です。
wordwrapLink to this heading#指定した行幅でワードラップします。
\n引数: テキストをラップするまでのワード数
\n例えば:
\n{{ value|wordwrap:5 }}\nIf value is Joel is a slug, the output would be:
Joel\nis a\nslug\nyesnoLink to this heading#入力値 ( "True" 、 "False" 、オプションで "None" ) に対応する文字列を返します。対応する文字列はデフォルトでは "yes"、"no"、"maybe" です。またコンマ区切りの文字列を引数として与えることでカスタムマッピングを指定できます。
\n例えば:
\n{{ value|yesno:"yeah,no,maybe" }}\n値 | \nArgument | \n出力 | \n
|---|---|---|
| \n\n |
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n