Built-in template tags and filters | Django documentation (original) (raw)

This document describes Django’s built-in template tags and filters. It is recommended that you use the automatic documentation, if available, as this will also include documentation for any custom tags or filters installed.

Built-in tag reference¶

autoescape¶

Controls the current auto-escaping behavior. This tag takes either on oroff as an argument and that determines whether auto-escaping is in effect inside the block. The block is closed with an endautoescape ending tag.

Sample usage:

{% autoescape on %} {{ body }} {% endautoescape %}

When auto-escaping is in effect, all content derived from variables has HTML escaping applied before placing the result into the output (but after any filters are applied). This is equivalent to manually applying theescape filter to each variable.

The only exceptions are variables already marked as “safe” from escaping. Variables could be marked as “safe” by the code which populated the variable, by applying the safe or escape filters, or because it’s the result of a previous filter that marked the string as “safe”.

Within the scope of disabled auto-escaping, chaining filters, includingescape, may cause unexpected (but documented) results such as the following:

{% autoescape off %} {{ my_list|join:", "|escape }} {% endautoescape %}

The above code will output the joined elements of my_list unescaped. This is because the filter chaining sequence executes first join onmy_list (without applying escaping to each item since autoescape isoff), marking the result as safe. Subsequently, this safe result will be fed to escape filter, which does not apply a second round of escaping.

In order to properly escape every element in a sequence, use theescapeseq filter:

{% autoescape off %} {{ my_list|escapeseq|join:", " }} {% endautoescape %}

block¶

Defines a block that can be overridden by child templates. SeeTemplate inheritance for more information.

comment¶

Ignores everything between {% comment %} and {% endcomment %}. An optional note may be inserted in the first tag. For example, this is useful when commenting out code for documenting why the code was disabled.

Sample usage:

Rendered text with {{ pub_date|date:"c" }}

Commented out text with {{ create_date|date:"c" }}

comment tags cannot be nested.

csrf_token¶

This tag is used for CSRF protection, as described in the documentation forCross Site Request Forgeries.

cycle¶

Produces one of its arguments each time this tag is encountered. The first argument is produced on the first encounter, the second argument on the second encounter, and so forth. Once all arguments are exhausted, the tag cycles to the first argument and produces it again.

This tag is particularly useful in a loop:

{% for o in some_list %} ... {% endfor %}

The first iteration produces HTML that refers to class row1, the second torow2, the third to row1 again, and so on for each iteration of the loop.

You can use variables, too. For example, if you have two template variables,rowvalue1 and rowvalue2, you can alternate between their values like this:

{% for o in some_list %} ... {% endfor %}

Variables included in the cycle will be escaped. You can disable auto-escaping with:

{% for o in some_list %} ... {% endfor %}

You can mix variables and strings:

{% for o in some_list %} ... {% endfor %}

In some cases you might want to refer to the current value of a cycle without advancing to the next value. To do this, give the {% cycle %} tag a name, using “as”, like this:

{% cycle 'row1' 'row2' as rowcolors %}

From then on, you can insert the current value of the cycle wherever you’d like in your template by referencing the cycle name as a context variable. If you want to move the cycle to the next value independently of the originalcycle tag, you can use another cycle tag and specify the name of the variable. So, the following template:

would output:

