解析 WordPress `get_current_blog_id()` 函数的源码：如何获取当前站点的 ID。

各位程序猿、攻城狮、以及还在代码海洋里挣扎的小伙伴们，大家好！今天，咱们来聊聊 WordPress 里一个看似简单，但背后却隐藏着不少门道的函数：get_current_blog_id()。

准备好了吗？开始我们的探险之旅吧！

开场白：多站点宇宙的身份证

在 WordPress 的世界里，特别是多站点（Multisite）模式下，每个站点都有自己的身份，就像每个人都有自己的身份证号一样。get_current_blog_id() 函数就是用来获取当前站点的这个“身份证号”的。这个“身份证号”就是站点 ID，是一个整数。

源码剖析：扒开函数的“皮”

让我们直接来看一下 get_current_blog_id() 函数的源码（基于 WordPress 6.4 版本）：

/**
 * Gets the ID of the current blog.
 *
 * @since 3.0.0
 *
 * @return int ID of the current blog.
 */
function get_current_blog_id() {
    global $blog_id;

    return (int) $blog_id;
}

惊不惊喜？意不意外？就这么几行代码！

代码解读：简单粗暴的真相

• global $blog_id;：这行代码声明了 $blog_id 是一个全局变量。在 WordPress 的多站点环境中，$blog_id 这个全局变量存储着当前站点的 ID。 记住，全局变量的使用需要谨慎，因为它可能会在不经意间被其他地方的代码修改。
• return (int) $blog_id;：这行代码将 $blog_id 强制转换为整数类型，然后返回。 这样做是为了确保返回值的类型是 int，避免出现意外的类型错误。

就这么简单，get_current_blog_id() 函数的功能就是从全局变量 $blog_id 中获取当前站点的 ID，并将其转换为整数类型返回。

幕后英雄：wp-settings.php 的功劳

你可能会问，$blog_id 这个全局变量是在哪里定义的？答案就在 wp-settings.php 文件中。

在 WordPress 加载的早期阶段，wp-settings.php 文件会被执行。在这个文件中，会根据当前请求的 URL 和 WordPress 的配置，来确定当前站点的 ID，并将其赋值给 $blog_id 全局变量。

简单来说，wp-settings.php 就像一个侦探，它会根据线索（URL、配置等）来找到当前站点的身份，然后将这个身份信息（站点 ID）告诉 $blog_id。

使用场景：站点 ID 的妙用

get_current_blog_id() 函数在 WordPress 开发中有很多用途，下面列举一些常见的场景：

• 区分站点： 在多站点环境中，可以使用站点 ID 来区分不同的站点，从而执行不同的操作。例如，可以根据站点 ID 加载不同的主题文件、插件设置或数据库表。

  $current_blog_id = get_current_blog_id();
  
  if ( $current_blog_id == 2 ) {
      // 在站点 ID 为 2 的站点上执行的操作
      echo '这是站点 2！';
  } else {
      // 在其他站点上执行的操作
      echo '这不是站点 2！';
  }

• 操作特定站点的数据： WordPress 的数据库表是共享的，但在多站点环境中，每个站点都有自己的表前缀。可以使用站点 ID 来构建特定站点的表名，从而操作该站点的数据。

  global $wpdb;
  $current_blog_id = get_current_blog_id();
  $table_name = $wpdb->prefix . $current_blog_id . '_options'; // 构建站点特定的 options 表名
  
  // 查询站点特定的 options 表
  $results = $wpdb->get_results( "SELECT * FROM {$table_name} WHERE option_name = 'my_option'" );

• 生成站点特定的 URL： 可以使用站点 ID 来生成指向特定站点的 URL。例如，可以生成指向某个站点首页的链接。

  $current_blog_id = get_current_blog_id();
  $site_url = get_home_url( $current_blog_id ); // 获取站点 ID 为 $current_blog_id 的站点的 URL
  
  echo '<a href="' . $site_url . '">访问站点</a>';

• 判断是否是主站点： 在多站点环境中，通常会有一个主站点（ID 为 1）。可以使用 get_current_blog_id() 函数来判断当前站点是否是主站点。

  $current_blog_id = get_current_blog_id();
  
  if ( $current_blog_id == 1 ) {
      // 这是主站点
      echo '这是主站点！';
  } else {
      // 这不是主站点
      echo '这不是主站点！';
  }

使用技巧：避免踩坑

• 确保在合适的上下文中调用： get_current_blog_id() 函数依赖于全局变量 $blog_id。在 WordPress 加载的早期阶段，$blog_id 可能还没有被正确赋值。因此，应该确保在合适的上下文中调用该函数，例如在 wp 钩子之后。

  add_action( 'wp', 'my_function' );
  
  function my_function() {
      $current_blog_id = get_current_blog_id();
      // 在这里使用 $current_blog_id
  }

• 注意类型转换： get_current_blog_id() 函数返回的是一个整数。在使用返回值时，应该注意类型转换，避免出现类型错误。

