WordPress教程 - 什么是Hook钩子?

wordpress的插件就是通过各种各样的Hook钩子来实现的,wordpress提供了非常丰富的钩子,你可以通过Hook钩子给主题拓展出各种各样有趣的功能来吸引您的主题用户

如果你作为一名wordpress主题的开发者还不知道啥事wordpress的Hook钩子,那可就太落伍了,其实wordpress的插件就是通过各种各样的Hook钩子来实现的,wordpress提供了非常丰富的钩子,你可以通过Hook钩子给主题拓展出各种各样有趣的功能来吸引您的主题用户。

不过,wordpress的Hook钩子固然强大,但使用起来也是蛮复杂的,下面就来给大家介绍下吧。

WordPress教程 - 什么是Hook钩子?-Npcink
背景图片

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

动作钩子

wp_head()函数就有一个很典型的 Hook 动作,大部分主题的 head 标签中都加入此函数。其中的钩子为:wp_head。插件和WordPress核心都通过给 wp_head 添加钩子函数来向网站的 head 标签中加入内容。例:

function my_wp_head() {
    echo '<meta name="keywords" content="WordPress" />';
}
add_action('wp_head', 'my_wp_head');

提交代码后,查看前台的网页源代码,就可以在 head 标签里看到刚刚添加的内容了。

这边只是是演示一个最简单的例子。利用这个钩子,我们还可以做一个发生访问 404 向管理员邮箱发送一封邮件的动作。

// 发生404 向管理员邮箱发送邮件
function HN_404_page_mail(){
  if( !is_404() ) return;//如果正常访问页面则退出该函数
  $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', 'HN_404_page_mail' );

挂钩函数可以选择接受从动作调用的参数,如果有任何要传递的话。在这个简单的例子中,echo_comment_id 函数需要 $comment_id 参数,该参数将在 comment_id_not_found 过滤钩子运行时通过 do_action() 传递。

function echo_comment_id( $comment_id ) // 注意$comment_id就是动作调用的参数传递过来的
{
   echo 'Comment ID ' . $comment_id . ' could not be found';
}
add_action( 'comment_id_not_found', 'echo_comment_id', 10, 1 );

过滤器钩子

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

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

//文章内容图片自动加ALT属性为文章标题
function kratos_auto_post_link($content)//$content 变量就是文章内容,因为其它过滤器也要过滤,所以这个内容可能是经过其它函数过滤的
 {
  global $post;
  $content = preg_replace('/<\s*img\s+[^>]*?src\s*=\s*(\'|\")(.*?)\\1[^>]*?\/?\s*>/i', "<img layer-src=\"$2\" src=\"$2\" alt=\"《".$post->post_title."》\" />", $content);
  return $content;//必须要把过滤后的内容返回回去,否则值就丢了
  }
add_filter ('the_content', 'kratos_auto_post_link',0);

其他

要找出一个动作的参数的ID和名称,只需搜索匹配 do_action() 调用的代码库。举例来说,如果你挂载到’save_post’,你会在 post.php 找到:

<?php do_action( 'save_post', $post_ID, $post ); ?>

你的 add_action 调用将是这样:

<?php add_action( 'save_post', 'my_save_post', 10, 2 ); ?>

而且你的函数将是这样:

function my_save_post( $post_ID, $post )
{
   // do stuff here
}

钩子原理

实际上,在调用 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开发的全部内容了,光说不练假把式,来看看这个案例是咋通过wordpress的Hook钩子来实现一个实用的功能的。

WordPress教程 - 什么是Hook钩子?-Npcink
WordPress教程 - 什么是Hook钩子?-Npcink

wordpress美化 - 美观的文章页底部版权声明

这次的wordpress美化教程可以在你的文章底部添加一些有趣的信息,给你的网站访客展现更多有趣的内容,例如转载声明或是加群链接
2020-03-19
WP开发

WordPress开发 - options framework基础应用

2020-3-17 23:04:05

WP开发

wordpress开发 - 如何调用最新,随机,热门,指定分类文章?

2020-3-23 23:19:01

⚠️
Npcink上的部份代码及教程来源于互联网,仅供网友学习交流,未经Npcink作者或上传书面授权,请勿作他用。
若您的权利被侵害,请联系站长 QQ: 1355471563 或 点击右侧 私信:Muze 反馈,我们将尽快处理。
0 条回复 A文章作者 M管理员
    暂无讨论,说说你的看法吧
个人中心
购物车
优惠劵
今日签到
有新私信 私信列表
有新消息 消息中心
搜索