解析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 相关文章推荐
php echo()和print()、require()和include()函数区别说明
Mar 27 PHP
深入理解PHP之require/include顺序 推荐
Jan 02 PHP
写php分页时出现的Fatal error的解决方法
Apr 18 PHP
php生成短网址示例
May 05 PHP
php中替换字符串中的空格为逗号','的方法
Jun 09 PHP
php实现与erlang的二进制通讯实例解析
Jul 23 PHP
PHP动态生成指定大小随机图片的方法
Mar 25 PHP
浅谈PHP中的Trait使用方法
Mar 22 PHP
php中目录操作opendir()、readdir()及scandir()用法示例
Jun 08 PHP
Yii框架的路由配置方法分析
Sep 09 PHP
Laravel 模型关联基础教程详解
Sep 17 PHP
PHP使用openssl扩展实现加解密方法示例
Feb 20 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
CakePHP框架Session设置方法分析
2017/02/23 PHP
php实现微信企业付款到个人零钱功能
2018/10/09 PHP
JS左右无缝滚动(一般方法+面向对象方法)
2012/08/17 Javascript
js 上下左右键控制焦点(示例代码)
2013/12/14 Javascript
jquery解析xml字符串示例分享
2014/03/25 Javascript
如何利用JS通过身份证号获取当事人的生日、年龄、性别
2016/01/22 Javascript
浅析JavaScript中的对象类型Object
2016/05/26 Javascript
Ajax与服务器(JSON)通信实例代码
2016/11/05 Javascript
js点击任意区域弹出层消失实现代码
2016/12/27 Javascript
jQuery中的一些小技巧
2017/01/18 Javascript
Vue2.0表单校验组件vee-validate的使用详解
2017/05/02 Javascript
详解webpack中的hash、chunkhash、contenthash区别
2018/01/05 Javascript
微信小程序switch开关选择器使用详解
2018/01/31 Javascript
VUE 3D轮播图封装实现方法
2018/07/03 Javascript
javascript对HTML字符转义与反转义
2018/12/13 Javascript
详解Bootstrap 学习(一)入门
2019/04/12 Javascript
三分钟教你用Node做一个微信哄女友(基友)神器(面向小白)
2019/06/21 Javascript
Vue解析剪切板图片并实现发送功能
2020/02/04 Javascript
Python类的多重继承问题深入分析
2014/11/09 Python
python实现发送邮件功能代码
2017/12/14 Python
分析Python中解析构建数据知识
2018/01/20 Python
python实现微信远程控制电脑
2018/02/22 Python
python读写LMDB文件的方法
2018/07/02 Python
django用户登录和注销的实现方法
2018/07/16 Python
python2爬取百度贴吧指定关键字和图片代码实例
2019/08/14 Python
Python 异步协程函数原理及实例详解
2019/11/13 Python
python爬虫---requests库的用法详解
2020/09/28 Python
5分钟让你掌握css3阴影、倒影、渐变小技巧(小编推荐)
2016/08/15 HTML / CSS
CSS3模拟动画下拉菜单效果
2017/04/12 HTML / CSS
TecoBuy澳大利亚:在线电子和小工具商店
2020/06/25 全球购物
财务工作者先进事迹材料
2014/01/17 职场文书
初中升旗仪式演讲稿
2014/05/08 职场文书
2014幼儿园家长工作总结
2014/11/10 职场文书
拯救大兵瑞恩观后感
2015/06/09 职场文书
解决MultipartFile.transferTo(dest) 报FileNotFoundExcep的问题
2021/07/01 Java/Android
mysql 排序失效
2022/05/20 MySQL