This document describes Django’s built-in template tags and filters. It is\nrecommended that you use the automatic documentation, if available, as this will also include\ndocumentation for any custom tags or filters installed.
\nautoescapeLink to this heading#Controls the current auto-escaping behavior. This tag takes either on or\noff as an argument and that determines whether auto-escaping is in effect\ninside the block. The block is closed with an endautoescape ending tag.
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.
In order to properly escape every element in a sequence, use the\nescapeseq filter:
{% autoescape off %}\n {{ my_list|escapeseq|join:", " }}\n{% endautoescape %}\nblockLink to this heading#Defines a block that can be overridden by child templates. See\nTemplate inheritance for more information.
\ncommentLink to this heading#Ignores everything between {% comment %} and {% endcomment %}.\nAn optional note may be inserted in the first tag. For example, this is\nuseful when commenting out code for documenting why the code was disabled.
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 tags cannot be nested.
csrf_tokenLink to this heading#This tag is used for CSRF protection, as described in the documentation for\nCross Site Request Forgeries.
\ncycleLink to this heading#Produces one of its arguments each time this tag is encountered. The first\nargument is produced on the first encounter, the second argument on the second\nencounter, and so forth. Once all arguments are exhausted, the tag cycles to\nthe first argument and produces it again.
\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 %}\nThe first iteration produces HTML that refers to class row1, the second to\nrow2, the third to row1 again, and so on for each iteration of the\nloop.
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>\nYou can use any number of values in a cycle tag, separated by spaces.\nValues enclosed in single quotes (') or double quotes (") are treated\nas string literals, while values without quotes are treated as template\nvariables.
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 %}\nThis will output a list of <tr> elements with class\nalternating between row1 and row2. The subtemplate will have\naccess to rowcolors in its context and the value will match the class\nof the <tr> that encloses it. If the silent keyword were to be\nomitted, row1 and row2 would be emitted as normal text, outside the\n<tr> element.
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#Signals that this template extends a parent template.
\nThis tag can be used in two ways:
\n{% extends "base.html" %} (with quotes) uses the literal value\n"base.html" as the name of the parent template to extend.
{% extends variable %} uses the value of variable. If the variable\nevaluates to a string, Django will use that string as the name of the\nparent template. If the variable evaluates to a Template object,\nDjango will use that object as the parent template.
See Template inheritance for more information.
\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#Filters the contents of the block through one or more filters. Multiple\nfilters can be specified with pipes and filters can have arguments, just as\nin variable syntax.
\nNote that the block includes all the text between the filter and\nendfilter tags.
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 %}\nYou can use the syntax {% firstof var1 var2 var3 as value %} to store the\noutput inside a variable.
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>\nYou can loop over a list in reverse by using\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 %}\nKeep in mind that for the dot operator, dictionary key lookup takes precedence\nover method lookup. Therefore if the data dictionary contains a key named\n'items', data.items will return data['items'] instead of\ndata.items(). Avoid adding keys that are named like dictionary methods if\nyou want to use those methods in a template (items, values, keys,\netc.). Read more about the lookup order of the dot operator in the\ndocumentation of template variables.
The for loop sets a number of variables available within the loop:
\nVariable | \nDescription | \n
|---|---|
| \nThe current iteration of the loop (1-indexed) | \n
| \nThe current iteration of the loop (0-indexed) | \n
| \nThe number of iterations from the end of the\nloop (1-indexed) | \n
| \nThe number of iterations from the end of the\nloop (0-indexed) | \n
| \nTrue if this is the first time through the loop | \n
| \nTrue if this is the last time through the loop | \n
| \nFor nested loops, this is the loop surrounding\nthe current one | \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 %}\nIn the above, if athlete_list is not empty, the number of athletes will be\ndisplayed by the {{ athlete_list|length }} variable.
As you can see, the if tag may take one or several {% elif %}\nclauses, as well as an {% else %} clause that will be displayed if all\nprevious conditions fail. These clauses are optional.
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 %}\nwill be interpreted like:
\nif (athlete_list and coach_list) or cheerleader_list:\n ...\nUse of actual parentheses in the if tag is invalid syntax. If you need\nthem to indicate precedence, you should use nested if tags.
if tags may also use the operators ==, !=, <, >,\n<=, >=, in, not in, is, and is not which work as\nfollows:
== operatorLink to this heading#Equality. Example:
\n{% if somevar == "x" %}\n This appears if variable somevar equals the string "x"\n{% endif %}\n!= operatorLink 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< operatorLink to this heading#Less than. Example:
\n{% if somevar < 100 %}\n This appears if variable somevar is less than 100.\n{% endif %}\n> operatorLink to this heading#Greater than. Example:
\n{% if somevar > 0 %}\n This appears if variable somevar is greater than 0.\n{% endif %}\n<= operatorLink 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>= operatorLink 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 operatorLink 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 operatorLink to this heading#Not contained within. This is the negation of the in operator.
is operatorLink 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 %}\nAll of the above can be combined to form complex expressions. For such\nexpressions, it can be important to know how the operators are grouped when the\nexpression is evaluated - that is, the precedence rules. The precedence of the\noperators, from lowest to highest, is as follows:
\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…will be interpreted as:
\n(a == b) or ((c == d) and e)\nIf you need different precedence, you will need to use nested if tags.\nSometimes that is better for clarity anyway, for the sake of those who do not\nknow the precedence rules.
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#Check if a value has changed from the last iteration of a loop.
\nThe {% ifchanged %} block tag is used within a loop. It has two possible\nuses.
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#Loads a template and renders it with the current context. This is a way of\n“including” other templates within a template.
\nThe template name can either be a variable or a hard-coded (quoted) string,\nin either single or double quotes.
\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 %}\nThe variable may also be any object with a render() method that accepts a\ncontext. This allows you to reference a compiled Template in your context.
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().
An included template is rendered within the context of the template that\nincludes it. This example produces the output "Hello, John!":
Context: variable person is set to "John" and variable greeting\nis set to "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#Loads a custom template tag set.
\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 %}\nSee Custom tag and filter libraries for\nmore information.
\nloremLink to this heading#Displays random “lorem ipsum” Latin text. This is useful for providing sample\ndata in templates.
\nUsage:
\n{% lorem [count] [method] [random] %}\nThe {% lorem %} tag can be used with zero, one, two or three arguments.\nThe arguments are:
Argument | \nDescription | \n
|---|---|
| \nA number (or variable) containing the number of paragraphs or\nwords to generate (default is 1). | \n
| \nEither | \n
| \nThe word | \n
Examples:
\n{% lorem %} will output the common “lorem ipsum” paragraph.
{% lorem 3 p %} will output the common “lorem ipsum” paragraph\nand two random paragraphs each wrapped in HTML <p> tags.
{% lorem 2 w random %} will output two random Latin words.
nowLink to this heading#Displays the current date and/or time, using a format according to the given\nstring. Such string can contain format specifiers characters as described\nin the date filter section.
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" %}\nThis would display as “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#Regroups a list of alike objects by a common attribute.
\nThis complex tag is best illustrated by way of an example: say that cities\nis a list of cities represented by dictionaries containing "name",\n"population", and "country" keys:
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…and you’d like to display a hierarchical list that is ordered by country,\nlike this:
\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>\nLet’s walk through this example. {% regroup %} takes three arguments: the\nlist you want to regroup, the attribute to group by, and the name of the\nresulting list. Here, we’re regrouping the cities list by the country\nattribute and calling the result country_list.
{% regroup %} produces a list (in this case, country_list) of\ngroup objects. Group objects are instances of\nnamedtuple() with two fields:
grouper – the item that was grouped by (e.g., the string “India” or\n“Japan”).
list – a list of all items in this group (e.g., a list of all cities\nwith 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>\nNote that {% regroup %} does not order its input! Our example relies on\nthe fact that the cities list was ordered by country in the first place.\nIf the cities list did not order its members by country, the\nregrouping would naively display more than one group for a single country. For\nexample, say the cities list was set to this (note that the countries are not\ngrouped together):
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]\nWith this input for cities, the example {% regroup %} template code\nabove would result in the following output:
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
The easiest solution to this gotcha is to make sure in your view code that the\ndata is ordered according to how you want to display it.
\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 }} will now display the value fields from the\nchoices set rather than the keys.
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#Removes whitespace between HTML tags. This includes tab\ncharacters and newlines.
\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#Outputs one of the syntax characters used to compose template tags.
\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.
The argument tells which template bit to output:
\nArgument | \nOutputs | \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#Returns an absolute path reference (a URL without the domain name) matching a\ngiven view and optional parameters. Any special characters in the resulting\npath will be encoded using 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 %}\nDo not mix both positional and keyword syntax in a single call. All arguments\nrequired by the URLconf should be present.
\nFor example, suppose you have a view, app_views.client, whose URLconf\ntakes a client ID (here, client() is a method inside the views file\napp_views.py). The URLconf line might look like this:
path("client/<int:id>/", app_views.client, name="app-views-client")\nIf this app’s URLconf is included into the project’s URLconf under a path\nsuch as this:
\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 %}\nThe template tag will output the string /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>\nThe scope of the variable created by the as var syntax is the\n{% block %} in which the {% url %} tag appears.
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' %}\nThis will follow the normal namespaced URL resolution strategy, including using any hints provided\nby the context as to the current application.
\n\nverbatimLink to this heading#Stops the template engine from rendering the contents of this block tag.
\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#For creating bar charts and such, this tag calculates the ratio of a given\nvalue to a maximum value, and then applies that ratio to a constant.
\nFor example:
\n<img src="bar.png" alt="Bar"\n height="10" width="{% widthratio this_value max_value max_width %}">\nIf this_value is 175, max_value is 200, and max_width is 100, the\nimage in the above example will be 88 pixels wide\n(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\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#Caches a complex variable under a simpler name. This is useful when accessing\nan “expensive” method (e.g., one that hits the database) multiple times.
\nFor example:
\n{% with total=business.employees.count %}\n {{ total }} employee{{ total|pluralize }}\n{% endwith %}\nThe populated variable (in the example above, total) is only available\nbetween the {% with %} and {% endwith %} tags.
You can assign more than one context variable:
\n{% with alpha=1 beta=2 %}\n ...\n{% endwith %}\naddLink to this heading#Adds the argument to the value.
\nFor example:
\n{{ value|add:"2" }}\nIf value is 4, then the output will be 6.
This filter will first try to coerce both values to integers. If this fails,\nit’ll attempt to add the values together anyway. This will work on some data\ntypes (strings, list, etc.) and fail on others. If it fails, the result will\nbe an empty string.
\nFor example, if we have:
\n{{ first|add:second }}\nand first is [1, 2, 3] and second is [4, 5, 6], then the\noutput will be [1, 2, 3, 4, 5, 6].
addslashesLink to this heading#Adds slashes before quotes. Useful for escaping strings in CSV, for example.
\nFor example:
\n{{ value|addslashes }}\nIf value is "I'm using Django", the output will be\n"I\\'m using Django".
capfirstLink to this heading#Capitalizes the first character of the value. If the first character is not\na letter, this filter has no effect.
\nFor example:
\n{{ value|capfirst }}\nIf value is "django", the output will be "Django".
centerLink to this heading#Centers the value in a field of a given width.
\nFor example:
\n"{{ value|center:"15" }}"\nIf value is "Django", the output will be " Django ".
cutLink to this heading#Removes all values of arg from the given string.
\nFor example:
\n{{ value|cut:" " }}\nIf value is "String with spaces", the output will be\n"Stringwithspaces".
dateLink to this heading#Formats a date according to the given format.
\nUses a similar format to PHP’s date() function with some\ndifferences.
\n\nAvailable format strings:
\nFormat character | \nDescription | \nExample output | \n
|---|---|---|
Day | \n\n | \n |
| \nDay of the month, 2 digits with\nleading zeros. | \n
| \n
| \nDay of the month without leading\nzeros. | \n
| \n
| \nDay of the week, textual, 3 letters. | \n
| \n
| \nDay of the week, textual, long. | \n
| \n
| \nEnglish ordinal suffix for day of the\nmonth, 2 characters. | \n
| \n
| \nDay of the week, digits without\nleading zeros. | \n
| \n
| \nDay of the year. | \n
| \n
Week | \n\n | \n |
| \nISO-8601 week number of year, with\nweeks starting on Monday. | \n
| \n
Month | \n\n | \n |
| \nMonth, 2 digits with leading zeros. | \n
| \n
| \nMonth without leading zeros. | \n
| \n
| \nMonth, textual, 3 letters. | \n
| \n
| \nMonth, textual, 3 letters, lowercase. | \n
| \n
| \nMonth, locale specific alternative\nrepresentation usually used for long\ndate representation. | \n
| \n
| \nMonth, textual, long. | \n
| \n
| \nMonth abbreviation in Associated Press\nstyle. Proprietary extension. | \n
| \n
| \nNumber of days in the given month. | \n
| \n
Year | \n\n | \n |
| \nYear, 2 digits with leading zeros. | \n
| \n
| \nYear, 4 digits with leading zeros. | \n
| \n
| \nBoolean for whether it’s a leap year. | \n
| \n
| \nISO-8601 week-numbering year,\ncorresponding to the ISO-8601 week\nnumber (W) which uses leap weeks. See Y\nfor the more common year format. | \n
| \n
Time | \n\n | \n |
| \nHour, 12-hour format without leading\nzeros. | \n
| \n
| \nHour, 24-hour format without leading\nzeros. | \n
| \n
| \nHour, 12-hour format. | \n
| \n
| \nHour, 24-hour format. | \n
| \n
| \nMinutes. | \n
| \n
| \nSeconds, 2 digits with leading zeros. | \n
| \n
| \nMicroseconds. | \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \nTime, in 12-hour hours and minutes,\nwith minutes left off if they’re zero.\nProprietary extension. | \n
| \n
| \nTime, in 12-hour hours, minutes and\n‘a.m.’/’p.m.’, with minutes left off\nif they’re zero and the special-case\nstrings ‘midnight’ and ‘noon’ if\nappropriate. Proprietary extension. | \n
| \n
Timezone | \n\n | \n |
| \nTimezone name. Could be in any format,\nor might return an empty string,\ndepending on the datetime. | \n
| \n
| \nDaylight saving time, whether it’s in\neffect or not. | \n
| \n
| \nDifference to Greenwich time in hours. | \n
| \n
| \nTime zone of this machine. | \n
| \n
| \nTime zone offset in seconds. The\noffset for timezones west of UTC is\nalways negative, and for those east of\nUTC is always positive. | \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
| \nSeconds since the Unix Epoch\n(January 1 1970 00:00:00 UTC). | \n\n |
For example:
\n{{ value|date:"D d M Y" }}\nIf value is a datetime object (e.g., the result of\ndatetime.datetime.now()), the output will be the string\n'Wed 09 Jan 2008'.
The format passed can be one of the predefined ones DATE_FORMAT,\nDATETIME_FORMAT, SHORT_DATE_FORMAT or\nSHORT_DATETIME_FORMAT, or a custom format that uses the format\nspecifiers shown in the table above. Note that predefined formats may vary\ndepending on the current locale.
Assuming that LANGUAGE_CODE is, for example, "es", then for:
{{ value|date:"SHORT_DATE_FORMAT" }}\nthe output would be the string "09/01/2008" (the "SHORT_DATE_FORMAT"\nformat 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\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#If value evaluates to False, uses the given default. Otherwise, uses the\nvalue.
For example:
\n{{ value|default:"nothing" }}\nIf value is "" (the empty string), the output will be nothing.
default_if_noneLink to this heading#If (and only if) value is None, uses the given default. Otherwise, uses the\nvalue.
Note that if an empty string is given, the default value will not be used.\nUse the default filter if you want to fallback for empty strings.
For example:
\n{{ value|default_if_none:"nothing" }}\nIf value is None, the output will be nothing.
dictsortLink to this heading#Takes a list of dictionaries and returns that list sorted by the key given in\nthe argument.
\nFor example:
\n{{ value|dictsort:"name" }}\nIf value is:
[\n {"name": "zed", "age": 19},\n {"name": "amy", "age": 22},\n {"name": "joe", "age": 31},\n]\nthen the output would be:
\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 %}\nIf books is:
[\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]\nthen the output would be:
\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 }}\nIf value is:
[\n ("a", "42"),\n ("c", "string"),\n ("b", "foo"),\n]\nthen the output would be:
\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#Takes a list of dictionaries and returns that list sorted in reverse order by\nthe key given in the argument. This works exactly the same as the above filter,\nbut the returned value will be in reverse order.
\ndivisiblebyLink to this heading#Returns True if the value is divisible by the argument.
For example:
\n{{ value|divisibleby:"3" }}\nIf value is 21, the output would be True.
escapeLink to this heading#Escapes a string’s HTML. Specifically, it makes these replacements:
\n< 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\napplied to the result will only result in one round of escaping being done. So\nit is safe to use this function even in auto-escaping environments. If you want\nmultiple escaping passes to be applied, use the force_escape filter.
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.
For example:
\n<script>\nlet myValue = '{{ value|escapejs }}'\nescapeseqLink to this heading#Applies the escape filter to each element of a sequence. Useful in\nconjunction with other filters that operate on sequences, such as\njoin. For example:
{% autoescape off %}\n {{ my_list|escapeseq|join:", " }}\n{% endautoescape %}\nfilesizeformatLink to this heading#Formats the value like a ‘human-readable’ file size (i.e. '13 KB',\n'4.1 MB', '102 bytes', etc.).
For example:
\n{{ value|filesizeformat }}\nIf value is 123456789, the output would be 117.7 MB.
firstLink to this heading#Returns the first item in a list.
\nFor example:
\n{{ value|first }}\nIf value is the list ['a', 'b', 'c'], the output will be 'a'.
floatformatLink to this heading#When used without an argument, rounds a floating-point number to one decimal\nplace – but only if there’s a decimal part to be displayed. For example:
\n
| \nTemplate | \nOutput | \n
|---|---|---|
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
If used with a numeric integer argument, floatformat rounds a number to\nthat many decimal places. For example:
| \nTemplate | \nOutput | \n
|---|---|---|
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
Particularly useful is passing 0 (zero) as the argument which will round the\nfloat to the nearest integer.
\n
| \nTemplate | \nOutput | \n
|---|---|---|
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
If the argument passed to floatformat is negative, it will round a number\nto that many decimal places – but only if there’s a decimal part to be\ndisplayed. For example:
| \nTemplate | \nOutput | \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):
| \nTemplate | \nOutput | \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):
| \nTemplate | \nOutput | \n
|---|---|---|
| \n
| \n
| \n
| \n
| \n
| \n
Using floatformat with no argument is equivalent to using floatformat\nwith an argument of -1.
force_escapeLink to this heading#Applies HTML escaping to a string (see the escape filter for\ndetails). This filter is applied immediately and returns a new, escaped\nstring. This is useful in the rare cases where you need multiple escaping or\nwant to apply other filters to the escaped results. Normally, you want to use\nthe escape filter.
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#Given a whole number, returns the requested digit, where 1 is the right-most\ndigit, 2 is the second-right-most digit, etc. Returns the original value for\ninvalid input (if input or argument is not an integer, or if argument is less\nthan 1). Otherwise, output is always an integer.
\nFor example:
\n{{ value|get_digit:"2" }}\nIf value is 123456789, the output will be 8.
iriencodeLink to this heading#Converts an IRI (Internationalized Resource Identifier) to a string that is\nsuitable for including in a URL. This is necessary if you’re trying to use\nstrings containing non-ASCII characters in a URL.
\nIt’s safe to use this filter on a string that has already gone through the\nurlencode filter.
For example:
\n{{ value|iriencode }}\nIf value is "?test=I ♥ Django", the output will be\n"?test=I%20%E2%99%A5%20Django".
joinLink to this heading#Joins a list with a string, like Python’s str.join(list)
For example:
\n{{ value|join:" // " }}\nIf value is the list ['a', 'b', 'c'], the output will be the string\n"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.
For example:
\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.
\nlastLink to this heading#Returns the last item in a list.
\nFor example:
\n{{ value|last }}\nIf value is the list ['a', 'b', 'c', 'd'], the output will be the\nstring "d".
lengthLink to this heading#Returns the length of the value. This works for both strings and lists.
\nFor example:
\n{{ value|length }}\nIf value is ['a', 'b', 'c', 'd'] or "abcd", the output will be\n4.
The filter returns 0 for an undefined variable.
length_isLink to this heading#Returns True if the value’s length is the argument, or False otherwise.
For example:
\n{{ value|length_is:"4" }}\nIf value is ['a', 'b', 'c', 'd'] or "abcd", the output will be\nTrue.
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>).
For example:
\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>).
For example:
\n{{ value|linebreaksbr }}\nIf value is Joel\\nis a slug, the output will be Joel<br>is a\nslug.
linenumbersLink to this heading#Displays text with line numbers.
\nFor example:
\n{{ value|linenumbers }}\nIf value is:
one\ntwo\nthree\nthe output will be:
\n1. one\n2. two\n3. three\nljustLink to this heading#Left-aligns the value in a field of a given width.
\nArgument: field size
\nFor example:
\n"{{ value|ljust:"10" }}"\nIf value is Django, the output will be "Django ".
lowerLink to this heading#Converts a string into all lowercase.
\nFor example:
\n{{ value|lower }}\nIf value is Totally LOVING this Album!, the output will be\ntotally 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.
\nFor example:
\n{{ value|make_list }}\nIf value is the string "Joel", the output would be the list\n['J', 'o', 'e', 'l']. If value is 123, the output will be the\nlist ['1', '2', '3'].
phone2numericLink to this heading#Converts a phone number (possibly containing letters) to its numerical\nequivalent.
\nThe input doesn’t have to be a valid phone number. This will happily convert\nany string.
\nFor example:
\n{{ value|phone2numeric }}\nIf value is 800-COLLECT, the output will be 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 }}.\nIf num_messages is 1, the output will be You have 1 message.\nIf 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\nsuffix as a parameter to the filter.
Example:
\nYou have {{ num_walruses }} walrus{{ num_walruses|pluralize:"es" }}.\nFor words that don’t pluralize by simple suffix, you can specify both a\nsingular and plural suffix, separated by a comma.
\nExample:
\nYou have {{ num_cherries }} cherr{{ num_cherries|pluralize:"y,ies" }}.\npprintLink to this heading#A wrapper around pprint.pprint() – for debugging, really.
randomLink to this heading#Returns a random item from the given list.
\nFor example:
\n{{ value|random }}\nIf value is the list ['a', 'b', 'c', 'd'], the output could be "b".
rjustLink to this heading#Right-aligns the value in a field of a given width.
\nArgument: field size
\nFor example:
\n"{{ value|rjust:"10" }}"\nIf value is Django, the output will be " Django".
safeLink to this heading#Marks a string as not requiring further HTML escaping prior to output. When\nautoescaping is off, this filter has no effect.
\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:", " }}\nYou couldn’t use the safe filter directly in this case, as it would\nfirst convert the variable into a string, rather than working with the\nindividual elements of the sequence.
sliceLink to this heading#Returns a slice of the list.
\nUses the same syntax as Python’s list slicing. See the Python documentation for an\nintroduction.
\nExample:
\n{{ some_list|slice:":2" }}\nIf some_list is ['a', 'b', 'c'], the output will be ['a', 'b'].
slugifyLink to this heading#Converts to ASCII. Converts spaces to hyphens. Removes characters that aren’t\nalphanumerics, underscores, or hyphens. Converts to lowercase. Also strips\nleading and trailing whitespace.
\nFor example:
\n{{ value|slugify }}\nIf value is "Joel is a slug", the output will be "joel-is-a-slug".
stringformatLink to this heading#Formats the variable according to the argument, a string formatting specifier.\nThis specifier uses the printf-style String Formatting syntax, with the exception\nthat the leading “%” is dropped.
\nFor example:
\n{{ value|stringformat:"E" }}\nIf value is 10, the output will be 1.000000E+01.
timeLink to this heading#Formats a time according to the given format.
\nGiven format can be the predefined one TIME_FORMAT, or a custom\nformat, same as the date filter. Note that the predefined format\nis locale-dependent.
For example:
\n{{ value|time:"H:i" }}\nIf value is equivalent to datetime.datetime.now(), the output will be\nthe string "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”.
\nAnother example:
\nAssuming that LANGUAGE_CODE is, for 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).
There is one exception the above rule: When passed a datetime value with\nattached timezone information (a time-zone-aware datetime instance) the time filter will\naccept the timezone-related format specifiers 'e', 'O' , 'T' and '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#Formats a date as the time since that date (e.g., “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 }}\nComparing offset-naive and offset-aware datetimes will return an empty string.
\nMinutes is the smallest unit used, and “0 minutes” will be returned for any\ndate that is in the future relative to the comparison point.
\ntimeuntilLink to this heading#Similar to timesince, except that it measures the time from now until the\ngiven date or datetime. For example, if today is 1 June 2006 and\nconference_date is a date instance holding 29 June 2006, then\n{{ conference_date|timeuntil }} will return “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 }}\nComparing offset-naive and offset-aware datetimes will return an empty string.
\nMinutes is the smallest unit used, and “0 minutes” will be returned for any\ndate that is in the past relative to the comparison point.
\ntitleLink to this heading#Converts a string into titlecase by making words start with an uppercase\ncharacter and the remaining characters lowercase. This tag makes no effort to\nkeep “trivial words” in lowercase.
\nFor example:
\n{{ value|title }}\nIf value is "my FIRST post", the output will be "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 (”…”).
\nArgument: Number of characters to truncate to
\nFor example:
\n{{ value|truncatechars:7 }}\nIf value is "Joel is a slug", the output will be "Joel i…".
truncatechars_htmlLink to this heading#Similar to truncatechars, except that it is aware of HTML tags. Any\ntags that are opened in the string and not closed before the truncation point\nare closed immediately after the truncation.
For example:
\n{{ value|truncatechars_html:7 }}\nIf value is "<p>Joel is a slug</p>", the output will be\n"<p>Joel i…</p>".
Newlines in the HTML content will be preserved.
\n\n\ntruncatewordsLink to this heading#Truncates a string after a certain number of words.
\nArgument: Number of words to truncate after
\nFor example:
\n{{ value|truncatewords:2 }}\nIf value is "Joel is a slug", the output will be "Joel is …".
Newlines within the string will be removed.
\ntruncatewords_htmlLink to this heading#Similar to truncatewords, except that it is aware of HTML tags. Any\ntags that are opened in the string and not closed before the truncation point,\nare closed immediately after the truncation.
This is less efficient than truncatewords, so should only be used\nwhen it is being passed HTML text.
For example:
\n{{ value|truncatewords_html:2 }}\nIf value is "<p>Joel is a slug</p>", the output will be\n"<p>Joel is …</p>".
Newlines in the HTML content will be preserved.
\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#Converts a string into all uppercase.
\nFor example:
\n{{ value|upper }}\nIf value is "Joel is a slug", the output will be "JOEL IS A SLUG".
urlencodeLink to this heading#Escapes a value for use in a URL.
\nFor example:
\n{{ value|urlencode }}\nIf value is "https://www.example.org/foo?a=b&c=d", the output will be\n"https%3A//www.example.org/foo%3Fa%3Db%26c%3Dd".
An optional argument containing the characters which should not be escaped can\nbe provided.
\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:"" }}\nIf value is "https://www.example.org/", the output will be\n"https%3A%2F%2Fwww.example.org%2F".
urlizeLink to this heading#Converts URLs and email addresses in text into clickable links.
\nThis template tag works on links prefixed with http://, https://, or\nwww.. For example, https://djangocon.eu will get converted but\ndjangocon.eu won’t.
It also supports domain-only links ending in one of the original top level\ndomains (.com, .edu, .gov, .int, .mil, .net, and\n.org). For example, djangoproject.com gets converted.
Links can have trailing punctuation (periods, commas, close-parens) and leading\npunctuation (opening parens), and urlize will still do the right thing.
Links generated by urlize have a rel="nofollow" attribute added\nto them.
For example:
\n{{ value|urlize }}\nIf value is "Check out www.djangoproject.com", the output will be\n"Check out <a href="http://www.djangoproject.com"\nrel="nofollow">www.djangoproject.com</a>".
In addition to web links, urlize also converts email addresses into\nmailto: links. If value is\n"Send questions to foo@example.com", the output will be\n"Send questions to <a href="mailto:foo@example.com">foo@example.com</a>".
The urlize filter also takes an optional parameter autoescape. If\nautoescape is True, the link text and URLs will be escaped using\nDjango’s built-in escape filter. The default value for\nautoescape is True.
urlizetruncLink to this heading#Converts URLs and email addresses into clickable links just like urlize, but\ntruncates URLs longer than the given character limit.
\nArgument: Number of characters that link text should be truncated to,\nincluding the ellipsis that’s added if truncation is necessary.
\nFor example:
\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>'.
As with urlize, this filter should only be applied to plain text.
\nwordcountLink to this heading#Returns the number of words.
\nFor example:
\n{{ value|wordcount }}\nIf value is "Joel is a slug", the output will be 4.
wordwrapLink to this heading#Wraps words at specified line length.
\nArgument: number of characters at which to wrap the text
\nFor example:
\n{{ value|wordwrap:5 }}\nIf value is Joel is a slug, the output would be:
Joel\nis a\nslug\nyesnoLink to this heading#Maps values for True, False, and (optionally) None, to the strings\n“yes”, “no”, “maybe”, or a custom mapping passed as a comma-separated list, and\nreturns one of those strings according to the value:
For example:
\n{{ value|yesno:"yeah,no,maybe" }}\nValue | \nArgument | \nOutputs | \n
|---|---|---|
| \n\n |
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n
| \n