自定义过滤器就是有一个或两个参数的Python函数:
- (输入)变量的值
- 参数的值， 可以是默认值或者完全留空
例如，在过滤器 {{ var|foo:"bar" }} 中 ，过滤器 foo 会被传入变量 var 和默认参数 bar。
过滤器函数应该总有返回值。 而且不能触发异常，它们都应该静静地失败。 如果出现错误，应该返回一个原始输入或者空字符串，这会更有意义。
这里是一些定义过滤器的例子：
|
1
2
3
|
def cut(value, arg):
"Removes all values of arg from the given string"
return value.replace(arg, '')
|
下面是一个可以用来去掉变量值空格的过滤器例子：
|
1
|
{{ somevariable|cut:" " }}
|
大多数过滤器并不需要参数。 下面的例子把参数从你的函数中拿掉了：
|
1
2
3
|
def lower(value): # Only one argument.
"Converts a string into all lowercase"
return value.lower()
|
当你定义完过滤器后，你需要用 Library 实例来注册它，这样就能通过Django的模板语言来使用了：
|
1
2
|
register.filter('cut', cut)
register.filter('lower', lower)
|
Library.filter() 方法需要两个参数：
- 过滤器的名称（一个字串）
- 过滤器函数本身
如果你使用的是Python 2.4或者更新的版本，你可以使用装饰器register.filter()：
|
1
2
3
4
5
6
7
|
@register.filter(name='cut')
def cut(value, arg):
return value.replace(arg, '')
@register.filter
def lower(value):
return value.lower()
|
如果你想第二个例子那样不使用 name 参数，那么Django会把函数名当作过滤器的名字。
下面是一个完整的模板库的例子，它包含一个 cut 过滤器：
|
1
2
3
4
5
6
7
|
from django import template
register = template.Library()
@register.filter(name='cut')
def cut(value, arg):
return value.replace(arg, '')
|