过滤器(Filter)

过滤器用于修改特定文件,Kuangjia 将这些文件依序传给过滤器,而过滤器可以针对文件进行修改,这个概念借鉴自 WordPress

概要

kuangjia.extend.filter.register(type, function(){
}, priority);

您可以指定过滤器的优先级 prioritypriority 值越低,过滤器会越早执行,默认的 priority 是 10。

执行过滤器

kuangjia.extend.filter.exec(type, data, options);
kuangjia.extend.filter.execSync(type, data, options);
选项 描述
context Context
args 参数。必须为数组。

data 会作为第一个参数传入每个过滤器,而您可以在过滤器中通过返回值改变下一个过滤器中的 data,如果什么都没有返回的话则会保持原本的 data。您还可以使用 args 指定过滤器的其他参数。举例来说:

kuangjia.extend.filter.register('test', function(data, arg1, arg2){
// data === 'some data'
// arg1 === 'foo'
// arg2 === 'bar'
return 'something';
});
kuangjia.extend.filter.register('test', function(data, arg1, arg2){
// data === 'something'
});
kuangjia.extend.filter.exec('test', 'some data', {
args: ['foo', 'bar']
});

您也可以使用以下方法来执行过滤器:

kuangjia.execFilter(type, data, options);
kuangjia.execFilterSync(type, data, options);

移除过滤器

kuangjia.extend.filter.unregister(type, filter);

过滤器列表

以下是 Kuangjia 所使用的过滤器。

before_post_render

在文章开始渲染前执行。您可以参考 文章渲染 以了解执行顺序。

举例来说,把标题转为小写:

kuangjia.extend.filter.register('before_post_render', function(data){
data.title = data.title.toLowerCase();
return data;
});

after_post_render

在文章渲染完成后执行。您可以参考 文章渲染 以了解执行顺序。

举例来说,把 @username 取代为 Twitter 的开发者链接。

kuangjia.extend.filter.register('after_post_render', function(data){
data.content = data.content.replace(/@(\d+)/, '<a href="http://twitter.com/$1">#$1</a>');
return data;
});

before_exit

在 Kuangjia 即将结束时执行,也就是在 kuangjia.exit 被调用后执行。

kuangjia.extend.filter.register('before_exit', function(){
// ...
});

before_generate

在生成器解析前执行。

kuangjia.extend.filter.register('before_generate', function(){
// ...
});

after_generate

在生成器解析后执行。

kuangjia.extend.filter.register('after_generate', function(){
// ...
});

template_locals

修改模板的 局部变量

举例来说,在模板的局部变量中新增当前时间:

kuangjia.extend.filter.register('template_locals', function(locals){
locals.now = Date.now();
return locals;
});

after_init

在 Kuangjia 初始化完成后执行,也就是在 kuangjia.init 执行完成后执行。

kuangjia.extend.filter.register('after_init', function(){
// ...
});

new_post_path

用来决定新建文章的路径,在建立文章时执行。

kuangjia.extend.filter.register('new_post_path', function(data, replace){
// ...
});

post_permalink

用来决定文章的永久链接。

kuangjia.extend.filter.register('post_permalink', function(data){
// ...
});

after_render

在渲染后执行,您可以参考 渲染 以了解更多信息。

server_middleware

新增服务器的 Middleware。app 是一个 Connect 实例。

举例来说,在响应头中新增 X-Powered-By: Kuangjia

kuangjia.extend.filter.register('server_middleware', function(app){
app.use(function(req, res, next){
res.setHeader('X-Powered-By', 'Kuangjia');
next();
});
});