WordPress过滤器(Filters):apply_filters和add_filter 用法和实例

过滤器钩子及相关函数:

过滤器(Filters),就是过滤的意思。 过滤器也叫过滤器钩子,它和动作钩子一样,基本的也有两个函数,动作钩子有do_action它有apply_filters函数,也是创建并执行一个过滤器函数,不同的是动作钩子仅仅是执行一些函数,而过滤器它要做的是改变对象或变量的值,就相当于把对象或变量过滤,然后返回。 过滤器就是注册到过滤器钩子(Filter Hook)的函数,过滤器钩子都有一个名字,在WordPress中,一般使用变量$tag来标识这个名字。所有挂接到过滤器钩子上的函数都是过滤器。

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

简单地说,动作钩子要的是过程(仅仅执行代码块)而不是结果(输出值/返回值),过滤器钩子要的是结果而不是过程。

1、apply_filters()函数的用法:

  1. <?php
  2.     apply_filters( $tag, $value, $var ... );
  3.     //$tag (字符串)(必需)过滤器钩子的名称,默认值:None
  4.     //$value (混合)(必需),可以被过滤器函数修改的值要过滤的值,如果没人过滤则直接返回这个值。
  5.     //$var (混合) (可选)传给过滤函数额外的变量参数,辅助过滤函数对返回值进行操作,可以添加无限个。
  6.     //返回值 (混合)过滤后的值,如果没人过滤则直接返回 $value 的值。
  7. ?>

2、add_filter()函数的用法:

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

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

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

3、过滤器应用实例:

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

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

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

  1. <?php
  2.     add_filter('wp_title', 'mytitle');
  3.     //把函数mytitle挂接到过滤器钩子wp_title上
  4.     //定义过滤器函数mytitle
  5.     function mytitle($title) {
  6.         $title = '过滤替换后的标题';
  7.         return $title;
  8.     }
  9. ?>

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

通过本文的介绍,相信大家都明白了什么是过滤器以及过滤器的用法。 在官网中搜索,过滤器相关的函数还有 has_filter() current_filter() merge_filters() remove_filter() remove_all_filters()...

4、参考手册

1、http://codex.wordpress.org/Function_Reference/apply_filters
2、http://codex.wordpress.org/Function_Reference/add_filter
3、http://codex.wordpress.org/Plugin_API

5、版权声明

在学习的过程中,搜索了一下 WordPress过滤器 所有的文章几乎都一样,但知识就是这样的,函数也是这样的,学习也是这样的。


发布日期:

所属分类: WordPress 函数 标签: