組み込みタグ／フィルタリファレンス¶

組み込みタグリファレンス¶

autoescape¶

自動エスケープ機能を制御します。このタグは引数に on または off を取り、ブロック内の自動エスケープの有効・無効を決定します。

自動エスケープがオンの場合、変数の値は全て、最終的な文字列出力になる直前に HTML エスケープされます (他のフィルタは先に適用されます)。この動作は、変数に escape フィルタを手動で適用した場合と同じです。

例外として、変数をテンプレートに挿入するコードや、 safe, escape といったフィルタの適用によって、 “safe” マーク済みの変数はエスケープされません。

block¶

子テンプレートでオーバライドできるブロックを定義します。テンプレートの継承を参照してください。

comment¶

{% comment %} から {% endcomment %} までの内容を全て無視します。

extends¶

このテンプレートが親テンプレートを継承することを指示します。

詳しくはテンプレートの継承を参照してください。

filter¶

タグのコンテンツを変数フィルタ (variable filter) を使ってフィルタします。

フィルタはパイプでつないで連鎖でき、引数をもたせることができます。

使用例:

{% filter force_escape|lower %}
    This text will be HTML-escaped, and will appear in all lowercase.
{% endfilter %}

firstof¶

タグに渡された変数のうち、False でない最初の変数の値を出力します。全ての変数が False であった場合、何も出力しません。

使用例:

{% firstof var1 var2 var3 %}

上は、以下のテンプレートと等価です:

{% if var1 %}
    {{ var1 }}
{% else %}{% if var2 %}
    {{ var2 }}
{% else %}{% if var3 %}
    {{ var3 }}
{% endif %}{% endif %}{% endif %}

また、全ての変数が False の場合のフォールバック値としてリテラル文字列を指定できます:

{% firstof var1 var2 var3 "fallback value" %}

警告

firstof タグは出力する変数タグをエスケープしません。エスケープしたければ firstof タグ全体を filter タグを使って以下のように設定してください:

{% filter force_escape %}
    {% firstof var1 var2 var3 "fallback value" %}
{% endfilter %}

for¶

アレイの各要素に渡ってループします。例えば、アスリート (athlete) のリストを athlete_list で渡して表示するには:

<ul>
{% for athlete in athlete_list %}
    <li>{{ athlete.name }}</li>
{% endfor %}
</ul>

{% for obj in list reversed %} のようにすると、リストに対して逆順のループを実行できます。

リストの入れ子に対してループ処理を行う場合、各サブリストをアンパックして、個別に名前を割り当てられます。例えば、座標 (x, y) のリストが入った points というコンテキスト変数があり、各座標を出力したい場合には以下のようにします:

{% for x, y in points %}
    座標 {{ x }},{{ y }} が登録されています。
{% endfor %}

この方法は、辞書の各要素にアクセスしたい場合にも便利です。例えば、コンテキスト変数 data に辞書が入っている場合。以下のようにすれば辞書内のキーと値を表示できます:

{% for key, value in data.items %}
    {{ key }}: {{ value }}
{% endfor %}

また、 for タグ中ではループの各回ごとに使える次の変数を参照できます:

変数名説明

forloop.counter 現在のループ回数番号 (1 から数えたもの)

forloop.counter0 現在のループ回数番号 (0 から数えたもの)

forloop.revcounter 末尾から数えたループ回数番号 (1 から数えたもの)

forloop.revcounter0 末尾から数えたループ回数番号 (0 から数えたもの)

forloop.first 最初のループであれば True になります

forloop.last 最後のループであれば True になります

forloop.parentloop 入れ子のループの場合、一つ上のループを表します

変数名	説明
`forloop.counter`	現在のループ回数番号 (1 から数えたもの)
`forloop.counter0`	現在のループ回数番号 (0 から数えたもの)
`forloop.revcounter`	末尾から数えたループ回数番号 (1 から数えたもの)
`forloop.revcounter0`	末尾から数えたループ回数番号 (0 から数えたもの)
`forloop.first`	最初のループであれば True になります
`forloop.last`	最後のループであれば True になります
`forloop.parentloop`	入れ子のループの場合、一つ上のループを表します

for ... empty¶

for タグは、与えられたリストが空であったり、見つからなかったりした場合の代替文設定に {% empty %} 節をオプションとして利用できます:

<ul>
{% for athlete in athlete_list %}
    <li>{{ athlete.name }}</li>
{% empty %}
    <li>Sorry, no athlete in this list!</li>
{% endfor %}
<ul>

次の記述は上記と等価ですが、上記の方が、コードが短く、レンダリングが早いです:

<ul>
  {% if athlete_list %}
    {% for athlete in athlete_list %}
      <li>{{ athlete.name }}</li>
    {% endfor %}
  {% else %}
    <li>Sorry, no athletes in this list.</li>
  {% endif %}
</ul>

if¶

変数を評価して、値が「真」 (値が存在して、空の配列でなく、ブール値が偽でない) の場合、ブロック内のコンテンツを出力します:

{% if athlete_list %}
    Number of athletes: {{ athlete_list|length }}
{% else %}
    No athletes.
{% endif %}

上の例では、 athlete_list が空でなければ、アスリートの人数を {{ athlete_list|length }} で表示します。

例にもあるように、 if タグにはオプションの {% else %} 節があり、テストに失敗した場合に表示されるコンテンツを定義できます。

and や or で複数の変数をチェックしたり、 not で否をとったりできます:

{% if athlete_list and coach_list %}
    Both athletes and coaches are available.
{% endif %}

{% if not athlete_list %}
    There are no athletes.
{% endif %}

{% if athlete_list or coach_list %}
    There are some athletes or some coaches.
{% endif %}

