| 17 | WordPress,博客 | Glen Liu

Filters(过滤器)对于WordPress来说是非常重要的,它不仅极大地扩展了WordPress的定制能力,而且还提高了WordPress的灵活性。无论是制作主题还是开发插件,我们基本上都会或多或少地使用到过滤器,以实现我们的一些特殊需求。

其实,WordPress的Filters的使用起来也是非常简单的,我们经常用到的也就是两个函数而已,它们就是apply_filters和add_filter。本文将对WordPress过滤器进行详细解读与分析。

什么是Filters(过滤器)?

下面就来说说什么是Filters(过滤器),过滤器就是注册到过滤器钩子(Filter Hook)的函数,过滤器钩子都有一个名字,在WordPress中,一般使用变量$tag来标识这个名字。所有挂接到过滤器钩子上的函数都是过滤器。

过滤器(Filters)钩子和动作(action)钩子一样,基本的函数有两个,动作钩子有do_action()函数,过滤器有apply_filters()函数;该函数是用于执行相应的过滤器函数,不同的是动作钩子仅仅是执行函数(或者称为动作,更为贴切),而过滤器钩子它要做的是通过执行过滤器函数来改变对象或变量的值,就相当于对变量或者对象进行过滤,然后再返回。

过滤器(Filters)钩子的相关函数介绍:

简单地说,动作(action)钩子要的是过程(仅仅执行代码块)而不是结果(输出值或返回值),而过滤器(Filters)钩子要的是结果而不是过程。apply_filters()函数的用法说明:

<?php
    apply_filters( $tag, $value, $var ... );
    //$tag 必需,过滤器钩子的名称
    //$value 必需,可以被过滤器函数修改的值
    //$var 可选,若干个可以传递给过滤器函数的参数
?>

同理,动作钩子有个函数是add_action,相应地,过滤器钩子也有个函数是add_filter。这两个函数的用法就完全一样了,实际上,add_action就是直接调用add_filter来实现的。add_filter函数的用法:

<?php
    add_filter( $tag, $function_to_add, $priority, $accepted_args );
    //$tag 必需,过滤器钩子的名称
    //$function_to_add 必需,要添加的过滤器函数
    //$priority 可选,过滤器函数的优先级,数值越小越先执行,默认值为10
    //$accepted_args 可选,过滤器函数接受的参数数量,默认值为1
?>

要注意的是,我们在前面说过,过滤器(过滤器函数)的任务是要改变对象或变量的值,所以通过add_filter函数添加的过滤器必须要有个返回值,也就是函数$function_to_add必需有返回值。

过滤器应用实例:

我们以wp_title()函数为例,为大家讲一下过滤器的实际用法,这个函数的定义在wp-includes/general-template.php文件中。在该函数的定义中,调用了apply_filters函数来执行相应的过滤器函数。代码如下:

$title = apply_filters('wp_title', $title, $sep, $seplocation);
//这里会执行过滤器函数,对变量$title进行过滤
//正因为这行代码的存在,你可以把你的过滤器函数添加进来,实现对$title的定制

那么,我们可以在该过滤器钩子(wp_title)上添加一个过滤器来改变$title的值。代码如下:

<?php
    add_filter('wp_title', 'mytitle');
    //把函数mytitle挂接到过滤器钩子wp_title上
    //定义过滤器函数mytitle
    function mytitle($title) {
        $title = 'This is a demo.';
        return $title;
    }
?>

上面这些代码就会把wp_title()函数的返回值$title改为“This is a demo.”,调用wp_title()函数得到的输出就是“This is a demo.”了,不管在什么页面调用都是如此。把这段代码添加到主题的functions.php文件中,你就能看到效果了(如果你的主题使用了wp_title函数)。

通过本文的介绍,相信大家都明白了什么是过滤器以及过滤器的用法。

官方参考手册:

http://codex.wordpress.org/Function_Reference/apply_filters

http://codex.wordpress.org/Function_Reference/add_filter

http://codex.wordpress.org/Plugin_API

https://codex.wordpress.org/Plugin_API/Hooks_2.0.x 动作钩子与过滤器钩子参考


发表您的意见或评论

您的电子邮箱地址不会被公开。 必填项已用*标注

正在检测......