Class Library

django.template.library.Library

A class for registering template tags and filters. Compiled filter and

Declaration

class Library

Documentation

template tag functions are stored in the filters and tags attributes.
The filter, simple_tag, and inclusion_tag methods provide a convenient
way to register callables as tags.

Methods

▷ def __init__(self)
source link
▶ def filter(self, name=None, filter_func=None, **flags)
Register a callable as a template filter. Example:
source link
```
@register.filter
def lower(value):
    return value.lower()
```
▷ def filter_function(self, func, **flags)
source link

▶ def inclusion_tag(self, filename, func=None, takes_context=None, name=None)

Register a callable as an inclusion tag:

@register.inclusion_tag('results.html')
def show_results(poll):
    choices = poll.choice_set.all()
    return {'choices': choices}

▶ def simple_tag(self, func=None, takes_context=None, name=None)
Register a callable as a compiled template tag. Example:
source link
```
@register.simple_tag
def hello(*args, **kwargs):
    return 'world'
```
▷ def tag(self, name=None, compile_function=None)
source link
▷ def tag_function(self, func)
source link

Reexports

Imported in django.templatetags.tz.
Imported in django.templatetags.l10n.
Imported in django.templatetags.i18n.
Imported in django.templatetags.cache.
Imported in django.contrib.admin.templatetags.admin_list.
Imported in django.template.defaulttags.
Imported in django.template.loader_tags.
Imported in django.template.defaultfilters.
Imported in django.template.