标签: WordPress 钩子Hook

  • WordPress系列之钩子hook的作用及基本用法

    WordPress系列之钩子hook的作用及基本用法

    WordPress 的插件机制实际上只的就是这个 Hook 了,它中文被翻译成钩子,允许你参与 WordPress 核心的运行,是一个非常棒的东西,下面我们来详细了解一下它。

    钩子分类

    钩子分为两种,一种叫做动作(action),还有一种叫做过滤器(filter)。这两种钩子实现原理基本一样,后边会讲到,使用上的区别在于过滤器有返回值,而动作没有。

    动作的理念是让你在一种情况或者一个特别的位置执行一些函数,比如发送一封邮件等;过滤器则是让你修改 WordPress 核心需要用到的一个值,然后 WordPress 再用这些值做一些事情,比如函数的返回值等。

    动作钩子

    wp_head 是一个很常用的动作钩子,在开发主题过程中,开发者都会在 head 标签里加上 wp_head() 函数,事实上,正是这个函数调用了 wp_head 钩子。

    如果插件开发者想要在 head 标签里添加一句话,就可以使用 wp_head 钩子,下边是个简单的例子。

    //在 head 标签添加一些内容
    function Bing_add_head_tag(){
      echo '添加内容';
    }
    add_action( 'wp_head', 'Bing_add_head_tag' );

    添加代码后,查看前台的网页源代码,就能在 head 标签里看到我们添加的内容了。

    上边是一个简单的例子,只是打印了一句话。利用这个钩子,我们还可以做一个遇到 404 页面给管理员发送一封邮件的插件,下边简单的写了一个。

    //遇到 404 页面给管理员发送邮件
    function Bing_404_page_mail(){
      if( !is_404() ) return;//如果不是 404 页面就退出函数
      $to = get_option( 'admin_email' );//获取管理员地址
      $subject = '遇到 404 页面啦!';//邮件标题
      $message = '404 页面的地址:http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];//邮件内容
      wp_mail( $to, $subject, $message );//发送邮件
    }
    add_action( 'wp_head', 'Bing_404_page_mail' );

    过滤器钩子

    过滤器钩子可以让你改一些东西的值,过滤器回调函数会接受一个参数,这就是当前的值。还记得那个用来调用文章内容的 the_content() 函数吧,这个函数就提供了一个 the_content 过滤器。

    给 the_content 钩子添加一个函数,这个函数需要接收一个参数,这个参数就是当前的值。

    //文章内容全部链接新窗口打开
    function Bing_autoblank( $content ){//$content 变量就是文章内容,因为其它过滤器也要过滤,所以这个内容可能是经过其它函数过滤的
      $content = str_replace( '<a', '<a target="_blank"', $content );//添加 target="_blank"
      return $content;//必须要把过滤后的内容返回回去,否则值就丢了
    }
    add_filter( 'the_content', 'Bing_autoblank' );

    钩子原理

    事实上,在调用 add_action() 和 add_filter() 的时候,只是向 $wp_filter 全局变量添加了一个数组元素,还要说的就是动作和过滤器是公用的一个全局变量,也就是说,过滤器和动作是不能重名的。

    当调用 do_action() 的时候,会查找 $wp_filter 全局变量中都有哪些添加到此动作的函数,循环执行即可。

    apply_filters() 比 do_action() 多了一个步奏,就是每次调用函数时还要接收这个函数的返回值,最后把经过多次过滤的值返回出去,供使用。

    获取当前钩子列表
    WordPress 的动作和过滤器是插件机制的核心部分,允许你在特定的地方主动添加自己需要执行的动作,一般使用 add_action() 和 add_filter() 函数挂载函数。

    这些钩子被储存在 $wp_filter 全局变量里,所以,要获取钩子列表,可以直接获取 $wp_filter 全局变量。

    <?php var_dump( $GLOBALS['wp_filter'] ); ?>

    上边的代码会打印出钩子列表数组。

  • WordPress 开发必了解 过滤器(Filters):apply_filters和add_filter 用法和实例

    WordPress 开发必了解 过滤器(Filters):apply_filters和add_filter 用法和实例

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

    过滤器钩子及相关函数:

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

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

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

    apply_filters()函数的用法:

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

    add_filter()函数的用法:

    同理,动作钩子有个函数是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 = '过滤替换后的标题';
            return $title;
        }

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

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

    参考手册

    • http://codex.wordpress.org/Function_Reference/apply_filters
    • http://codex.wordpress.org/Function_Reference/add_filter
    • http://codex.wordpress.org/Plugin_API
WeChat