• 了解多站点环境： get_current_blog_id() 函数主要用于多站点环境。在单站点环境中，该函数通常返回 1。

高级用法：深入挖掘

• switch_to_blog() 和 restore_current_blog()： 这两个函数可以用来临时切换当前站点。switch_to_blog( $blog_id ) 可以将当前站点切换到指定的站点 ID，restore_current_blog() 可以恢复到之前的站点。 这两个函数通常与 get_current_blog_id() 配合使用，可以在不同的站点之间切换，并执行相应的操作。

  $current_blog_id = get_current_blog_id(); // 保存当前站点 ID
  
  switch_to_blog( 2 ); // 切换到站点 ID 为 2 的站点
  
  // 在站点 ID 为 2 的站点上执行的操作
  echo '当前站点是：' . get_current_blog_id();
  
  restore_current_blog(); // 恢复到之前的站点
  
  echo '当前站点是：' . get_current_blog_id(); // 应该输出之前的站点 ID

• get_sites()： 这个函数可以获取所有站点的列表。可以遍历站点列表，并使用 switch_to_blog() 和 restore_current_blog() 函数，对每个站点执行相同的操作。

  $sites = get_sites();
  
  foreach ( $sites as $site ) {
      switch_to_blog( $site->blog_id );
  
      // 在每个站点上执行的操作
      echo '当前站点是：' . get_current_blog_id();
  
      restore_current_blog();
  }

最佳实践：代码示例

下面是一个更完整的代码示例，展示了如何使用 get_current_blog_id() 函数来加载站点特定的 CSS 文件：

add_action( 'wp_enqueue_scripts', 'my_enqueue_styles' );

function my_enqueue_styles() {
    $current_blog_id = get_current_blog_id();
    $stylesheet_url = get_stylesheet_directory_uri() . '/style-' . $current_blog_id . '.css';

    if ( file_exists( get_stylesheet_directory() . '/style-' . $current_blog_id . '.css' ) ) {
        wp_enqueue_style( 'my-style', $stylesheet_url );
    } else {
        // 如果站点特定的 CSS 文件不存在，则加载默认的 CSS 文件
        wp_enqueue_style( 'my-style', get_stylesheet_uri() );
    }
}

这段代码首先获取当前站点的 ID，然后构建站点特定的 CSS 文件的 URL。如果该文件存在，则加载该文件；否则，加载默认的 CSS 文件。 这样做可以为每个站点提供不同的外观，而无需创建多个主题。

表格总结：

函数名	功能	返回值类型	使用场景	注意事项
get_current_blog_id()	获取当前站点的 ID	int	区分站点、操作特定站点的数据、生成站点特定的 URL、判断是否是主站点等。	确保在合适的上下文中调用，注意类型转换，了解多站点环境。
switch_to_blog( $blog_id )	临时切换当前站点到指定的站点 ID	void	与 get_current_blog_id() 配合使用，可以在不同的站点之间切换，并执行相应的操作。	需要与 restore_current_blog() 配合使用，以恢复到之前的站点。
restore_current_blog()	恢复到之前的站点	void	与 switch_to_blog() 配合使用，恢复到之前的站点。	必须在 switch_to_blog() 之后调用。
get_sites()	获取所有站点的列表	array	遍历站点列表，并使用 switch_to_blog() 和 restore_current_blog() 函数，对每个站点执行相同的操作。	返回的是一个包含站点信息的数组。
$blog_id (全局变量)	存储当前站点的 ID	int	get_current_blog_id() 函数的幕后英雄。	全局变量，谨慎使用。在 WordPress 加载的早期阶段可能还没有被正确赋值。

常见问题：

• 为什么 get_current_blog_id() 在单站点环境中返回 1？ 因为在单站点环境中，只有一个站点，其 ID 默认为 1。

• 如何在 AJAX 请求中使用 get_current_blog_id()？ 在 AJAX 请求中，可能无法直接访问 $blog_id 全局变量。可以使用 switch_to_blog() 和 restore_current_blog() 函数来确保在正确的站点上下文中执行操作。 另一种方法是在 AJAX 请求中传递站点 ID。

• get_current_site_id() 和 get_current_blog_id() 有什么区别？ get_current_site_id() 返回的是当前网络的 ID，而 get_current_blog_id() 返回的是当前站点的 ID。在大多数情况下，网络 ID 和站点 ID 是相同的，但在某些特殊情况下，它们可能不同。

总结：

get_current_blog_id() 函数虽然简单，但在 WordPress 多站点开发中却扮演着重要的角色。理解其原理和使用场景，可以帮助我们更好地开发 WordPress 插件和主题，并构建更强大的多站点应用。

希望今天的分享对你有所帮助！ 记住，代码的世界充满了乐趣，多思考，多实践，你也能成为一名优秀的 WordPress 开发者！ 下次再见！