解析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 相关文章推荐
smarty简单分页的实现方法
Oct 27 PHP
一个比较不错的PHP日历类分享
Nov 18 PHP
php常用hash加密函数
Nov 22 PHP
支持png透明图片的php生成缩略图类分享
Feb 08 PHP
如何批量清理系统临时文件(语言:C#、 C/C++、 php 、python 、java )
Feb 01 PHP
PHP的Yii框架中使用数据库的配置和SQL操作实例教程
Mar 17 PHP
thinkPHP框架可添加js事件的分页类customPage.class.php完整实例
Mar 16 PHP
PHPMailer使用QQ邮箱实现邮件发送功能
Aug 18 PHP
PHP自定义函数实现数组比较功能示例
Oct 19 PHP
php伪静态验证码不显示的解决方案
Sep 26 PHP
laravel框架模型和数据库基础操作实例详解
Jan 25 PHP
PHP sdk实现在线打包代码示例
Dec 09 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
PHP5 安装方法
2007/01/15 PHP
浅析PHP中的字符串编码转换(自动识别原编码)
2013/07/02 PHP
PHP开发制作一个简单的活动日程表Calendar
2016/06/20 PHP
php7 新增功能实例总结
2020/05/25 PHP
Wordpress ThickBox 点击图片显示下一张图的修改方法
2010/12/11 Javascript
解决遍历时Array.indexOf产生的性能问题
2012/07/03 Javascript
上传的js验证(图片/文件的扩展名)
2013/04/25 Javascript
显示今天的日期js代码(阳历和农历)
2014/09/30 Javascript
javascript拖拽应用实例(二)
2016/03/25 Javascript
vue项目国际化vue-i18n的安装使用教程
2018/03/14 Javascript
jquery 实现拖动文件上传加载进度条功能
2018/03/18 jQuery
vue 使用自定义指令实现表单校验的方法
2018/08/28 Javascript
让python json encode datetime类型
2010/12/28 Python
详解Python的Django框架中的通用视图
2015/05/04 Python
Python使用django获取用户IP地址的方法
2015/05/11 Python
python getopt详解及简单实例
2016/12/30 Python
python生成excel的实例代码
2017/11/08 Python
用python实现的线程池实例代码
2018/01/06 Python
Python实现读取txt文件并转换为excel的方法示例
2018/05/17 Python
GitHub 热门:Python 算法大全,Star 超过 2 万
2019/04/29 Python
python urllib爬虫模块使用解析
2019/09/05 Python
Python接口自动化系列之unittest结合ddt的使用教程详解
2021/02/23 Python
css3圆角样式分享自定义按钮样式
2013/12/27 HTML / CSS
Backcountry旗下的户外商品闪购网站:steep&cheap
2016/09/22 全球购物
国外平面设计素材网站:The Hungry JPEG
2017/03/28 全球购物
美国著名的女性内衣零售商:Frederick’s of Hollywood
2018/02/24 全球购物
瑞士最大的图书贸易公司:Orell Füssli
2019/12/28 全球购物
英文版银行求职信
2013/10/09 职场文书
美术教师自我鉴定
2014/02/12 职场文书
司机职责范本
2014/03/08 职场文书
合作经营协议书范本
2014/04/17 职场文书
拾金不昧锦旗标语
2014/06/27 职场文书
竞选学习委员演讲稿
2014/09/01 职场文书
2015年社区文体活动总结
2015/03/25 职场文书
Python学习开发之图形用户界面详解
2021/08/23 Python
Kubernetes关键组件与结构组成介绍
2022/03/31 Servers