WordPress源码深度解析之：`WordPress`的`activation hook`：`register_activation_hook()`的底层实现。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷们，今天咱们来聊聊WordPress的激活钩子，也就是register_activation_hook()这玩意儿。这东西听起来玄乎，其实就是你在插件被激活的时候，让WordPress帮你执行一些代码的小助手。

1. 啥是激活钩子？为啥要用它？

想象一下，你写了个WordPress插件，比如一个超炫的图片滑块。当你激活这个插件的时候，你可能需要做一些初始化工作：

创建一些数据库表来存储滑块的数据。
设置一些默认的选项，比如滑块的动画速度。
注册一些自定义的post type，比如“滑块”。

这些操作，总不能让用户手动去执行吧？太low了！这时候，激活钩子就派上用场了。它允许你在插件激活时，自动运行这些初始化代码，让你的插件一激活就能用，用户体验蹭蹭上涨！

2. register_activation_hook()的基本用法

register_activation_hook()函数的基本语法如下：

register_activation_hook( __FILE__, 'your_activation_function' );

__FILE__：这是PHP的一个魔术常量，表示当前文件的完整路径。WordPress用它来识别是哪个插件在注册激活钩子。
'your_activation_function'：这是你定义的函数名，这个函数会在插件激活时被调用。

举个例子，假设你的插件文件是my-awesome-slider.php，你想在激活时创建一个名为my_sliders的数据库表，可以这样写：

<?php
/**
 * Plugin Name: My Awesome Slider
 * Description: A simple image slider plugin.
 * Version: 1.0.0
 * Author: Your Name
 */

function my_awesome_slider_activate() {
  global $wpdb;
  $table_name = $wpdb->prefix . 'my_sliders';
  $charset_collate = $wpdb->get_charset_collate();

  $sql = "CREATE TABLE $table_name (
    id mediumint(9) NOT NULL AUTO_INCREMENT,
    title varchar(255) NOT NULL,
    image_url varchar(255) NOT NULL,
    link_url varchar(255) DEFAULT '',
    PRIMARY KEY  (id)
  ) $charset_collate;";

  require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
  dbDelta( $sql );
}

register_activation_hook( __FILE__, 'my_awesome_slider_activate' );
?>

这段代码做了什么？

定义了一个名为my_awesome_slider_activate()的函数，这个函数包含了创建数据库表的SQL语句。
使用register_activation_hook()函数，将my_awesome_slider_activate()函数注册为激活钩子。当插件被激活时，WordPress会自动调用这个函数。

3. register_activation_hook()的底层实现：源码解析

好了，现在进入正题，咱们来扒一扒register_activation_hook()的源码，看看它到底是怎么工作的。

register_activation_hook()函数位于wp-includes/plugin.php文件中。让我们简化并分解一下相关代码（忽略一些错误处理和兼容性代码）：

function register_activation_hook( $file, $function ) {
  $plugin = plugin_basename( $file );  //获取插件的基础名
  add_action( 'activate_' . $plugin, $function ); //添加一个action
}

是不是很简单？就两行代码！

plugin_basename( $file )： 这个函数的作用是获取插件的基础名。比如，如果$file是/path/to/wp-content/plugins/my-awesome-slider/my-awesome-slider.php，那么plugin_basename($file)就会返回my-awesome-slider/my-awesome-slider.php。也就是插件目录名 + 主插件文件的相对路径。
add_action( 'activate_' . $plugin, $function )： 这才是关键！ add_action()函数是WordPress的核心函数之一，用于将一个函数（$function）绑定到一个特定的动作（'activate_' . $plugin）。

这里，动作的名称是'activate_' . $plugin'。比如，如果$plugin是my-awesome-slider/my-awesome-slider.php，那么动作的名称就是'activate_my-awesome-slider/my-awesome-slider.php'。这个动作会在插件激活时被触发。

也就是说，register_activation_hook()函数实际上就是将你的激活函数绑定到了一个特定的动作上，这个动作的名字是activate_插件的基础名。

4. 插件激活时发生了什么？

当你通过WordPress后台激活一个插件时，WordPress会执行以下步骤（简化）：

加载插件文件。
调用activate_plugin()函数。
在activate_plugin()函数内部，会触发一个动作，这个动作的名字就是'activate_插件的基础名'。
由于你之前使用register_activation_hook()函数将你的激活函数绑定到了这个动作上，所以你的激活函数会被自动调用。

更具体的，我们可以看看wp-admin/includes/plugin.php中activate_plugin()函数的相关部分：

function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silent = false ) {
  //...省略一些权限检查，插件状态判断等等代码

  do_action( 'activate_' . $plugin, $network_wide );

  //...省略一些其他代码
}

看到了吗？ do_action( 'activate_' . $plugin, $network_wide ); 这行代码就是触发激活钩子的关键！它会触发一个名为'activate_' . $plugin的动作，而你之前通过register_activation_hook()注册的函数就会被执行。

5. 激活钩子函数的注意事项