{% if not athlete_list or coach_list %}
    There are no athletes or there are some coaches (OK, so
    writing English translations of boolean logic sounds
    stupid; it's not our fault).
{% endif %}

{% if athlete_list and not coach_list %}
    There are some athletes and absolutely no coaches.
{% endif %}

{% if athlete_list and not coach_list %}
    There are some athletes and absolutely no coaches.
{% endif %}

and と or 節を同じタグの中に入れると、ロジックの優先順位があいまいになるため、同じ if タグには入れられません。例えば、以下のテンプレートは無効です:

{% if athlete_list and coach_list or cheerleader_list %}

and タグと or タグを使ったロジックを行いたければ、以下の例のように if タグを入れ子にしてください:

{% if athlete_list %}
    {% if coach_list or cheerleader_list %}
        We have athletes, and either coaches or cheerleaders!
    {% endif %}
{% endif %}

同じ論理記号はいくつでも並べられます。ただし、同じ演算子を使う場合に限ります。例えば、以下は有効なテンプレートです:

{% if athlete_list or coach_list or parent_list or teacher_list %}

ifchanged¶

ブロック内のコンテンツが直前のループと違う値になるかどうか調べます。

ifchanged ブロックタグはループの中で使います。このタグには二通りの使い方があります。

ブロック内のレンダリング対象コンテンツを直前のループでの状態と比較して、内容が変化している場合にのみコンテンツを表示する場合です。例えば、日付のリストを表示するときに、月が変わったときだけ月名を表示したければ以下のようにします:
```
<h1>Archive for {{ year }}</h1>

{% for date in days %}
    {% ifchanged %}<h3>{{ date|date:"F" }}</h3>{% endifchanged %}
    <a href="{{ date|date:"M/d"|lower }}/">{{ date|date:"j" }}</a>
{% endfor %}
```
タグに引数を指定すると、変数が変化したかどうかを調べます。例えば、以下の例では日付が変化したときに日付を表示し、日付と時刻が同時に変化したときのみ時刻も表示します:
```
{% for date in days %}
    {% ifchanged date.date %} {{ date.date }} {% endifchanged %}
    {% ifchanged date.hour date.date %}
        {{ date.hour }}
    {% endifchanged %}
{% endfor %}
```

ifchanged は変数が変化しなかった場合の代替文設定に {% else %} 節をオプションとして利用できます:

{% for match in matches %}
    <div style="background-color:
        {% ifchanged match.ballot_id %}
            {% cycle "red" "blue" %}
        {% else %}
            grey
        {% endifchanged %}
    ">{{ match }}</div>
{% endfor %}

ifequal¶

2 つの引数が互いに等しい場合にブロックの内容を出力します。引数と比較できるのは、テンプレート変数または文字列です。

例:

{% ifequal user.id comment.user_id %}
    ...
{% endifequal %}

{% ifequal user.username "adrian" %}
    ...
{% endifequal %}

{% if %} タグと同様、オプションで {% else %} 節を使えます。

ifnotequal¶

2 つの引数が互いに等しくない場合にブロックの内容を出力します。

include¶

テンプレートをロードして、現在のコンテキストを使ってレンダリングします。あるテンプレートに別のテンプレートを取り込む (“include”) 方法の一つです。

テンプレート名はハードコードされた (引用符で囲った) 文字列でもよく、引用符は一重でも二重でもかまいません。

以下の例では、 "foo/bar.html" という名前のテンプレートを取り込みます:

{% include "foo/bar.html" %}

次の例では、変数 template_name に入っている名前のテンプレートを取り込みます:

{% include template_name %}

取り込まれたテンプレートは、取り込んだ側で使われているコンテキストの下でレンダリングされます。下の例では "Hello, John" を出力します:

コンテキスト: 変数 person を "john" に設定
テンプレート:
{% include "name_snippet.html" %}
name_snippet.html テンプレート:
Hello, {{ person }}

ssi タグに同様の機能があります。こちらも参照してください。

load¶

テンプレートタグリストを読み込みます。最上位のテンプレート(例えば、base.html)には次のタグを先頭に記述します。これらのタグは必須です:

{% load cms_tags, menu_tags, sekizai_tags %}

また、必要に応じて次のタグを読み込むことがあります:

{% load jsm7cms_tags, thumbnail %}

now¶

指定したフォーマット文字列にしたがって現在の日時を表示します。

フォーマットは PHP の date() 関数 (http://php.net/date) と同じで、いくつかの点で拡張されています。

利用できるフォーマットを示します:

フォーマット文字説明出力例

a 'a.m.' または 'p.m.' (Associated Press に合わせるため、’.’ が入っている点が PHP と違います)。 'a.m.'

A 'AM' または 'PM' です。 'AM'

b 3 文字の小文字で表した月名です。 'jan'

B 実装されていません。

d 月の中の日。 2 桁のゼロ詰めです。 '01' から '31'

D 週の中の日。 3 文字のテキスト形式です。 'Fri'

f 12 時間表記の時と分。ただし、ゼロ分の場合には表示しません。独自の拡張です。 '1', '1:30'

F 月名を長いテキスト形式で表したものです。 'January'

g 12 時間表記の時。ゼロ詰めはしません。 '1' から '12'

G 24 時間表記の時。ゼロ詰めはしません。 '0' から '23'

h 12 時間表記の時です。 '01' から '12'

H 24 時間表記の時です。 '00' から '23'

i 分です。 '00' から '59'

I 実装されていません。

j 月の中の日。ゼロ詰めしません。 '1' から '31'

l 週の中の曜日。長いテキスト形式です。 'Friday'

L 閏年かどうかを表すブール値です。 True または False

m 月です。2 桁でゼロ詰めしたものです。 '01' から '12'

M 月です。3 文字のテキスト形式です。 'Jan'

n 月です。ゼロ詰めしません。 '1' から '12'

N Associated Press スタイルの月の省略表記です。独自の拡張です。 'Jan.', 'Feb.', 'March', 'May'

O グリニッジ標準時からの時差です。 '+0200'

P 時刻です。12 時間表記の時、分、そして ‘a.m.’/’p.m.’ です。分がゼロの場合には省略され、必要に応じて ‘midnight’ または ‘noon’ になります。独自の拡張です。 '1 a.m.', '1:30 p.m.', 'midnight', 'noon', '12:30 p.m.'

r RFC 2822に従ったフォーマットの日時です。 'Thu, 21 Dec 2000 16:01:07 +0200'

s 秒です。 2 桁のゼロ詰めです。 '00' から '59'

S 月の中の日につける 2 文字の序数接尾辞です。 'st', 'nd', 'rd' or 'th'

t 月の日数です。 28 から 31

T 計算機のタイムゾーン設定です。 'EST', 'MDT'

U 実装されていません。

w 週の中の曜日です。ゼロ詰めしません。 '0' (Sunday) to '6' (Saturday)

W ISO-8601 に従った年の中の週番号です。週は月曜日から始まります。 1, 53

y 2 桁の年です。 '99'

Y 4 桁の年です。 '1999'

z 年の中の日 0 から 365

Z タイムゾーンオフセットを秒であらわしたものです。UTC よりも西側のタイムゾーン値は全て負の値になり、東側の値は常に正になります。 -43200 から 43200

フォーマット文字	説明	出力例
a	`'a.m.'` または `'p.m.'` (Associated Press に合わせるため、’.’ が入っている点が PHP と違います)。	`'a.m.'`
A	`'AM'` または `'PM'` です。	`'AM'`
b	3 文字の小文字で表した月名です。	`'jan'`
B	実装されていません。
d	月の中の日。 2 桁のゼロ詰めです。	`'01'` から `'31'`
D	週の中の日。 3 文字のテキスト形式です。	`'Fri'`
f	12 時間表記の時と分。ただし、ゼロ分の場合には表示しません。独自の拡張です。	`'1'`, `'1:30'`
F	月名を長いテキスト形式で表したものです。	`'January'`
g	12 時間表記の時。ゼロ詰めはしません。	`'1'` から `'12'`
G	24 時間表記の時。ゼロ詰めはしません。	`'0'` から `'23'`
h	12 時間表記の時です。	`'01'` から `'12'`
H	24 時間表記の時です。	`'00'` から `'23'`
i	分です。	`'00'` から `'59'`
I	実装されていません。
j	月の中の日。ゼロ詰めしません。	`'1'` から `'31'`
l	週の中の曜日。長いテキスト形式です。	`'Friday'`
L	閏年かどうかを表すブール値です。	`True` または `False`
m	月です。2 桁でゼロ詰めしたものです。	`'01'` から `'12'`
M	月です。3 文字のテキスト形式です。	`'Jan'`
n	月です。ゼロ詰めしません。	`'1'` から `'12'`
N	Associated Press スタイルの月の省略表記です。独自の拡張です。	`'Jan.'`, `'Feb.'`, `'March'`, `'May'`
O	グリニッジ標準時からの時差です。	`'+0200'`
P	時刻です。12 時間表記の時、分、そして ‘a.m.’/’p.m.’ です。分がゼロの場合には省略され、必要に応じて ‘midnight’ または ‘noon’ になります。独自の拡張です。	`'1 a.m.'`, `'1:30 p.m.'`, `'midnight'`, `'noon'`, `'12:30 p.m.'`
r	RFC 2822に従ったフォーマットの日時です。	`'Thu, 21 Dec 2000 16:01:07 +0200'`
s	秒です。 2 桁のゼロ詰めです。	`'00'` から `'59'`
S	月の中の日につける 2 文字の序数接尾辞です。	`'st'`, `'nd'`, `'rd'` or `'th'`
t	月の日数です。	`28` から `31`
T	計算機のタイムゾーン設定です。	`'EST'`, `'MDT'`
U	実装されていません。
w	週の中の曜日です。ゼロ詰めしません。	`'0'` (Sunday) to `'6'` (Saturday)
W	ISO-8601 に従った年の中の週番号です。週は月曜日から始まります。	`1`, `53`
y	2 桁の年です。	`'99'`
Y	4 桁の年です。	`'1999'`
z	年の中の日	`0` から `365`
Z	タイムゾーンオフセットを秒であらわしたものです。UTC よりも西側のタイムゾーン値は全て負の値になり、東側の値は常に正になります。	`-43200` から `43200`

例:

It is {% now "jS F Y H:i" %}

フォーマット文字列中で普通の文字列を使いたければ、バックスラッシュでエスケープできます。下の例では、”f” が時刻を表すフォーマット指定子として解釈されないようにエスケープしています。 “o” はフォーマット指定子ではないのでエスケープしていません:

It is the {% now "jS o\f F" %}

このテンプレートをレンダリングすると “It is the 4th of September” になります。

spaceless¶

ブロック内の HTML タグ間にある空白文字を除去します。タブ文字や改行も含みます。

使用例:

{% spaceless %}
    <p>
        <a href="foo/">Foo</a>
    </p>
{% endspaceless %}

上の例は下のような HTML になります:

<p><a href="foo/">Foo</a></p>

spaceless タグは タグ間の 空白だけが正規化されます。つまり、タグとテキストの間のスペースは正規化しません。下の例では Hello の周りの空白をはぎとりません:

{% spaceless %}
    <strong>
        Hello
    </strong>
{% endspaceless %}

ssi¶

指定したファイルの内容をページ内に取り込みます。

include タグと同様、 {% ssi %} は別のファイルの内容を取り込みます。引数は絶対パスで指定します:

{% ssi /home/html/ljworld.com/includes/right_generic.html %}

オプションの “parsed” パラメタを指定すると、取り込まれたファイルを現在のコンテキストのテンプレートコードとして評価します:

{% ssi /home/html/ljworld.com/includes/right_generic.html parsed %}

{% ssi %} を使う場合には、セキュリティの観点から、JSM7の設定に ALLOWED_INCLUDE_ROOTS を定義する必要があります。

templatetag¶

テンプレートタグの構成に使われる文字自体を出力します。下記に示す表のArgumnetを引数にとって使います:

{% templatetag Argument %}

Argument	Outputs
`openblock`	`{%`
`closeblock`	`%}`
`openvariable`	`{{`
`closevariable`	`}}`
`openbrace`	`{`
`closebrace`	`}`
`opencomment`	`{#`
`closecomment`	`#}`

widthratio¶

バーチャートなどを生成する場合のために、指定した値と最大値との比を計算し、定数に掛けた値を返します。

例えば:

<img src="bar.gif" height="10"
 width="{% widthratio this_value max_value 100 %}" />

のようにすると、 this_value が 175 で max_value が 200 の場合には、 (175/200 = .875; .875 * 100 = 87.5 で、88 に丸めた結果) 画像の幅は 88 ピクセルになります。

with¶

複雑な表記の変数の値をキャッシュします。また、簡単な名前で参照できるようにします。呼出しコストの高いメソッド (例えばデータベースを操作するようなメソッド) に何度もアクセスする際に便利です。

以下に例を示します:

{% with business.employees.count as total %}
    {{ total }} employee{{ total|pluralize }}
{% endwith %}

値を組み込んだ変数 (上の例でいえば total) は {% with %} と {% endwith %} タグの間でだけ使えます。

組み込みフィルタリファレンス¶

add¶

入力値に対して引数の値を加算します。

使用例:

{{ value|add:"2" }}

value が 4 なら、出力は 6 です。

addslashes¶

入力値のクオートの前にスラッシュを追加します。 CSV などの文字列をエスケープする際に利用します。

capfirst¶

入力値の先頭の文字を大文字に変換します。

center¶

入力値を引数に指定された幅のフィールド内に中央寄せします。

cut¶

入力値の中から引数に指定した値を全て除去します。

使用例:

{{ value|cut:" "}}

value が "String with spaces" なら、出力は "Stringwithspaces" になります。

date¶

引数に指定した書式で日付をフォーマットします。 (now タグと同じです)

使用例:

{{ value|date:"D d M Y" }}

value が datetime オブジェクト (例えば、 datetime.datetime.now() の戻り値) ならば、出力は文字列 'Wed 09 Jan 2008' になります。

フォーマットを指定しなかった場合、 JSM7設定ファイルの DATE_FORMAT の設定値が反映されます:

{{ value|date }}

default¶

入力の評価値が False の場合、引数に指定したデフォルト値を使います。そうでなければ、入力値を使います。

使用例:

{{ value|default:"nothing" }}

value が "" (空文字列)ならば、出力は nothing になります。

default_if_none¶

値が None の場合、かつその場合のみ、引数に指定したデフォルト値を使います。そうでなければ、入力値を使います。

空文字列を入力した場合には、デフォルト値を使わないので注意してください。空文字列をフォールバックしたければ default フィルタを使ってください。

使用例:

{{ value|default_if_none:"nothing" }}

value が None ならば、出力は文字列 "nothing" になります。

dictsort¶

辞書のリストを入力に取り、引数に指定したキーでリストをソートして返します。

使用例:

{{ value|dictsort:"name" }}

value が以下のようだったとします:

[
    {'name': 'zed', 'age': 19},
    {'name': 'amy', 'age': 22},
    {'name': 'joe', 'age': 31},
]

出力は以下のようになるでしょう。:

[
    {'name': 'amy', 'age': 22},
    {'name': 'joe', 'age': 31},
    {'name': 'zed', 'age': 19},
]

dictsortreversed¶

辞書のリストを入力に取り、引数に指定したキーでリストを逆順にソートして返します。上のフィルタと全く同じ処理をしますが、返す値は逆順です。

divisibleby¶

値を引数で除算できる場合に True を返します。

使用例:

{{ value|divisibleby:"3" }}

value が 21 なら、出力は True になります。

escape¶

入力文字中の HTML 特有の文字をエスケープします。具体的には、以下のように置換されます:

< は "<" に変換されます。

> は ">" に変換されます。

"'" (クオート) は ''' に変換されます。

'"' (二重クオート) は '"' に変換されます。

"&" は "&" に変換されます。

エスケープは最終的な文字列出力を生成する時に適用されます。従って、フィルタを連鎖している場合、連鎖のどこにフィルタが置かれていても、フィルタの最後の段階でエスケープ処理が行われます。エスケープを即座に適用したければ、 force_escape フィルタを使ってください。

すでに自動エスケープが施された変数に escape を適用しても、結果的には一度しかエスケープを行いません。従って、自動エスケープ環境で escape を呼び出しても問題はありません。意図的に複数回エスケープを施したければ、 force_escape フィルタを使ってください。

escapejs¶

JavaScript の文字列リテラルとして扱うために文字エスケープを行います。エスケープ結果は HTML としては安全 ではありません が、 JavaScrpt/JSON を生成するテンプレートの出力が構文エラーを引き起こすのを防げます。

filesizeformat¶

ファイルサイズを「目に優しい (human-readable)」表現 ('13 KB', '4.1 MB', '102 bytes' など) に変換します。

使用例:

{{ value|filesizeformat }}

value が 123456789 なら、出力は 117.7 MB になります。

first¶

リスト中の最初の要素を返します。

使用例:

{{ value|first }}

value がリスト ['a', 'b', 'c'] なら、出力は 'a' になります。

fix_ampersands¶

アンパサンド (“&”) を & エンティティで置き換えます。

使用例:

{{ value|fix_ampersands }}

value が Tom & Jerry なら、出力は Tom & Jerry になります。

floatformat¶

引数を指定せずに使うと、小数部がある場合に限り、浮動小数点数を小数点以下ひと桁でまるめます。例えば:

`value`	テンプレート	出力
`34.23234`	`{{ value\|floatformat }}`	`34.2`
`34.00000`	`{{ value\|floatformat }}`	`34`
`34.26000`	`{{ value\|floatformat }}`	`34.3`

整数の引数を指定すると、 floatformat は小数部を指定の桁数で丸めます。例えば:

`value`	テンプレート	出力
`34.23234`	`{{ value\|floatformat:3 }}`	`34.232`
`34.00000`	`{{ value\|floatformat:3 }}`	`34.000`
`34.26000`	`{{ value\|floatformat:3 }}`	`34.260`

floatformat の引数に負の数を指定した場合、小数部がある場合に限り、小数部を指定の桁数で丸めます。例えば:

`value`	テンプレート	出力
`34.23234`	`{{ value\|floatformat:"-3" }}`	`34.232`
`34.00000`	`{{ value\|floatformat:"-3" }}`	`34`
`34.26000`	`{{ value\|floatformat:"-3" }}`	`34.260`

従って、引数なしの floatformat は -1 を引数に指定した場合と同じになります。

force_escape¶

文字列に HTML エスケープを適用します。 (詳しくは escape フィルタを参照してください)。フィルタは 即座に 適用され、新たなエスケープ済みの文字列を返します。このタグが有用なケースは稀で、エスケープ済みの結果に対して他のフィルタを適用したいような、複数回エスケープが必要な場合に使われます。通常は escape フィルタを使います。

get_digit¶

入力が整数の場合、引数に指定した桁の数字を返します。 1 は右はじの桁、2 は右から 2 つ目の桁、といった具合に指定します。入力が整数でない場合には、入力値をそのまま返します。

使用例:

{{ value|get_digit:"2" }}

value が 123456789 なら、出力は 8 になります。

iriencode¶

IRI (国際化リソース識別子 Internationalized Resource Identifier) を URL 埋め込みに適した文字列に変換します。非 ASCII 文字列を URL に埋め込む場合に必要なフィルタです。

urlencode フィルタを通した文字列をこのフィルタに通しても問題はありません。

join¶

リストを文字列でつなぎます。

使用例:

{{ value|join:" // " }}

value がリスト ['a', 'b', 'c'] なら、出力は文字列 "a // b // c" になります。

last¶

リリースノートを参照してください

リストの末尾の要素を返します。

使用例:

{{ value|last }}

value がリスト ['a', 'b', 'c', 'd'] なら、出力は文字列 "d" になります。

length¶

入力値の長さを返します。文字列とリストいずれにも作用します。

使用例:

{{ value|length }}

value が ['a', 'b', 'c', 'd'] なら、出力は 4 になります。

length_is¶

入力値の長さと引数が等しければ True を返し、そうでなければ False を返します。

使用例:

{{ value|length_is:"4" }}

value が ['a', 'b', 'c', 'd'] なら、出力は True になります。

linebreaks¶

プレーンテキストの改行を適切な HTML タグに変換します。改行 1 つは HTML 改行 (<br />) タグ、改行と空行はパラグラフ改行 (<p>) に変換します。

使用例:

{{ value|linebreaks }}

value が Joel\nis a slug なら、出力は <p>Joel<br>is a slug</p> になります。

linebreaksbr¶

プレーンテキストの改行を HTML の改行 (<br />) タグに変換します。

linenumbers¶

テキストを行番号付きで表示します。

ljust¶

入力値を指定幅のフィールド内に左詰めします。

引数: フィールドの幅

lower¶

文字列を全て小文字に変換します。

使用例:

{{ value|lower }}

value が Still MAD At Yoko なら、出力は still mad at yoko になります。

make_list¶

入力値をリストに変換します。整数の場合には各桁の数字からなるリストに、文字列の場合は各文字からなるリストに変換します。

使用例:

{{ value|make_list }}

value が文字列 "Joel" なら、出力はリスト [u'J', u'o', u'e', u'l'] です。 value が 123 なら、出力はリスト [1, 2, 3] です。

phone2numeric¶

電話番号 (文字を含む場合もあります) を数値だけの番号に変換します。例えば、 '800-COLLECT' は '800-2655328' になります。

入力値は正しい電話番号でなくてもかまいません。このフィルタはどんな文字列でも変換します。

pluralize¶

値が 1 でない場合に、複数形を表す接尾辞を付けます。デフォルトでは、接尾辞は 's' です。

例:

You have {{ num_messages }} message{{ num_messages|pluralize }}.

's' 以外の接尾辞が必要な場合、フィルタのパラメタに指定できます。

例:

You have {{ num_walruses }} walrus{{ num_walrus|pluralize:"es" }}.

単なる接尾辞だけで複数形化できない場合、単数形と複数形の接尾辞の両方をコンマで区切って指定できます。

例:

You have {{ num_cherries }} cherr{{ num_cherries|pluralize:"y,ies" }}.

random¶

与えられたリストからランダムな要素を返します。

使用例:

{{ value|random }}

value がリスト ['a', 'b', 'c', 'd'] なら、出力は "b" かもしれません。

removetags¶

入力から引数に指定された [X]HTML タグを除去します。タグはスペースで区切って指定します。

使用例:

{{ value|removetags:"b span"|safe }}

value が "<b>Joel</b> <button>is</button> a <span>slug</span>" なら、出力は "Joel <button>is</button> a slug" になります。

rjust¶

指定幅のフィールドに右詰めします。

引数: フィールドの幅

safe¶

文字列に対して、さらなるエスケープが必要でないことをマークするのに使います。 autoescaping がオフの場合、このフィルタは何もしません。

slice¶

リストに対するスライスを返します。

例:

{{ some_list|slice:":2" }}

slugify¶

入力を小文字に変換し、語でない (英数字またはアンダースコアでない) 文字を除去し、スペースをハイフンに変換します。また、先頭と末尾の空白をはぎとります。

使用例:

{{ value|slugify }}

value が "Joel is a slug" なら、出力は "joel-is-a-slug" になります。

striptags¶

[X]HTML タグを全てはぎとります。

使用例:

{{ value|striptags }}

value が "<b>Joel</b> <button>is</button> a <span>slug</span>" なら、出力は "Joel is a slug" になります。

time¶

時刻を指定の書式でフォーマットします (now タグと同じです)。 time フィルタの引数は、時刻に関するフォーマット文字しか受け付けません。日付のフォーマットを行いたければ date フィルタを使ってください。

使用例:

{{ value|time:"H:i" }}

value が datetime.datetime.now() と同等な値なら、出力は文字列 "01:23" なります。

When used without a format string:

{{ value|time }}

...the formatting string defined in the TIME_FORMAT setting will be used.

timesince¶

日付を経過時間の形式にフォーマットします (例えば、 “4 days, 6 hours”) 。

オプションの引数として、比較対象として使う時刻をとります (引数を省略すると 現在時刻 を使います)。例えば、 blog_date が 1 June 2006 を表す日付オブジェクトで、 comment_date が 08:00 on 1 June 2006 を表す日時オブジェクトの場合、 {{ blog_date|timesince:comment_date }} は “8 hours” を返します。

Comparing offset-naive and offset-aware datetimes will return an empty string.

最小の単位は分で、比較対象の時刻より以前の時刻に対しては “0 minutes” を返します。

timeuntil¶

timesince に似ていますが、現在時刻から指定の日付または日時までの時刻を計算します。

例えば、現在の日付が 1 June 2006 で、 conference_date が 29 June 2006 の場合、 {{ conference_date|timeuntil }} は “4 weeks” を返します。

オプションの引数として、 (現在時刻 の代わりに) 比較対象として使う時刻をとります。例えば、 from_date が 22 June 2006 の場合、 {{ conference_date|timeuntil:from_date }} は “1 week” を返します。

オフセットつきの時刻とオフセットなしの時刻を比較すると、空の文字列を返します。

最小の単位は分で、比較対象の時刻より以前の時刻に対しては “0 minutes” を返します。

title¶

文字列をタイトルケースに変換します。

truncatewords¶

文字列を指定語数以下になるように切り詰めます。

引数: 文字列を切り詰めるまでの語数

使用例:

{{ value|truncatewords:2 }}

value が "Joel is a slug" なら、出力は "Joel is ..." になります。

truncatewords_html¶

truncatewords に似ていますが、 HTML タグを正しく扱えます。切り詰めを行う時点で閉じていないタグがあれば、切り詰めた文字の直後に全て閉じます。

このタグの処理は truncatewords よりもやや非効率なので、 HTML テキストを渡す場合にだけ使うようにしてください。

unordered_list¶

再帰的に入れ子になったリストを入力にとり、 HTML の無番号リスト (UL,unordered list) に変換します。 ただし、最も外側の <ul> タグは表示しません。

リストは適切な形式になっているものとみなします。例えば、 var が ['States', ['Kansas', ['Lawrence', 'Topeka'], 'Illinois']] であれば、 {{ var|unordered_list }} は以下のようになります:

<li>States
<ul>
        <li>Kansas
        <ul>
                <li>Lawrence</li>
                <li>Topeka</li>
        </ul>
        </li>
        <li>Illinois</li>
</ul>
</li>

ノート: 以前の、より杓子定規で冗長な形式、 ['States', [['Kansas', [['Lawrence', []], ['Topeka', []]]], ['Illinois',[]]]] も継続してサポートしています。

upper¶

入力値をすべて大文字に変換します。

使用例:

{{ value|upper }}

value が "Joel is a slug" なら、出力は "JOEL IS A SLUG" になります。

urlencode¶

入力値を URL で使えるようにエスケープします。

urlize¶

平文で書かれた URL をクリック可能なリンクに変換します。

HTML マークアップの入ったテキストに urlize を適用すると、予想通りの出力を得られない場合があるので注意してください。このフィルタは素のテキストに対してだけ使ってください。

使用例:

{{ value|urlize }}

value が "Check out www.djangoproject.com" なら、出力は "Check out <a href="http://www.djangoproject.com">www.djangoproject.com</a>" になります。

urlizetrunc¶

URL をクリック可能なリンクに変換します。このとき、指定の文字数以上の URL を切り詰めます。

urlize と同様、このフィルタは素のテキストに対してだけ使ってください。

引数: URL を切り詰める長さ

使用例:

{{ value|urlizetrunc:15 }}

value が "Check out www.djangoproject.com" なら、出力は 'Check out <a href="http://www.djangoproject.com">www.djangopr...</a>' になります。

wordcount¶

語数を返します。

wordwrap¶

指定した行幅で語列をラップします。

引数: テキストをラップするまでの語数

使用例:

{{ value|wordwrap:5 }}

value が Joel is a slug なら、出力はこうなります:

Joel
is a
slug

yesno¶

入力値 (真、偽、オプションで None) に応じて、引数に指定した文字のいずれかを返します。

入力値	引数	出力
`True`	`"yeah,no,maybe"`	`yeah`
`False`	`"yeah,no,maybe"`	`no`
`None`	`"yeah,no,maybe"`	`maybe`
`None`	`"yeah,no"`	`"no"` (None に対応する値がない場合は False 扱いになります)