l-1

WordPress笔记

主页/WordPress笔记/WordPress开发笔记/多站点/WordPress多站点网络标题的获取方法

WordPress开发笔记

WordPress多站点网络标题的获取方法

通过代码获取WordPress多站点网络中的“网络标题”是一个实用的需求。你可以使用WordPress提供的 get_site_option() 函数来获取在“网络设置”中设置的“网络标题”。

这个“网络标题”通常存储在WordPress的sitemeta表中，对应的选项名（option_name）是 site_name。

以下是具体方法和代码示例：

方法1

// 方法1：使用 get_network_option() 函数 (推荐)
$network_name = get_network_option(null, 'site_name'); // 获取当前网络的名称
echo '网络名称 (方法1 - 推荐): ' . $network_name . '<br>';

get_network_option( $network_id, $key, $default )-2
这是获取网络级别选项的推荐方法。

  • $network_id: 网络ID。传入 null 表示当前网络。
  • $key: 要检索的选项名称，例如 'site_name'。
  • $default: 如果选项不存在时返回的默认值（可选）。
    这个函数会自动处理缓存，效率更高。

    方法2

    在你的主题的functions.php文件中，或者在一个自定义插件的代码中，可以使用以下代码：

    $network_title = get_site_option( 'site_name' );
if ( $network_title ) {
    echo '当前网络标题是：' . $network_title;
} else {
    echo '未找到网络标题。';
}

    代码解释：

    • get_site_option( 'site_name' )：这行代码会从WordPress的网络选项（sitemeta）中查询键为 'site_name' 的值并返回。
    • 接下来的条件判断只是示例，用于安全地处理获取到的结果。如果找到了网络标题，就显示它；如果没有找到（返回了false或空值），则显示一个备选信息。

    你可以将获取到的 $network_title 变量用于任何需要的地方，比如输出到网页前端，或者在后台的管理界面中显示。

    方法3

    // 方法3：直接查询数据库 (一般不推荐，除非有特殊需求)
global $wpdb;
$network_name_db = $wpdb->get_var(
    $wpdb->prepare(
        "SELECT meta_value FROM {$wpdb->sitemeta} WHERE meta_key = %s AND site_id = %d",
        'site_name',
        1 // 通常主网络站点ID为1
    )
);
echo '网络名称 (方法3 - 直接查询数据库): ' . $network_name_db . '<br>';

// 注意：在实际开发中，应添加错误处理逻辑，例如检查返回值是否为空。

    直接数据库查询 ($wpdb->get_var)
    这种方法通常不推荐，因为它绕过了WordPress的缓存机制-1，并且如果操作不当可能带来安全风险（如SQL注入）。只有在非常特殊的情况下才考虑使用。如果必须使用，请务必使用 $wpdb->prepare 来确保查询的安全性。

    使用示例和场景

    假设您的网络名称为 “My Network Hub”，以上任一方法都将返回这个值。

    您可以在主题的 header.php 中显示网络名称：

    // 在主题的 header.php 文件中
$network_name = get_network_option(null, 'site_name', 'My Default Network Name'); // 第三个参数是默认值
echo '<h1>' . esc_html($network_name) . '</h1>'; // 记得对输出进行转义以确保安全

    或者在插件中使用：

    // 在插件开发中，也许需要根据网络名称做一些逻辑判断
if (get_network_option(null, 'site_name') === 'Development Network') {
    // 仅在开发网络上执行某些操作，例如记录日志
}

      注意事项

      1. 运行环境：这段代码必须运行在多站点环境（Network Admin）下才有意义。如果你在非多站点的单一WordPress安装上使用get_site_option()，它默认会返回你主站的选项（option），但 site_name 这个选项通常只在多站点环境下被设置。
      2. 缓存机制：和get_option()一样，get_site_option()函数也有缓存机制，首次查询后会缓存结果，多次调用不会重复查询数据库，效率上有保障。
      3. 使用位置：你可以在主题模板文件、自定义插件、或者甚至是必须在网络级别激活的插件中使用此代码。
      4. 缓存机制：get_network_option 和 get_site_option 函数会自动缓存查询结果-1，这有助于提高性能。直接查询数据库则无法利用这种缓存。
      5. 输出转义：当您将从数据库获取的值输出到HTML页面上时，务必使用 esc_html() 或类似的函数进行转义，以防止XSS攻击。
      6. 错误处理：好的实践是总是假设选项可能不存在（例如，新安装或配置错误），因此使用函数时提供一个有意义的默认值是个好习惯。
      7. 数据库表前缀：在代码示例中，{$wpdb->sitemeta} 会自动使用正确的前缀（如 wp_），您不需要也不应该手动修改它。$wpdb 对象会自动处理表前缀。
      8. 网络ID：在绝大多数情况下，主网络的ID是 1。如果您明确知道要获取哪个网络的名称，可以指定 $network_id。

      扩展信息：网络设置与管理

      • “网络标题”可以在多站点网络的网络管理员后台进行设置。具体路径是：进入 “我的站点” -> “管理网络” -> “设置”（Network Admin -> Settings -> Network Settings）。你在这里修改的“网络标题”（Network Title）就会对应 site_name 这个选项值。
      • get_site_option() 函数是管理多站点全局设置的强大工具，除了获取site_name，还可以获取其他网络级别的设置。