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 全局变量。

<pre><?php var_dump( $GLOBALS[‘wp_filter‘] ); ?></pre>

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

时间: 2024-12-26 06:00:40

WordPress中函数钩子hook的作用及基本用法的相关文章

php中的钩子(hook插件机制)

对"钩子"这个概念其实不熟悉,最近看到一个php框架中用到这种机制来扩展项目,所以大概来了解下. hook插件机制的基本思想: 在项目代码中,你认为要扩展(暂时不扩展)的地方放置一个钩子函数,等需要扩展的时候,把需要实现的类和函数挂载到这个钩子上,就可以实现扩展了. 思想就是这样听起来比较笼统,看一个网上的实现的例子. 整个插件机制包含三个部分: 1.hook插件经理类:这个是核心文件,是一个应用程序全局Global对象.它主要有三个职责 1>监听已经注册了的所有插件,并实例化这

关于C++中函数指针的使用

关于C++中函数指针的使用(包含对typedef用法的讨论) (一)简单的函数指针的应用. //形式1:返回类型(*函数名)(参数表) char (*pFun)(int); char glFun(int a){ return;} void main() { pFun = glFun; (*pFun)(2); } 第一行定义了一个指针变量pFun.首先我们根据前面提到的“形式1”认识到它是一个指向某种函数的指针, 这种函数参数是一个int型,返回值是char类型.只有第一句我们还无法使用这个指针,

黄聪:wordpress中remove_action、add_action、 do_action()的hook钩子都有哪些

原文地址:http://codex.wordpress.org/Plugin_API/Action_Reference muplugins_loaded After must-use plugins are loaded registered_taxonomy For category, post_tag, etc. registered_post_type For post, page, etc. plugins_loaded After active plugins and pluggabl

php中函数前加&amp;符号的作用分解

这篇文章主要介绍了php中的函数前加&符号的作用分解,其作用叫做引用返回,有点抽象,详细解释请看本文内容,需要的朋友可以参考下  (转载) php变量前面加&符号是什么意思就不用多说了,大家都在用,就是两个变量同时指向一个地址而已,那么,php函数前面加&符号的意义又是什么呢?下面先上两个演示代码,然后再做解释. function &chhua() { static $b = "www.jb51.net"; //申明一个静态变量 $b = $b . &q

板邓:wordpress中add_filter和apply_filters函数用法

add_filter() 可以挂载一个函数到指定的过滤器上. 用法 add_filter( $tag, $function_to_add, $priority, $accepted_args ); 参数 $tag (字符串)(必须)所挂载的过滤器名字(和目标 apply_filters() 函数的 $tag 属性一样). 默认值:None $function_to_add (回调)(必须)要挂载的回调函数,参考 PHP 回调函数类型文档. 默认值:None $priority (整数)(可选)执

matlab中函数的句柄是什么意思?有什么作用?

比定义f(x)=x^2写[email protected](x)(x.^2)其@(x)(x.^2)匿名函数第括号面自变量第二括号面表达式@函数指针[email protected](x)(x.^2)表示匿名函数@(x)(x.^2)赋值给f于f表示该函数于f(2)=2.^2=4:f(1:3)=[1:3].^2=[1 4 9]等等 定义匿名函数调用别匿名函数比[email protected](x,y)(x.^2+y.^2)定义函数x^2+y^2[email protected](t)(f1(t,2

CI框架源代码阅读笔记6 扩展钩子 Hook.php

CI框架同意你在不改动系统核心代码的基础上加入或者更改系统的核心功能(如重写缓存.输出等). 比如,在系统开启hook的条件下(config.php中$config['enable_hooks'] = TRUE;).通过加入特定的钩子,能够让系统在特定的时刻触发特定的脚本: $hook['post_system'] = array( 'class' => 'frameLog', 'function' => 'postLog', 'filename' => 'post_system.php

CI框架源码阅读笔记6 扩展钩子 Hook.php

CI框架允许你在不修改系统核心代码的基础上添加或者更改系统的核心功能(如重写缓存.输出等).例如,在系统开启hook的条件下(config.php中$config['enable_hooks'] = TRUE;),通过添加特定的钩子,可以让系统在特定的时刻触发特定的脚本: $hook['post_system'] = array( 'class' => 'frameLog', 'function' => 'postLog', 'filename' => 'post_system.php'

wordpress分类目录函数:wp_list_cats参数详解

今天修改主题模板时相直接调用分类目录,查了一下分类目录函数wp_list_cats(); WordPress分类目录常用格式 <?php wp_list_cats(“sort_column=ID&hide_empty=0&optioncount=1″);?> 该函数表示:分类目录按ID排列,不显示没有文章的分类,显示分类目录下的文章数量 wp_list_cats函数参数如下: sort_column默认值为ID,可选ID 或 name,分别表示按 ID 值或分类名称排序sort