解析WordPress中函数钩子hook的作用及基本用法


Posted in PHP onDecember 22, 2015

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 标签里看到我们添加的内容了。

解析WordPress中函数钩子hook的作用及基本用法

上边是一个简单的例子,只是打印了一句话。利用这个钩子,我们还可以做一个遇到 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' );

过滤器钩子

根据我的亲身经历,可能过滤器钩子会难理解些,尤其对不熟悉 PHP 的人来说。

过滤器钩子可以让你改一些东西的值,过滤器回调函数会接受一个参数,这就是当前的值。还记得那个用来调用文章内容的 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>

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

解析WordPress中函数钩子hook的作用及基本用法

PHP 相关文章推荐
其他功能
Oct 09 PHP
PHP array_flip() 删除重复数组元素专用函数
May 16 PHP
PHP include_path设置技巧分享
Jul 03 PHP
PHP实现手机归属地查询API接口实现代码
Aug 27 PHP
php分页代码学习示例分享
Feb 20 PHP
php使用unset()删除数组中某个单元(键)的方法
Feb 17 PHP
PHP单例模式详细介绍
Jul 01 PHP
CodeIgniter钩子用法实例详解
Jan 20 PHP
关于php中的json_encode()和json_decode()函数的一些说明
Nov 20 PHP
PHP基于ORM方式操作MySQL数据库实例
Jun 21 PHP
yii2.0整合阿里云oss上传单个文件的示例
Sep 19 PHP
php+js实现的无刷新下载文件功能示例
Aug 23 PHP
WordPress中使主题支持小工具以及添加插件启用函数
Dec 22 #PHP
配置eAccelerator和XCache扩展来加速PHP程序的执行
Dec 22 #PHP
PHP使用mkdir创建多级目录的方法
Dec 22 #PHP
PHP按指定键值对二维数组进行排序的方法
Dec 22 #PHP
php删除数组中重复元素的方法
Dec 22 #PHP
yii2.0实现验证用户名与邮箱功能
Dec 22 #PHP
PHP内核探索之解释器的执行过程
Dec 22 #PHP
You might like
php处理文件的小例子(解压缩,删除目录)
2013/02/03 PHP
关于url地址传参数时字符串有回车造成页面脚本赋值失败的解决方法
2013/06/28 PHP
PHP常用工具函数小结【移除XSS攻击、UTF8与GBK编码转换等】
2019/04/27 PHP
javascript 写类方式之三
2009/07/05 Javascript
Ext grid 添加右击菜单
2009/11/26 Javascript
深入理解JSON数据源格式
2014/01/10 Javascript
javascript函数作用域学习示例(js作用域)
2014/01/13 Javascript
jQuery判断浏览器并动态调整select宽度的方法
2016/03/02 Javascript
AngularJs定制样式插入到ueditor中的问题小结
2016/08/01 Javascript
基于JavaScript实现鼠标箭头移动图片跟着移动
2016/08/30 Javascript
jQuery+HTML5实现弹出创意搜索框层
2016/12/29 Javascript
在javaScript中检测数据类型的几种方式小结
2017/03/04 Javascript
微信小程序 在线支付功能的实现
2017/03/14 Javascript
B/S(Web)实时通讯解决方案分享
2017/04/06 Javascript
React入门教程之Hello World以及环境搭建详解
2017/07/11 Javascript
微信小程序开发之自定义tabBar的实现
2018/09/06 Javascript
在node环境下parse Smarty模板的使用示例代码
2019/11/15 Javascript
修改vue源码实现动态路由缓存的方法
2020/01/21 Javascript
[02:05:03]完美世界DOTA2联赛循环赛 LBZS VS Matador BO2 10.28
2020/10/28 DOTA
python使用PyFetion来发送短信的例子
2014/04/22 Python
python比较2个xml内容的方法
2015/05/11 Python
python中的编码知识整理汇总
2016/01/26 Python
python基于itchat实现微信群消息同步机器人
2017/02/27 Python
django反向解析URL和URL命名空间的方法
2018/06/05 Python
Windows系统Python直接调用C++ DLL的方法
2019/08/01 Python
Python 使用matplotlib模块模拟掷骰子
2019/08/08 Python
Python页面加载的等待方式总结
2021/02/28 Python
HTML5 CSS3实现一个精美VCD包装盒个性幻灯片案例
2014/06/16 HTML / CSS
绩效管理实施方案
2014/03/19 职场文书
房屋委托书范本
2014/04/04 职场文书
竞选班干部演讲稿100字
2014/08/20 职场文书
在 Golang 中实现 Cache::remember 方法详解
2021/03/30 Python
Java基础之this关键字的使用
2021/06/30 Java/Android
Windows和Linux上部署Golang并运行程序
2022/04/22 Servers
MySQL外键约束(Foreign Key)案例详解
2022/06/28 MySQL
uniapp开发打包多端应用完整方法指南
2022/12/24 Javascript