You can use any number of values in a cycle tag, separated by spaces. Values enclosed in single quotes (') or double quotes (") are treated as string literals, while values without quotes are treated as template variables.

By default, when you use the as keyword with the cycle tag, the usage of {% cycle %} that initiates the cycle will itself produce the first value in the cycle. This could be a problem if you want to use the value in a nested loop or an included template. If you only want to declare the cycle but not produce the first value, you can add asilent keyword as the last keyword in the tag. For example:

{% for obj in some_list %} {% cycle 'row1' 'row2' as rowcolors silent %} {% include "subtemplate.html" %} {% endfor %}

This will output a list of <tr> elements with classalternating between row1 and row2. The subtemplate will have access to rowcolors in its context and the value will match the class of the <tr> that encloses it. If the silent keyword were to be omitted, row1 and row2 would be emitted as normal text, outside the<tr> element.

When the silent keyword is used on a cycle definition, the silence automatically applies to all subsequent uses of that specific cycle tag. The following template would output nothing, even though the second call to {% cycle %} doesn’t specify silent:

{% cycle 'row1' 'row2' as rowcolors silent %} {% cycle rowcolors %}

You can use the resetcycle tag to make a {% cycle %} tag restart from its first value when it’s next encountered.

debug¶

Outputs a whole load of debugging information, including the current context and imported modules. {% debug %} outputs nothing when the DEBUGsetting is False.

extends¶

Signals that this template extends a parent template.

This tag can be used in two ways:

• {% extends "base.html" %} (with quotes) uses the literal value"base.html" as the name of the parent template to extend.
• {% extends variable %} uses the value of variable. If the variable evaluates to a string, Django will use that string as the name of the parent template. If the variable evaluates to a Template object, Django will use that object as the parent template.

See Template inheritance for more information.

Normally the template name is relative to the template loader’s root directory. A string argument may also be a relative path starting with ./ or ../. For example, assume the following directory structure:

dir1/ template.html base2.html my/ base3.html base1.html

In template.html, the following paths would be valid:

{% extends "./base2.html" %} {% extends "../base1.html" %} {% extends "./my/base3.html" %}

filter¶

Filters the contents of the block through one or more filters. Multiple filters can be specified with pipes and filters can have arguments, just as in variable syntax.

Note that the block includes all the text between the filter andendfilter tags.

Sample usage:

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

Note

The escape and safe filters are not acceptable arguments. Instead, use the autoescape tag to manage autoescaping for blocks of template code.

firstof¶

Outputs the first argument variable that is not “false” (i.e. exists, is not empty, is not a false boolean value, and is not a zero numeric value). Outputs nothing if all the passed variables are “false”.

Sample usage:

{% firstof var1 var2 var3 %}

This is equivalent to:

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

You can also use a literal string as a fallback value in case all passed variables are False:

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

This tag auto-escapes variable values. You can disable auto-escaping with:

{% autoescape off %} {% firstof var1 var2 var3 "fallback value" %} {% endautoescape %}

Or if only some variables should be escaped, you can use:

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

You can use the syntax {% firstof var1 var2 var3 as value %} to store the output inside a variable.

for¶

Loops over each item in an array, making the item available in a context variable. For example, to display a list of athletes provided inathlete_list:

{% for athlete in athlete_list %}
• {{ athlete.name }}
{% endfor %}

You can loop over a list in reverse by using{% for obj in list reversed %}.

If you need to loop over a list of lists, you can unpack the values in each sublist into individual variables. For example, if your context contains a list of (x,y) coordinates called points, you could use the following to output the list of points:

{% for x, y in points %} There is a point at {{ x }},{{ y }} {% endfor %}

This can also be useful if you need to access the items in a dictionary. For example, if your context contained a dictionary data, the following would display the keys and values of the dictionary:

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

Keep in mind that for the dot operator, dictionary key lookup takes precedence over method lookup. Therefore if the data dictionary contains a key named'items', data.items will return data['items'] instead ofdata.items(). Avoid adding keys that are named like dictionary methods if you want to use those methods in a template (items, values, keys, etc.). Read more about the lookup order of the dot operator in thedocumentation of template variables.

The for loop sets a number of variables available within the loop:

Changed in Django Development version:

The variable forloop.length was added.

for … empty¶

The for tag can take an optional {% empty %} clause whose text is displayed if the given array is empty or could not be found:

{% for athlete in athlete_list %}
• {{ athlete.name }}
{% empty %}
• Sorry, no athletes in this list.
{% endfor %}

The above is equivalent to – but shorter, cleaner, and possibly faster than – the following:

{% if athlete_list %} {% for athlete in athlete_list %}
• {{ athlete.name }}
{% endfor %} {% else %}
• Sorry, no athletes in this list.
{% endif %}

if¶

The {% if %} tag evaluates a variable, and if that variable is “true” (i.e. exists, is not empty, and is not a false boolean value) the contents of the block are output:

{% if athlete_list %} Number of athletes: {{ athlete_list|length }} {% elif athlete_in_locker_room_list %} Athletes should be out of the locker room soon! {% else %} No athletes. {% endif %}

In the above, if athlete_list is not empty, the number of athletes will be displayed by the {{ athlete_list|length }} variable.

As you can see, the if tag may take one or several {% elif %}clauses, as well as an {% else %} clause that will be displayed if all previous conditions fail. These clauses are optional.

Boolean operators¶

if tags may use and, or or not to test a number of variables or to negate a given variable:

{% 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. {% endif %}

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

Use of both and and or clauses within the same tag is allowed, withand having higher precedence than or e.g.:

{% if athlete_list and coach_list or cheerleader_list %}

will be interpreted like:

if (athlete_list and coach_list) or cheerleader_list: ...

Use of actual parentheses in the if tag is invalid syntax. If you need them to indicate precedence, you should use nested if tags.

if tags may also use the operators ==, !=, <, >,<=, >=, in, not in, is, and is not which work as follows:

== operator¶

Equality. Example:

{% if somevar == "x" %} This appears if variable somevar equals the string "x" {% endif %}

!= operator¶

Inequality. Example:

{% if somevar != "x" %} This appears if variable somevar does not equal the string "x", or if somevar is not found in the context {% endif %}

< operator¶

Less than. Example:

{% if somevar < 100 %} This appears if variable somevar is less than 100. {% endif %}

> operator¶

Greater than. Example:

{% if somevar > 0 %} This appears if variable somevar is greater than 0. {% endif %}

<= operator¶

Less than or equal to. Example:

{% if somevar <= 100 %} This appears if variable somevar is less than 100 or equal to 100. {% endif %}

>= operator¶

Greater than or equal to. Example:

{% if somevar >= 1 %} This appears if variable somevar is greater than 1 or equal to 1. {% endif %}

in operator¶

Contained within. This operator is supported by many Python containers to test whether the given value is in the container. The following are some examples of how x in y will be interpreted:

{% if "bc" in "abcdef" %} This appears since "bc" is a substring of "abcdef" {% endif %}

{% if "hello" in greetings %} If greetings is a list or set, one element of which is the string "hello", this will appear. {% endif %}

{% if user in users %} If users is a QuerySet, this will appear if user is an instance that belongs to the QuerySet. {% endif %}

not in operator¶

Not contained within. This is the negation of the in operator.

is operator¶

Object identity. Tests if two values are the same object. Example:

{% if somevar is True %} This appears if and only if somevar is True. {% endif %}

{% if somevar is None %} This appears if somevar is None, or if somevar is not found in the context. {% endif %}

is not operator¶

Negated object identity. Tests if two values are not the same object. This is the negation of the is operator. Example:

{% if somevar is not True %} This appears if somevar is not True, or if somevar is not found in the context. {% endif %}

{% if somevar is not None %} This appears if and only if somevar is not None. {% endif %}

Filters¶

You can also use filters in the if expression. For example:

{% if messages|length >= 100 %} You have lots of messages today! {% endif %}

Complex expressions¶

All of the above can be combined to form complex expressions. For such expressions, it can be important to know how the operators are grouped when the expression is evaluated - that is, the precedence rules. The precedence of the operators, from lowest to highest, is as follows:

• or
• and
• not
• in
• ==, !=, <, >, <=, >=

(This follows Python exactly). So, for example, the following complexif tag:

{% if a == b or c == d and e %}

…will be interpreted as:

(a == b) or ((c == d) and e)

If you need different precedence, you will need to use nested if tags. Sometimes that is better for clarity anyway, for the sake of those who do not know the precedence rules.

The comparison operators cannot be ‘chained’ like in Python or in mathematical notation. For example, instead of using:

{% if a > b > c %} (WRONG)

you should use:

ifchanged¶

Check if a value has changed from the last iteration of a loop.

The {% ifchanged %} block tag is used within a loop. It has two possible uses.

1. Checks its own rendered contents against its previous state and only displays the content if it has changed. For example, this displays a list of days, only displaying the month if it changes:

   Archive for {{ year }}

   {% for date in days %} {% ifchanged %}

   {{ date|date:"F" }}

   {% endifchanged %} {{ date|date:"j" }} {% endfor %}
2. If given one or more variables, check whether any variable has changed. For example, the following shows the date every time it changes, while showing the hour if either the hour or the date has changed:
   {% for date in days %}
   {% ifchanged date.date %} {{ date.date }} {% endifchanged %}
   {% ifchanged date.hour date.date %}
   {{ date.hour }}
   {% endifchanged %}
   {% endfor %}

The ifchanged tag can also take an optional {% else %} clause that will be displayed if the value has not changed:

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

include¶

Loads a template and renders it with the current context. This is a way of “including” other templates within a template.

The template name can either be a variable or a hardcoded (quoted) string, in either single or double quotes.

This example includes the contents of the template "foo/bar.html":

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

Normally the template name is relative to the template loader’s root directory. A string argument may also be a relative path starting with ./ or ../as described in the extends tag.

This example includes the contents of the template whose name is contained in the variable template_name:

{% include template_name %}

The variable may also be any object with a render() method that accepts a context. This allows you to reference a compiled Template in your context.

Additionally, the variable may be an iterable of template names, in which case the first that can be loaded will be used, as perselect_template().

An included template is rendered within the context of the template that includes it. This example produces the output "Hello, John!":

• Context: variable person is set to "John" and variable greetingis set to "Hello".
• Template:
  {% include "name_snippet.html" %}
• The name_snippet.html template:
  {{ greeting }}, {{ person|default:"friend" }}!

You can pass additional context to the template using keyword arguments:

{% include "name_snippet.html" with person="Jane" greeting="Hello" %}

If you want to render the context only with the variables provided (or even no variables at all), use the only option. No other variables are available to the included template:

{% include "name_snippet.html" with greeting="Hi" only %}

Note

The include tag should be considered as an implementation of “render this subtemplate and include the HTML”, not as “parse this subtemplate and include its contents as if it were part of the parent”. This means that there is no shared state between included templates – each include is a completely independent rendering process.

Blocks are evaluated before they are included. This means that a template that includes blocks from another will contain blocks that have already been evaluated and rendered - not blocks that can be overridden by, for example, an extending template.

load¶

Loads a custom template tag set.

For example, the following template would load all the tags and filters registered in somelibrary and otherlibrary located in packagepackage:

{% load somelibrary package.otherlibrary %}

You can also selectively load individual filters or tags from a library, using the from argument. In this example, the template tags/filters named fooand bar will be loaded from somelibrary:

{% load foo bar from somelibrary %}

See Custom tag and filter libraries for more information.

lorem¶

Displays random “lorem ipsum” Latin text. This is useful for providing sample data in templates.

Usage:

{% lorem [count] [method] [random] %}

The {% lorem %} tag can be used with zero, one, two or three arguments. The arguments are:

Examples:

• {% lorem %} will output the common “lorem ipsum” paragraph.
• {% lorem 3 p %} will output the common “lorem ipsum” paragraph and two random paragraphs each wrapped in HTML <p> tags.
• {% lorem 2 w random %} will output two random Latin words.

now¶

Displays the current date and/or time, using a format according to the given string. Such string can contain format specifiers characters as described in the date filter section.

Example:

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

Note that you can backslash-escape a format string if you want to use the “raw” value. In this example, both “o” and “f” are backslash-escaped, because otherwise each is a format string that displays the year and the time, respectively:

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

This would display as “It is the 4th of September”.

You can also use the syntax {% now "Y" as current_year %} to store the output (as a string) inside a variable. This is useful if you want to use{% now %} inside a template tag like blocktranslate for example:

{% now "Y" as current_year %} {% blocktranslate %}Copyright {{ current_year }}{% endblocktranslate %}

querystring¶

Outputs a URL-encoded formatted query string based on the provided parameters.

This tag accepts positional arguments, which must be mappings (such asQueryDict or dict). If no positional arguments are provided, request.GET is used as the default to construct the query string.

Positional arguments are processed sequentially, while keyword arguments are treated as key-value pairs, applied last. Later arguments take precedence over earlier ones, ensuring the most recent pairs are reflected in the final result.

The result always includes a leading "?" since this tag is mainly used for links, and an empty result could prevent the page from reloading as expected.

Using request.GET as default

To use request.GET as the default QueryDict instance, thedjango.template.context_processors.request context processor should be enabled. If it’s not enabled, you must either explicitly pass therequest object into the template context, or provide a QueryDictinstance to this tag.

Changed in Django Development version:

A ? was prepended to the query string for empty results.

Basic usage¶

Outputs the current query string verbatim. So if the query string in the request is ?color=green, the output would be ?color=green. If the current query string is empty, the output will be ?.

{% querystring size="M" %}

Outputs the current query string with the addition of the size parameter. Following the previous example, the output would be ?color=green&size=M.

Setting items¶

{% querystring color="red" size="S" %}

Adds or modifies parameters in the query string. Each keyword argument will be added to the query string, replacing any existing value for that key. For instance, if the current query string is ?color=green, the output will be?color=red&size=S.

Removing items¶

{% querystring color=None %}

Passing None as the value removes the parameter from the query string. For example, if the current query string is ?color=green&size=M, the output will be ?size=M.

Handling lists¶

{% querystring color=my_list %}

If my_list is ["red", "blue"], the output will be?color=red&color=blue, preserving the list structure in the query string.

Customizing the base QueryDict¶

You can pass custom QueryDict or dict instances as positional arguments to replace request.GET. When multiple arguments are provided, key-value pairs from later arguments take precedence over earlier ones.

For example, if my_query_dict is <QueryDict: {'color': ['blue'], 'size': ['S']}> and my_dict is {'color': 'orange', 'fabric': 'silk', 'type': 'dress'}, this outputs ?color=orange&size=S&fabric=silk.

{% querystring my_query_dict my_dict size="S" type=None %}

If all keys are removed by setting them to None, this outputs ?:

{% querystring my_query_dict my_dict color=None size=None fabric=None type=None %}

Similarly, if all positional arguments are empty and keyword arguments do not contribute any new params, the output will also be ?.

Changed in Django Development version:

Support for multiple positional mapping arguments was added.

Dynamic usage¶

A common example of using this tag is to preserve the current query string when displaying a page of results, while adding a link to the next and previous pages of results. For example, if the paginator is currently on page 3, and the current query string is ?color=blue&size=M&page=3, the following code would output ?color=blue&size=M&page=4:

{% querystring page=page.next_page_number %}

You can also store the value in a variable. For example, if you need multiple links to the same page, define it as:

{% querystring page=page.next_page_number as next_page %}

regroup¶

Regroups a list of alike objects by a common attribute.

This complex tag is best illustrated by way of an example: say that citiesis a list of cities represented by dictionaries containing "name","population", and "country" keys:

cities = [ {"name": "Mumbai", "population": "19,000,000", "country": "India"}, {"name": "Calcutta", "population": "15,000,000", "country": "India"}, {"name": "New York", "population": "20,000,000", "country": "USA"}, {"name": "Chicago", "population": "7,000,000", "country": "USA"}, {"name": "Tokyo", "population": "33,000,000", "country": "Japan"}, ]

…and you’d like to display a hierarchical list that is ordered by country, like this:

• India
  • Mumbai: 19,000,000
  • Calcutta: 15,000,000
• USA
  • New York: 20,000,000
  • Chicago: 7,000,000
• Japan
  • Tokyo: 33,000,000

You can use the {% regroup %} tag to group the list of cities by country. The following snippet of template code would accomplish this:

{% regroup cities by country as country_list %}

{% for country in country_list %}
• {{ country.grouper }}
  {% for city in country.list %}
  • {{ city.name }}: {{ city.population }}
  {% endfor %}
{% endfor %}

Let’s walk through this example. {% regroup %} takes three arguments: the list you want to regroup, the attribute to group by, and the name of the resulting list. Here, we’re regrouping the cities list by the countryattribute and calling the result country_list.

{% regroup %} produces a list (in this case, country_list) ofgroup objects. Group objects are instances ofnamedtuple() with two fields:

• grouper – the item that was grouped by (e.g., the string “India” or “Japan”).
• list – a list of all items in this group (e.g., a list of all cities with country=’India’).

Because {% regroup %} produces namedtuple() objects, you can also write the previous example as:

{% regroup cities by country as country_list %}

{% for country, local_cities in country_list %}
• {{ country }}
  {% for city in local_cities %}
  • {{ city.name }}: {{ city.population }}
  {% endfor %}
{% endfor %}

Note that {% regroup %} does not order its input! Our example relies on the fact that the cities list was ordered by country in the first place. If the cities list did not order its members by country, the regrouping would naively display more than one group for a single country. For example, say the cities list was set to this (note that the countries are not grouped together):

cities = [ {"name": "Mumbai", "population": "19,000,000", "country": "India"}, {"name": "New York", "population": "20,000,000", "country": "USA"}, {"name": "Calcutta", "population": "15,000,000", "country": "India"}, {"name": "Chicago", "population": "7,000,000", "country": "USA"}, {"name": "Tokyo", "population": "33,000,000", "country": "Japan"}, ]

With this input for cities, the example {% regroup %} template code above would result in the following output:

• India
  • Mumbai: 19,000,000
• USA
  • New York: 20,000,000
• India
  • Calcutta: 15,000,000
• USA
  • Chicago: 7,000,000
• Japan
  • Tokyo: 33,000,000

The easiest solution to this gotcha is to make sure in your view code that the data is ordered according to how you want to display it.

Another solution is to sort the data in the template using thedictsort filter, if your data is in a list of dictionaries:

{% regroup cities|dictsort:"country" by country as country_list %}

Grouping on other properties¶

Any valid template lookup is a legal grouping attribute for the regroup tag, including methods, attributes, dictionary keys and list items. For example, if the “country” field is a foreign key to a class with an attribute “description,” you could use:

{% regroup cities by country.description as country_list %}

Or, if country is a field with choices, it will have aget_FOO_display() method available as an attribute, allowing you to group on the display string rather than thechoices key:

{% regroup cities by get_country_display as country_list %}

{{ country.grouper }} will now display the value fields from thechoices set rather than the keys.

resetcycle¶

Resets a previous cycle so that it restarts from its first item at its next encounter. Without arguments, {% resetcycle %} will reset the last{% cycle %} defined in the template.

Example usage:

{% for coach in coach_list %}

{{ coach.name }}

{{ athlete.name }}

This example would return this HTML:

Gareth

Harry

John

Nick

John

Andrea

Melissa

Notice how the first block ends with class="odd" and the new one starts with class="odd". Without the {% resetcycle %} tag, the second block would start with class="even".

You can also reset named cycle tags:

{% for item in list %}

{{ item.data }}

{{ item.category }}

In this example, we have both the alternating odd/even rows and a “major” row every fifth row. Only the five-row cycle is reset when a category changes.

spaceless¶

Removes whitespace between HTML tags. This includes tab characters and newlines.

Example usage:

{% spaceless %}

Foo

This example would return this HTML:

Foo

Only space between tags is removed – not space between tags and text. In this example, the space around Hello won’t be stripped:

{% spaceless %} Hello {% endspaceless %}

templatetag¶

Outputs one of the syntax characters used to compose template tags.

The template system has no concept of “escaping” individual characters. However, you can use the {% templatetag %} tag to display one of the template tag character combinations.

The argument tells which template bit to output:

Sample usage:

The {% templatetag openblock %} characters open a block.

See also the verbatim tag for another way of including these characters.

url¶

Returns an absolute path reference (a URL without the domain name) matching a given view and optional parameters. Any special characters in the resulting path will be encoded using iri_to_uri().

This is a way to output links without violating the DRY principle by having to hardcode URLs in your templates:

{% url 'some-url-name' v1 v2 %}

The first argument is a URL pattern name. It can be a quoted literal or any other context variable. Additional arguments are optional and should be space-separated values that will be used as arguments in the URL. The example above shows passing positional arguments. Alternatively you may use keyword syntax:

{% url 'some-url-name' arg1=v1 arg2=v2 %}

Do not mix both positional and keyword syntax in a single call. All arguments required by the URLconf should be present.

For example, suppose you have a view, app_views.client, whose URLconf takes a client ID (here, client() is a method inside the views fileapp_views.py). The URLconf line might look like this:

path("client/int:id/", app_views.client, name="app-views-client")

If this app’s URLconf is included into the project’s URLconf under a path such as this:

path("clients/", include("project_name.app_name.urls"))

…then, in a template, you can create a link to this view like this:

{% url 'app-views-client' client.id %}

The template tag will output the string /clients/client/123/.

Note that if the URL you’re reversing doesn’t exist, you’ll get anNoReverseMatch exception raised, which will cause your site to display an error page.

If you’d like to retrieve a URL without displaying it, you can use a slightly different call:

{% url 'some-url-name' arg arg2 as the_url %}

I'm linking to {{ the_url }}

The scope of the variable created by the as var syntax is the{% block %} in which the {% url %} tag appears.

This {% url ... as var %} syntax will not cause an error if the view is missing. In practice you’ll use this to link to views that are optional:

{% url 'some-url-name' as the_url %} {% if the_url %} Link to optional stuff {% endif %}

If you’d like to retrieve a namespaced URL, specify the fully qualified name:

{% url 'myapp:view-name' %}

This will follow the normal namespaced URL resolution strategy, including using any hints provided by the context as to the current application.

Warning

Don’t forget to put quotes around the URL pattern name, otherwise the value will be interpreted as a context variable!

verbatim¶

Stops the template engine from rendering the contents of this block tag.

A common use is to allow a JavaScript template layer that collides with Django’s syntax. For example:

{% verbatim %} {{if dying}}Still alive.{{/if}} {% endverbatim %}

You can also designate a specific closing tag, allowing the use of{% endverbatim %} as part of the unrendered contents:

{% verbatim myblock %} Avoid template rendering via the {% verbatim %}{% endverbatim %} block. {% endverbatim myblock %}

widthratio¶

For creating bar charts and such, this tag calculates the ratio of a given value to a maximum value, and then applies that ratio to a constant.

For example:

If this_value is 175, max_value is 200, and max_width is 100, the image in the above example will be 88 pixels wide (because 175/200 = .875; .875 * 100 = 87.5 which is rounded up to 88).

In some cases you might want to capture the result of widthratio in a variable. It can be useful, for instance, in a blocktranslate like this:

{% widthratio this_value max_value max_width as width %} {% blocktranslate %}The width is: {{ width }}{% endblocktranslate %}

with¶

Caches a complex variable under a simpler name. This is useful when accessing an “expensive” method (e.g., one that hits the database) multiple times.

For example:

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

The populated variable (in the example above, total) is only available between the {% with %} and {% endwith %} tags.

You can assign more than one context variable:

{% with alpha=1 beta=2 %} ... {% endwith %}

Note

The previous more verbose format is still supported:{% with business.employees.count as total %}

Built-in filter reference¶

add¶

Adds the argument to the value.

For example:

If value is 4, then the output will be 6.

This filter will first try to coerce both values to integers. If this fails, it’ll attempt to add the values together anyway. This will work on some data types (strings, list, etc.) and fail on others. If it fails, the result will be an empty string.

For example, if we have:

and first is [1, 2, 3] and second is [4, 5, 6], then the output will be [1, 2, 3, 4, 5, 6].

Warning

Strings that can be coerced to integers will be summed, not concatenated, as in the first example above.

addslashes¶

Adds slashes before quotes. Useful for escaping strings in CSV, for example.

For example:

If value is "I'm using Django", the output will be"I\'m using Django".

capfirst¶

Capitalizes the first character of the value. If the first character is not a letter, this filter has no effect.

For example:

If value is "django", the output will be "Django".

center¶

Centers the value in a field of a given width.

For example:

"{{ value|center:"15" }}"

If value is "Django", the output will be " Django ".

cut¶

Removes all values of arg from the given string.

For example:

If value is "String with spaces", the output will be"Stringwithspaces".

date¶

Formats a date according to the given format.

Uses a similar format to PHP’s date() function with some differences.

Note

These format characters are not used in Django outside of templates. They were designed to be compatible with PHP to ease transitioning for designers.

Available format strings:

For example:

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

If value is a datetime object (e.g., the result ofdatetime.datetime.now()), the output will be the string'Wed 09 Jan 2008'.

The format passed can be one of the predefined ones DATE_FORMAT,DATETIME_FORMAT, SHORT_DATE_FORMAT orSHORT_DATETIME_FORMAT, or a custom format that uses the format specifiers shown in the table above. Note that predefined formats may vary depending on the current locale.

Assuming that LANGUAGE_CODE is, for example, "es", then for:

{{ value|date:"SHORT_DATE_FORMAT" }}

the output would be the string "09/01/2008" (the "SHORT_DATE_FORMAT"format specifier for the es locale as shipped with Django is "d/m/Y").

When used without a format string, the DATE_FORMAT format specifier is used. Assuming the same settings as the previous example:

outputs 9 de Enero de 2008 (the DATE_FORMAT format specifier for thees locale is r'j \d\e F \d\e Y'). Both “d” and “e” are backslash-escaped, because otherwise each is a format string that displays the day and the timezone name, respectively.

You can combine date with the time filter to render a full representation of a datetime value. E.g.:

{{ value|date:"D d M Y" }} {{ value|time:"H:i" }}

default¶

If value evaluates to False, uses the given default. Otherwise, uses the value.

For example:

{{ value|default:"nothing" }}

If value is "" (the empty string), the output will be nothing.

default_if_none¶

If (and only if) value is None, uses the given default. Otherwise, uses the value.

Note that if an empty string is given, the default value will not be used. Use the default filter if you want to fallback for empty strings.

For example:

{{ value|default_if_none:"nothing" }}

If value is None, the output will be nothing.

dictsort¶

Takes a list of dictionaries and returns that list sorted by the key given in the argument.

For example:

{{ value|dictsort:"name" }}

If value is:

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

then the output would be:

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

You can also do more complicated things like:

{% for book in books|dictsort:"author.age" %} * {{ book.title }} ({{ book.author.name }}) {% endfor %}

If books is:

[ {"title": "1984", "author": {"name": "George", "age": 45}}, {"title": "Timequake", "author": {"name": "Kurt", "age": 75}}, {"title": "Alice", "author": {"name": "Lewis", "age": 33}}, ]

then the output would be:

• Alice (Lewis)
• 1984 (George)
• Timequake (Kurt)

dictsort can also order a list of lists (or any other object implementing__getitem__()) by elements at specified index. For example:

If value is:

[ ("a", "42"), ("c", "string"), ("b", "foo"), ]

then the output would be:

[ ("a", "42"), ("b", "foo"), ("c", "string"), ]

You must pass the index as an integer rather than a string. The following produce empty output:

{{ values|dictsort:"0" }}

Ordering by elements at specified index is not supported on dictionaries.

dictsortreversed¶

Takes a list of dictionaries and returns that list sorted in reverse order by the key given in the argument. This works exactly the same as the above filter, but the returned value will be in reverse order.

divisibleby¶

Returns True if the value is divisible by the argument.

For example:

{{ value|divisibleby:"3" }}

If value is 21, the output would be True.

escape¶

Escapes a string’s HTML. Specifically, it makes these replacements:

• < is converted to <
• > is converted to >
• ' (single quote) is converted to '
• " (double quote) is converted to "
• & is converted to &

Applying escape to a variable that would normally have auto-escaping applied to the result will only result in one round of escaping being done. So it is safe to use this function even in auto-escaping environments. If you want multiple escaping passes to be applied, use the force_escape filter.

For example, you can apply escape to fields when autoescape is off:

{% autoescape off %} {{ title|escape }} {% endautoescape %}

Chaining escape with other filters

As mentioned in the autoescape section, when filters includingescape are chained together, it can result in unexpected outcomes if preceding filters mark a potentially unsafe string as safe due to the lack of escaping caused by autoescape being off.

In such cases, chaining escape would not reescape strings that have already been marked as safe.

This is especially important when using filters that operate on sequences, for example join. If you need to escape each element in a sequence, use the dedicated escapeseq filter.

escapejs¶

Escapes characters for use as a whole JavaScript string literal, within single or double quotes, as below. This filter does not make the string safe for use in “JavaScript template literals” (the JavaScript backtick syntax). Any other uses not listed above are not supported. It is generally recommended that data should be passed using HTML data- attributes, or the json_scriptfilter, rather than in embedded JavaScript.

For example:

The resulting data can be accessed in JavaScript like this:

const value = JSON.parse(document.getElementById('hello-data').textContent);

XSS attacks are mitigated by escaping the characters “<”, “>” and “&”. For example if value is {'hello': 'world</script>&amp;'}, the output is:

This is compatible with a strict Content Security Policy that prohibits in-page script execution. It also maintains a clean separation between passive data and executable code.

last¶

Returns the last item in a list.

For example:

If value is the list ['a', 'b', 'c', 'd'], the output will be the string "d".

length¶

Returns the length of the value. This works for both strings and lists.

For example:

If value is ['a', 'b', 'c', 'd'] or "abcd", the output will be4.

The filter returns 0 for an undefined variable.

linebreaks¶

Replaces line breaks in plain text with appropriate HTML; a single newline becomes an HTML line break (<br>) and a new line followed by a blank line becomes a paragraph break (</p>).

For example:

If value is Joel\nis a slug, the output will be <p>Joel<br>is a slug</p>.

linebreaksbr¶

Converts all newlines in a piece of plain text to HTML line breaks (<br>).

For example:

If value is Joel\nis a slug, the output will be Joel<br>is a slug.

linenumbers¶

Displays text with line numbers.

For example:

If value is:

the output will be:

ljust¶

Left-aligns the value in a field of a given width.

Argument: field size

For example:

If value is Django, the output will be "Django ".

lower¶

Converts a string into all lowercase.

For example:

If value is Totally LOVING this Album!, the output will betotally loving this album!.

make_list¶

Returns the value turned into a list. For a string, it’s a list of characters. For an integer, the argument is cast to a string before creating a list.

For example:

If value is the string "Joel", the output would be the list['J', 'o', 'e', 'l']. If value is 123, the output will be the list ['1', '2', '3'].

phone2numeric¶

Converts a phone number (possibly containing letters) to its numerical equivalent.

The input doesn’t have to be a valid phone number. This will happily convert any string.

For example:

{{ value|phone2numeric }}

If value is 800-COLLECT, the output will be 800-2655328.

pluralize¶

Returns a plural suffix if the value is not 1, '1', or an object of length 1. By default, this suffix is 's'.

Example:

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

If num_messages is 1, the output will be You have 1 message.If num_messages is 2 the output will be You have 2 messages.

For words that require a suffix other than 's', you can provide an alternate suffix as a parameter to the filter.

Example:

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

For words that don’t pluralize by simple suffix, you can specify both a singular and plural suffix, separated by a comma.

Example:

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

pprint¶

A wrapper around pprint.pprint() – for debugging, really.

random¶

Returns a random item from the given list.

For example:

If value is the list ['a', 'b', 'c', 'd'], the output could be "b".

rjust¶

Right-aligns the value in a field of a given width.

Argument: field size

For example:

If value is Django, the output will be " Django".

safe¶

Marks a string as not requiring further HTML escaping prior to output. When autoescaping is off, this filter has no effect.

Note

If you are chaining filters, a filter applied after safe can make the contents unsafe again. For example, the following code prints the variable as is, unescaped:

safeseq¶

Applies the safe filter to each element of a sequence. Useful in conjunction with other filters that operate on sequences, such asjoin. For example:

{{ some_list|safeseq|join:", " }}

You couldn’t use the safe filter directly in this case, as it would first convert the variable into a string, rather than working with the individual elements of the sequence.

slice¶

Returns a slice of the list.

Uses the same syntax as Python’s list slicing. See the Python documentation for an introduction.

Example:

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

If some_list is ['a', 'b', 'c'], the output will be ['a', 'b'].

slugify¶

Converts to ASCII. Converts spaces to hyphens. Removes characters that aren’t alphanumerics, underscores, or hyphens. Converts to lowercase. Also strips leading and trailing whitespace.

For example:

If value is "Joel is a slug", the output will be "joel-is-a-slug".

stringformat¶

Formats the variable according to the argument, a string formatting specifier. This specifier uses the printf-style String Formatting syntax, with the exception that the leading “%” is dropped.

For example:

{{ value|stringformat:"E" }}

If value is 10, the output will be 1.000000E+01.

striptags¶

Makes all possible efforts to strip all [X]HTML tags.

For example:

If value is "<b>Joel</b> <button>is</button> a <span>slug</span>", the output will be "Joel is a slug".

No safety guarantee

Note that striptags doesn’t give any guarantee about its output being HTML safe, particularly with non valid HTML input. So NEVER apply thesafe filter to a striptags output. If you are looking for something more robust, consider using a third-party HTML sanitizing tool.

time¶

Formats a time according to the given format.

Given format can be the predefined one TIME_FORMAT, or a custom format, same as the date filter. Note that the predefined format is locale-dependent.

For example:

If value is equivalent to datetime.datetime.now(), the output will be the string "01:23".

Note that you can backslash-escape a format string if you want to use the “raw” value. In this example, both “h” and “m” are backslash-escaped, because otherwise each is a format string that displays the hour and the month, respectively:

{{ value|time:"H\h i\m" }}

This would display as “01h 23m”.

Another example:

Assuming that LANGUAGE_CODE is, for example, "de", then for:

{{ value|time:"TIME_FORMAT" }}

the output will be the string "01:23" (The "TIME_FORMAT" format specifier for the de locale as shipped with Django is "H:i").

The time filter will only accept parameters in the format string that relate to the time of day, not the date. If you need to format a datevalue, use the date filter instead (or along with time if you need to render a full datetime value).

There is one exception the above rule: When passed a datetime value with attached timezone information (a time-zone-aware datetime instance) the time filter will accept the timezone-related format specifiers 'e', 'O' , 'T' and 'Z'.

When used without a format string, the TIME_FORMAT format specifier is used:

is the same as:

{{ value|time:"TIME_FORMAT" }}

timesince¶

Formats a date as the time since that date (e.g., “4 days, 6 hours”).

Takes an optional argument that is a variable containing the date to use as the comparison point (without the argument, the comparison point is now). For example, if blog_date is a date instance representing midnight on 1 June 2006, and comment_date is a date instance for 08:00 on 1 June 2006, then the following would return “8 hours”:

{{ blog_date|timesince:comment_date }}

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

Minutes is the smallest unit used, and “0 minutes” will be returned for any date that is in the future relative to the comparison point.

timeuntil¶

Similar to timesince, except that it measures the time from now until the given date or datetime. For example, if today is 1 June 2006 andconference_date is a date instance holding 29 June 2006, then{{ conference_date|timeuntil }} will return “4 weeks”.

Takes an optional argument that is a variable containing the date to use as the comparison point (instead of now). If from_date contains 22 June 2006, then the following will return “1 week”:

{{ conference_date|timeuntil:from_date }}

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

Minutes is the smallest unit used, and “0 minutes” will be returned for any date that is in the past relative to the comparison point.

title¶

Converts a string into titlecase by making words start with an uppercase character and the remaining characters lowercase. This tag makes no effort to keep “trivial words” in lowercase.

For example:

If value is "my FIRST post", the output will be "My First Post".

truncatechars¶

Truncates a string if it is longer than the specified number of characters. Truncated strings will end with a translatable ellipsis character (”…”).

Argument: Number of characters to truncate to

For example:

{{ value|truncatechars:7 }}

If value is "Joel is a slug", the output will be "Joel i…".

truncatechars_html¶

Similar to truncatechars, except that it is aware of HTML tags. Any tags that are opened in the string and not closed before the truncation point are closed immediately after the truncation.

For example:

{{ value|truncatechars_html:7 }}

If value is "<p>Joel is a slug</p>", the output will be"<p>Joel i…</p>".

Newlines in the HTML content will be preserved.

Size of input string

Processing large, potentially malformed HTML strings can be resource-intensive and impact service performance. truncatechars_htmllimits input to the first five million characters.

truncatewords¶

Truncates a string after a certain number of words.

Argument: Number of words to truncate after

For example:

{{ value|truncatewords:2 }}

If value is "Joel is a slug", the output will be "Joel is …".

Newlines within the string will be removed.

truncatewords_html¶

Similar to truncatewords, except that it is aware of HTML tags. Any tags that are opened in the string and not closed before the truncation point, are closed immediately after the truncation.

This is less efficient than truncatewords, so should only be used when it is being passed HTML text.

For example:

{{ value|truncatewords_html:2 }}

If value is "<p>Joel is a slug</p>", the output will be"<p>Joel is …</p>".

Newlines in the HTML content will be preserved.

Size of input string

Processing large, potentially malformed HTML strings can be resource-intensive and impact service performance. truncatewords_htmllimits input to the first five million characters.

unordered_list¶

Recursively takes a self-nested list and returns an HTML unordered list – WITHOUT opening and closing <ul> tags.

The list is assumed to be in the proper format. For example, if varcontains ['States', ['Kansas', ['Lawrence', 'Topeka'], 'Illinois']], then{{ var|unordered_list }} would return:

upper¶

Converts a string into all uppercase.

For example:

If value is "Joel is a slug", the output will be "JOEL IS A SLUG".

urlencode¶

Escapes a value for use in a URL.

For example:

If value is "https://www.example.org/foo?a=b&c=d", the output will be"https%3A//www.example.org/foo%3Fa%3Db%26c%3Dd".

An optional argument containing the characters which should not be escaped can be provided.

If not provided, the ‘/’ character is assumed safe. An empty string can be provided when all characters should be escaped. For example:

If value is "https://www.example.org/", the output will be"https%3A%2F%2Fwww.example.org%2F".

urlize¶

Converts URLs and email addresses in text into clickable links.

This template tag works on links prefixed with http://, https://, orwww.. For example, https://djangocon.eu will get converted butdjangocon.eu won’t.

It also supports domain-only links ending in one of the original top level domains (.com, .edu, .gov, .int, .mil, .net, and.org). For example, djangoproject.com gets converted.

Links can have trailing punctuation (periods, commas, close-parens) and leading punctuation (opening parens), and urlize will still do the right thing.

Links generated by urlize have a rel="nofollow" attribute added to them.

For example:

If value is "Check out www.djangoproject.com", the output will be:

Check out www.djangoproject.com

Deprecated since version 6.0: The default protocol when none is provided will change from HTTP to HTTPS in Django 7.0. Hence, the output will become:

Check out www.djangoproject.com

Set the transitional setting URLIZE_ASSUME_HTTPS to True to opt into using HTTPS during the Django 6.x release cycle.

In addition to web links, urlize also converts email addresses intomailto: links. If value is"Send questions to foo@example.com", the output will be"Send questions to <a href="mailto:foo@example.com">foo@example.com</a>".

The urlize filter also takes an optional parameter autoescape. Ifautoescape is True, the link text and URLs will be escaped using Django’s built-in escape filter. The default value forautoescape is True.

Note

If urlize is applied to text that already contains HTML markup, or to email addresses that contain single quotes ('), things won’t work as expected. Apply this filter only to plain text.

urlizetrunc¶

Converts URLs and email addresses into clickable links just like urlize, but truncates URLs longer than the given character limit.

Argument: Number of characters that link text should be truncated to, including the ellipsis that’s added if truncation is necessary.

For example:

{{ value|urlizetrunc:15 }}

If value is "Check out www.djangoproject.com", the output would be:

Check out www.djangoproj…

Deprecated since version 6.0: The default protocol when none is provided will change from HTTP to HTTPS in Django 7.0. Hence, the output will become:

Check out www.djangoproj…

Set the transitional setting URLIZE_ASSUME_HTTPS to True to opt into using HTTPS during the Django 6.x release cycle.

As with urlize, this filter should only be applied to plain text.

wordcount¶

Returns the number of words.

For example:

If value is "Joel is a slug", the output will be 4.

wordwrap¶

Wraps words at specified line length.

Argument: number of characters at which to wrap the text

For example:

If value is Joel is a slug, the output would be:

yesno¶

Maps values for True, False, and (optionally) None, to the strings “yes”, “no”, “maybe”, or a custom mapping passed as a comma-separated list, and returns one of those strings according to the value:

For example:

{{ value|yesno:"yeah,no,maybe" }}

Internationalization tags and filters¶

Django provides template tags and filters to control each aspect ofinternationalization in templates. They allow for granular control of translations, formatting, and time zone conversions.

i18n¶

This library allows specifying translatable text in templates. To enable it, set USE_I18N to True, then load it with{% load i18n %}.

See Internationalization: in template code.

l10n¶

This library provides control over the localization of values in templates. You only need to load the library using {% load l10n %}.

See Controlling localization in templates.

tz¶

This library provides control over time zone conversions in templates. Like l10n, you only need to load the library using {% load tz %}, but you’ll usually also set USE_TZ to True so that conversion to local time happens by default.

See Time zone aware output in templates.

Other tags and filters libraries¶

Django comes with a couple of other template-tag libraries that you have to enable explicitly in your INSTALLED_APPS setting and enable in your template with the {% load %} tag.

django.contrib.humanize¶

A set of Django template filters useful for adding a “human touch” to data. Seedjango.contrib.humanize.

static¶

static¶

To link to static files that are saved in STATIC_ROOT Django ships with a static template tag. If the django.contrib.staticfilesapp is installed, the tag will serve files using url() method of the storage specified by staticfiles in STORAGES. For example:

{% load static %}

It is also able to consume standard context variables, e.g. assuming auser_stylesheet variable is passed to the template:

{% load static %}

If you’d like to retrieve a static URL without displaying it, you can use a slightly different call:

{% load static %} {% static "images/hi.jpg" as myphoto %}

Using Jinja2 templates?

See Jinja2 for information on using the static tag with Jinja2.

get_static_prefix¶

You should prefer the static template tag, but if you need more control over exactly where and how STATIC_URL is injected into the template, you can use the get_static_prefix template tag:

{% load static %}

There’s also a second form you can use to avoid extra processing if you need the value multiple times:

{% load static %} {% get_static_prefix as STATIC_PREFIX %}

get_media_prefix¶

Similar to the get_static_prefix, get_media_prefix populates a template variable with the media prefix MEDIA_URL, e.g.:

{% load static %}

By storing the value in a data attribute, we ensure it’s escaped appropriately if we want to use it in a JavaScript context.