全局作用域： 你的激活函数必须定义在全局作用域中，不能定义在类或者其他函数内部。否则，WordPress找不到你的函数，激活钩子就失效了。
安全性： 在激活函数中执行数据库操作时，一定要注意安全性，防止SQL注入攻击。可以使用$wpdb->prepare()函数来安全地构建SQL查询。
一次性执行： 激活钩子只会在插件激活时执行一次。如果你的插件需要定期执行一些任务，可以使用wp_schedule_event()函数来创建一个定时任务。
长耗时任务： 避免在激活钩子中执行耗时太长的任务，比如下载大型文件或者进行复杂的计算。这可能会导致插件激活超时，影响用户体验。可以将这些任务放到后台进程中执行。
多站点： 如果你的插件需要在WordPress多站点环境下使用，要注意$network_wide参数。这个参数表示插件是在整个网络激活还是在单个站点激活。你需要根据$network_wide的值来执行不同的操作。
升级钩子： 如果你需要升级插件的时候执行一些代码，可以使用update_option()函数来记录插件的版本号，并在激活钩子中检查版本号，如果版本号发生了变化，就执行升级代码。这个实际上是利用了激活钩子+版本判断的方式来模拟升级钩子。真正的升级钩子，wordpress并没有提供直接的register_update_hook函数。

6. 一个更复杂一点的例子：多站点支持

假设你的插件需要在多站点环境下使用，并且需要在整个网络激活时创建一个全局的数据库表，而在单个站点激活时创建一个站点特定的数据库表，可以这样写：

<?php
/**
 * Plugin Name: My Multi-Site Plugin
 * Description: A plugin that supports WordPress multi-site.
 * Version: 1.0.0
 * Author: Your Name
 */

function my_multi_site_plugin_activate( $network_wide ) {
  global $wpdb;

  if ( is_multisite() ) {
    if ( $network_wide ) {
      // 在整个网络激活
      $old_blog = $wpdb->blogid;
      // Get all blog ids
      $blogids = $wpdb->get_col( "SELECT blog_id FROM $wpdb->blogs" );
      foreach ( $blogids as $blog_id ) {
        switch_to_blog( $blog_id );
        my_multi_site_plugin_create_table(); //创建全局表
      }
      switch_to_blog( $old_blog );
      return;
    }
  }
  my_multi_site_plugin_create_table(); //创建站点表
}

function my_multi_site_plugin_create_table() {
  global $wpdb;
  $table_name = $wpdb->prefix . 'my_multi_site_table';
  $charset_collate = $wpdb->get_charset_collate();

  $sql = "CREATE TABLE $table_name (
    id mediumint(9) NOT NULL AUTO_INCREMENT,
    name varchar(255) NOT NULL,
    value text,
    PRIMARY KEY  (id)
  ) $charset_collate;";

  require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
  dbDelta( $sql );
}

register_activation_hook( __FILE__, 'my_multi_site_plugin_activate' );

?>

在这个例子中，my_multi_site_plugin_activate()函数接收一个$network_wide参数，这个参数表示插件是在整个网络激活还是在单个站点激活。

如果$network_wide为true，表示插件是在整个网络激活，那么我们就循环遍历所有的站点，并在每个站点上创建一个数据库表。
如果$network_wide为false，表示插件是在单个站点激活，那么我们就在当前站点上创建一个数据库表。

7. 总结

register_activation_hook()函数是WordPress插件开发中一个非常重要的工具，它可以让你在插件激活时自动执行一些代码，从而简化插件的安装和配置过程，提升用户体验。

记住，register_activation_hook()的底层实现其实很简单，就是将你的激活函数绑定到一个名为'activate_插件的基础名'的动作上。理解了这个原理，你就可以灵活地使用激活钩子来完成各种各样的任务。

希望今天的讲座对你有所帮助！下次有机会再和大家分享更多WordPress开发的技巧。

表格总结关键点

函数/概念	作用	注意事项
`register_activation_hook()`	注册插件激活钩子，将函数绑定到插件激活事件。	激活函数必须定义在全局作用域；注意SQL注入风险；避免耗时操作；考虑多站点环境；没有直接提供升级钩子，需要通过版本判断模拟。
`plugin_basename()`	获取插件的基础名（插件目录名 + 主插件文件的相对路径）。	–
`add_action()`	将函数绑定到一个动作。	–
`do_action()`	触发一个动作，执行所有绑定到该动作的函数。	–
`$network_wide`	多站点环境下，指示插件是在整个网络激活还是在单个站点激活。	在多站点插件开发中需要根据这个参数的值来执行不同的操作。
激活函数	插件激活时需要执行的代码。	保证代码的健壮性和安全性；处理异常情况；避免在激活钩子中进行大量的计算和数据库操作。
升级钩子（模拟）	WordPress没有提供直接的升级钩子，但可以通过在激活钩子中检查插件版本来实现类似的功能。	这需要使用`update_option()`来存储插件的版本号，并在激活钩子中比较当前版本号和存储的版本号。

发表回复 取消回复

发表回复取消回复