构建支持多站点的插件和主题

在为 WordPress 多站点网络开发主题或插件时,需要考虑一些与为单站点 WordPress 安装开发略有不同的事项。

在本课中,你将了解一些需要考虑的差异,以及如何确保你的插件和主题支持多站点。

开发主题和子主题

通常,主题和子主题在多站点网络上的工作方式与在单站点上完全相同。一旦主题或子主题被网络激活,它就可以在网络上的任何单个站点上激活。

你可能想要编码到 functions.php 文件中的所有特定功能都将在当前主题的范围内工作。例如,如果你想要在主题的页脚中显示站点名称,你可以使用标准的 get_bloginfo 函数来检索站点名称。

if ( ! function_exists( 'tt3c_get_site_name' ) ) {
    function tt3c_get_site_name() {
        return get_bloginfo( 'name' );
    }
}

然而,假设你想要在主题的页脚中包含主站点的名称,无论当前正在查看哪个站点。你可以使用 switch_to_blog 函数切换到主站点,检索站点名称,然后恢复当前站点。

if ( ! function_exists( 'tt3c_get_site_name' ) ) {
    function tt3c_get_site_name() {
        $site_name = get_bloginfo( 'name' );
        switch_to_blog( 1 );
        $main_site_name = get_bloginfo( 'name' );
        restore_current_blog();

        return $site_name . ' (part of the ' . $main_site_name . ' network)';
    }
}

更进一步,也许你想要仅将主站点排除在此自定义功能之外。你可以使用 is_main_site 函数来检查当前站点是否为主站点,如果是,则直接返回站点名称。

if ( ! function_exists( 'tt3c_get_site_name' ) ) {
    function tt3c_get_site_name() {
        if ( is_main_site() ) {
            return get_bloginfo( 'name' );
        }

        $current_site = get_bloginfo( 'name' );
        switch_to_blog( 1 );
        $main_site_name = get_bloginfo( 'name' );
        restore_current_blog();
        return $current_site . ' (part of the ' . $main_site_name . ' network)';
    }
}

所有这些都可以通过单个子主题中的一个 functions.php 文件实现。

开发插件

如前所述,大多数插件功能在单站点和多站点上的工作方式相同。像 register_post_typeget_posts 这样的函数将以相同的方式运行,只是在特定站点的范围内。

然而,在为多站点开发插件时,需要考虑两件事。

插件通常有一个设置页面,通常可以从管理仪表板访问。这对于单站点插件来说没问题,但在多站点网络上,你需要考虑设置页面应该位于何处。它应该位于网络管理仪表板上,还是位于单个站点仪表板上?

如果你需要在网络管理仪表板上有一个设置页面,你可以使用 network_admin_menu 钩子向网络管理仪表板添加一个菜单项。如果你需要在单个站点仪表板上有一个设置页面,你可以使用 admin_menu 钩子向单个站点仪表板添加一个菜单项。

插件可能必须添加自定义表来存储自定义数据。如果你使用像 $wpdb->prefix 这样的变量来为你的表名添加前缀,你最终会得到一个以站点 ID 为前缀的表名。因此,如果你需要为每个站点提供此功能的自定义表,你需要提前规划。

让我们看一个例子。

这里我们有来自《安全开发插件入门》教程的示例插件。它有一个在插件激活时创建的 form_submissions 表,用于存储表单提交数据。如果你查看代码,你会看到表名以全局 $wpdb 对象的前缀属性为前缀。

在单站点安装中,这意味着它将使用 wp-config.php 文件中定义的前缀创建一个表,在此示例中为 wp_form_submissions

然而,在多站点网络上,根据插件的安装方式,它将创建不同的表。

如果它在网络上的单个站点上激活,表前缀将包含站点 ID。

因此,对于站点 2,表名将是 wp_2_form_submissions

然而,如果插件是网络激活的,激活过程将在主站点的范围内运行,并且它会创建与在单站点安装上激活时相同的表。

因此,对于网络激活,表名将是 wp_form_submissions

问题出现在你查看存储表单提交数据的代码时。

因为这也使用了全局 $wpdb 对象中的相同前缀属性,当此代码在主站点的范围内运行时,它将查找 wp_form_submissions 表来存储数据,但是,例如,当它在网络上的站点 2 的范围内运行时,它将查找 wp_2_form_submissions 来存储数据,而该表并不存在。

为了解决这个问题,我们需要更新插件激活例程,以考虑到这一点:

首先,将表创建代码移动到一个单独的函数中,然后从激活钩子调用此函数。

function wp_learn_create_table(){
    global $wpdb;
    $table_name = $wpdb->prefix . 'form_submissions';

    $sql = "CREATE TABLE $table_name (
      id mediumint(9) NOT NULL AUTO_INCREMENT,
      name varchar (100) NOT NULL,
      email varchar (100) NOT NULL,
      PRIMARY KEY  (id)
    )";

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

在 register_activation_hook 钩子的文档中,你会注意到回调函数接受一个 $network_wide 参数。这是一个布尔值,传递给激活钩子回调,指示插件是否正在网络范围内激活。

然后,你可以更新回调函数,首先检查站点是否为多站点网络,以及插件是否正在网络范围内激活。

如果是,则获取并遍历网络中的所有站点,依次切换到每个站点,并为每个站点创建数据表。

或者,如果插件未在网络范围内激活,则只需为当前站点创建数据表即可。

register_activation_hook( __FILE__, 'wp_learn_setup_table' );
function wp_learn_setup_table( $network_wide ) {
    if ( is_multisite() && $network_wide ) {
        $sites = get_sites();
        foreach ( $sites as $site ) {
            switch_to_blog( $site->blog_id );
            wp_learn_create_table();
            restore_current_blog();
        }
    } else {
        wp_learn_create_table();
    }
}

通过在网络上激活插件来测试此功能,您应该会看到所有正确的数据表都已创建。

但是,当创建新站点时会发生什么?在这种情况下,您需要使用像 wp_initialize_site 这样的钩子,为新站点创建数据表。

add_action( 'wp_initialize_site', 'wp_learn_setup_newsite_table' );
function wp_learn_setup_newsite_table( $site ) {
    switch_to_blog( $site->id );
    wp_learn_create_table();
    restore_current_blog();
}

通过创建一个新站点来测试这一点。它应该会在数据库中为该站点的表单提交创建新的数据表。

通过这种方式,您可以让插件在多站点网络上正常工作,无论是在网络上首次激活时(考虑到所有现有站点),还是为将来可能创建的新站点做好准备。

在哪里获取更多信息

除了关于创建网络以及创建网络前需考虑事项的文档外,针对多站点开发的开发者专用文档并不多。

不过,您可以通过浏览 WordPress 代码参考中的多站点包部分,查看所有与多站点相关的功能列表。

开发多站点网络

WordPress 核心包含一组函数和钩子,用于控制网络的某些方面或网络中的单个站点。

在本课中,你将了解需要注意的多站点特定函数命名约定,然后深入探讨一些有用的多站点特定函数和钩子。最后,你将学习如何为网络中的单个站点进行开发,以及在哪里可以获取关于多站点函数和钩子的更多信息。

关于命名约定的说明

WordPress 代码库中,关于多站点存在几种不同的命名约定。

WordPress 多站点最初被称为 WordPress MU(或 WordPress 多用户),许多与多站点相关的函数和钩子都使用 wpmu_ 前缀。

此外,一些函数基于旧术语命名,这些旧术语描述了一个“站点”上的多个“博客”。现在这已被更新为描述一个“网络”上的多个“站点”,但一些旧术语仍然存在于某些函数名称中。

有用的函数

当你开发一个支持多站点网络的产品时,了解一些有用的内部函数是值得的。

第一个是 is_multsite 函数。如果启用了多站点,此函数将返回 true,并且可能是与多站点相关的最广泛使用的函数。如果你在 WordPress 代码库中搜索 is_multsite 函数的使用情况,你会看到它在许多地方被使用,要么是在多站点网络上下文中执行特定任务,要么是将功能限制为仅适用于多站点网络。

还有一些常用函数在开发多站点网络的管理界面时非常有用:

  • is_super_admin 可用于检查当前登录用户是否为网络上的网络管理员。
  • is_network_admin 是 is_admin 函数的多站点等效项,用于确定当前请求是否针对网络管理界面。
  • network_admin_url 是 admin_url 函数的多站点等效项,允许你创建相对于网络管理区域的 URL。这对于重定向到网络管理仪表板的不同区域非常有用。

在处理站点内容时,有一些广泛使用的函数。

is_main_site 确定当前站点是否是当前网络的主站点。

接下来是 get_sites 函数,它将返回与请求参数匹配的站点列表。

然后是 switch_to_blog,它允许你切换到网络中的不同站点,restore_current_blog 在你切换到不同站点后恢复当前站点,以及 get_current_blog_id,它返回当前站点的 ID。

使用这些函数,你可以在整个网络中执行操作。

例如,假设你想创建一个函数来更新网络中特定站点上的一个选项。

function update_site_option( $site_id,  $option_name, $option_value ) {
    switch_to_blog( $site_id );
    update_option(  $option_name, $option_value );
    restore_current_blog();
}

但是,如果你想扩展该功能以在所有站点上更新相同的选项,你可以使用 get_sites 函数,并遍历网络中的所有站点。

function update_option_on_all_sites( $option_name, $option_value ) {
    $sites = get_sites();
    foreach ( $sites as $site ) {
        switch_to_blog( $site->blog_id );
        update_option( 'my_option', 'my_value' );
        restore_current_blog();
    }
}

你也可以使用 update_blog_option 函数来更新特定站点上的选项,而无需切换到该站点。

function update_option_on_all_sites( $option_name, $option_value ) {
    $sites = get_sites();
    foreach ( $sites as $site ) {
        update_blog_option( $site->blog_id, $option_name, $option_value );
    }
}

在开发多站点插件时,有 is_network_only_plugin 函数。这是一个特定于插件的函数,用于检查插件头部中的“Network: true”,以确定是否应仅作为网络范围的插件激活。如果你想限制一个插件只能在整个网络上激活,而不能在单个站点上激活,这将非常有用。

有用的钩子

在开发多站点时,还有一些有用的钩子可以使用。

第一个是 network_admin_menu 钩子,它允许你向网络管理仪表板添加菜单项。如果你想向网络管理仪表板添加自定义菜单项,这将非常有用。

第二个是 network_admin_notices 钩子,它允许你向网络管理仪表板添加通知。这可用于向网络管理员显示通知,就像 admin_notices 用于单站点通知一样。

signup_blogform 是一个过滤器,允许你修改新站点的注册表单。你可以使用它向注册表单添加额外的字段。

wp_initialize_site 是一个动作,在创建新站点时触发。如果你想在创建新站点时执行操作,例如为子站点分配自定义顶级域名,这将非常有用。

为网络中的单个站点进行开发

当你在网络中单个站点的范围内渲染任何内容时,WordPress 核心足够智能,能够知道你正在该站点的范围内工作。

这意味着你用来检索信息的任何函数,例如 get_bloginfo、get_option、get_posts 或 get_post_meta,以及你用来添加或更新信息的任何函数,比如 update_option、wp_insert_post 或 update_post_meta,都会针对你当前正在操作的站点获取、添加或更新正确的数据表。

此外,如果你使用像 register_post_typeregister_taxonomy 这样的函数,它们将仅为当前站点注册。

进一步阅读

要查看所有 WordPress 多站点相关函数和钩子的完整列表,请查阅 WordPress 开发者参考中的多站点包类别。

高级多站点管理

掌握了多站点网络管理的基础知识后,是时候了解一些更高级的多站点管理任务了。

让我们深入了解不同的站点状态选项、删除站点时会发生什么、如何将多站点网络中的单个站点导出为独立安装,以及如何将多站点网络安装恢复为单站点安装。

站点状态 (0:25)

网络管理员可以使用一些站点状态选项,了解这些选项很有用。

停用站点会将站点状态更新为已删除,并向访问该站点的任何人显示一条消息。此外,当站点被停用时,有一个 deactivate_blog 操作钩子;当站点被激活时,有一个 activate_blog 操作钩子,可用于在站点激活或停用时运行额外功能。

归档站点会将站点状态更新为已归档,并向访问该站点 URL 的任何人显示一条归档消息。

将站点标记为垃圾会将站点状态更新为垃圾,并显示与归档相同的消息,但不会触发额外的钩子。

从网络中删除站点

从网络中删除站点将移除与该站点关联的所有内容,包括文章、页面、评论以及任何其他自定义内容类型。它还会删除数据库中用于存放站点内容的任何表。与将文章或页面放入回收站不同,一旦删除站点,就无法撤销此操作。

将站点导出为单站点安装

在某些情况下,您可能希望将其中一个子站点提取出来,作为独立的单站点 WordPress 安装。这是可行的,但需要一些手动步骤。有几种方法可以做到这一点,这里只介绍一种可能性。

首先,登录子站点,然后浏览到 工具 > 导出 页面。

您可以使用 WordPress 导出工具将内容导出为 WordPress eXtended RSS 或 WXR 格式。

然后创建新的单站点和关联的用户。

确保安装子站点上使用的任何插件和主题。

然后浏览到工具 -> 导入,使用 WordPress 导入器将数据导入新站点。您可能需要点击 WordPress 选项下的“立即安装”来安装导入器,安装完成后点击“运行导入器”。

别忘了将数据分配给新站点上的相关用户。

数据导入后,手动将子站点的上传目录复制到新的单站点安装中。

您可以在多站点安装的 wp-content/uploads/sites/ 目录中找到子站点的上传目录,该目录位于一个以子站点 ID 命名的文件夹中。

最后但同样重要的是,运行一个搜索替换工具,例如 Better Search Replace,来更新数据库中的任何 URL。

您需要将子站点 URL(子域名或子目录版本)替换为新的单站点 URL。如果您将顶级域名指向了子站点,这一步可能不是必需的。

最后,全面测试一切,确保其按预期工作。

WordPress 数据导出选项的替代方法是手动将子站点的数据库表复制到新站点。但是,如果内容未与正确的用户关联,这可能会导致进一步的问题。

注意事项

如果您有任何创建自定义数据库表的插件,您可能需要手动将这些表复制到新安装中。

在这种情况下,依赖具有多站点扩展的付费第三方备份解决方案可能更容易,这些扩展会为您处理这些操作。

将多站点转换回单站点安装

也可以将多站点转换回单站点安装。如果您不再需要多站点功能,但希望保留原始站点,这将非常有用。

如果您有其他子站点,最好先将它们导出为单站点安装,因为这会删除子站点的内容表。此外,删除为子站点创建的任何用户。

要恢复为单站点,您首先需要移除 wp-config.php 中所有与多站点相关的常量。

完成此操作后,您的仪表盘将恢复为单站点仪表盘。

然后,如果您之前更新了 .htaccess 文件,您需要将其恢复为原始的 .htaccess 文件。

您可以通过将固定链接重置为您想要的任何格式来实现这一点。

最后,删除多站点安装期间专门创建的任何表,即:

wp_blogs
wp_blog_versions
wp_registration_log
wp_signups
wp_site
wp_sitemeta
wp_usermeta
wp_users

如果一切顺利,您现在应该拥有一个正常工作的主站点单站点安装。

进一步阅读

如需查看所有多站点管理功能的完整列表,请查阅 WordPress 开发者手册中“高级管理”下的“多站点”部分。

管理WordPress多站点网络

管理 WordPress 多站点网络与管理单站点 WordPress 安装略有不同。

在本课中,你将学习如何管理 WordPress 多站点网络。

你将了解网络管理仪表板、网络设置页面中的可用选项,以及在网络上创建和管理子站点的不同方法。

网络管理仪表板

一旦启用了多站点网络,你的管理员用户将变为超级管理员,并可以访问网络管理仪表板。在这里,你可以管理网络中的站点、用户、主题、插件和设置。

网络设置页面

网络设置页面是管理多站点网络的地方。

操作设置允许你设置网络标题和管理员邮箱。

注册设置允许你设置网络的注册选项。

例如,如果你想允许用户在网络中注册新站点,可以启用“站点和用户账户都可以注册”选项。

你还可以设置新站点的禁用名称、限制特定电子邮件域名的注册,以及禁止特定电子邮件域名的注册。

新站点设置控制着在网络中创建新站点时发送的电子邮件和创建的内容。

上传设置控制文件上传,包括文件大小限制和允许的文件类型。

语言设置允许你控制网络中新建站点的默认语言。

最后,菜单设置允许你控制站点管理员可以访问哪些菜单。

创建站点

你可能想做的第一件事就是创建一个子站点。为此,请转到站点页面,并点击“添加新站点”按钮。系统会要求你输入站点地址(子域名或子目录)、站点标题、站点语言和站点管理员邮箱地址。如果你使用现有用户的邮箱地址,该用户将被添加为站点管理员。否则,将创建一个新用户并设为新站点的管理员。

站点创建后,你可以通过点击站点列表中的“编辑”按钮来编辑该站点。

信息选项卡管理站点地址,显示站点的注册时间和最后更新时间,并管理站点属性。

用户选项卡允许你将现有用户添加到站点,或向站点添加新用户。

主题选项卡允许你为站点激活一个主题。这里可用的主题是那些未在整个网络中激活的主题。这意味着你可以为网络中的特定站点设置专属主题。

设置选项卡包含你可以管理的所有其他站点设置。

为站点分配顶级域名

还可以为网络中的站点设置顶级域名或根域名。如果你或站点管理员想为网络中的某个站点使用不同的域名,这将非常有用。

要实现这一点,你需要在域名注册商处注册该域名,并将其指向与多站点安装相同的位置。

在这种情况下,你可以看到新的顶级域名指向与多站点安装相同的位置,因为它会重定向到多站点的 URL。

然后,在网络管理中,编辑相关站点,并将站点地址字段更改为新的顶级域名。

现在,当你浏览该域名时,将被重定向到网络中关联的站点。

允许用户注册自己的站点

根据你计划如何使用多站点网络,你可能希望用户能够注册自己的子站点。为此,请转到网络设置页面,并启用“站点和用户账户都可以注册”选项。

现在,如果用户浏览默认的 WordPress 注册 URL,他们将看到还可以在网络中注册站点的选项。

// 示例代码块,内容保持不变

输入用户名和邮箱地址后,系统会询问他们是想要创建站点,还是仅在网络中注册用户账户。

如果他们选择创建站点,则需要设置站点名称和标题。

一旦他们点击注册,站点将被创建,用户将收到一封激活新站点的电子邮件,之后他们就可以登录到该子站点。

进一步阅读

有关管理多站点网络的更多详细信息,请查看 WordPress 开发者文档中的网络管理和网络设置页面。

搭建WordPress多站点网络

WordPress 多站点网络是一种在单个 WordPress 安装中托管多个 WordPress 站点的方式。

在本课中,你将进一步了解 WordPress 多站点、为何要考虑设置多站点网络,以及创建多站点网络需要遵循的步骤。

什么是 WordPress 多站点网络?

WordPress 多站点网络是一组共享单个 WordPress 安装的 WordPress 站点。通过多站点网络,可以允许用户创建自己的站点,或者将网络配置为仅允许管理员创建站点。这些站点在网络中被称为“子站点”或“独立站点”。

多站点网络中的所有站点都使用相同的 WordPress 安装文件,并共享相同的插件和主题。插件和主题在网络级别安装,然后在各个独立站点上激活。

每个独立站点在共享安装中都有独立的媒体上传目录,并在数据库中有独立的表来存储站点内容。

需要注意的是,虽然它们共享相同的 WordPress 核心文件,但多站点网络中的各个站点是相互独立的。它们不像其他类型的网络那样相互连接。如果你计划创建紧密互联、共享数据或共享用户的站点,那么多站点网络可能不是最佳解决方案。

为何要使用 WordPress 多站点网络?

当你拥有多个性质相似但需要相互独立的站点时,多站点网络是一个很好的解决方案。

这方面的例子包括高等教育网站、非营利组织和开源项目。

一个活跃多站点网络最典型的例子就是 Make WordPress。

在这里,每个参与 WordPress 开源项目的贡献者团队都拥有自己的子站点,这些子站点是 Make WordPress 网络的一部分。这意味着,如果你是核心团队的成员,你只能登录到核心子站点,并为该团队创建内容。

多站点网络支持

你使用的网络主机或本地开发环境将决定你如何在本地或在线服务器上创建多站点网络。两种常见的选择是:要么在新安装过程中提供一个设置选项,将新安装设置为多站点网络;要么在 WordPress 安装完成后,按照手动步骤设置多站点网络。

使用 Apache 网络服务器的网络主机和本地开发环境通常允许你使用手动方法将现有的 WordPress 安装转换为多站点网络。使用 Nginx 的环境通常要求你在创建新站点的过程中创建多站点网络。这是因为默认情况下,nginx 不支持用于手动启用多站点的 .htaccess 文件。

无论你使用的是自动还是手动启用多站点的网络主机或本地开发环境,了解从 WordPress 安装创建多站点网络所需的额外步骤都是一个好主意,这也是本课的重点。

如何创建多站点网络

在创建多站点网络之前,请务必阅读开发者文档中的“在创建网络之前”页面,因为它涵盖了一些你在创建多站点网络之前需要了解的重要注意事项。

接下来,你应该备份当前站点的文件和数据库。这不是绝对必要的,特别是如果你创建了一个全新的 WordPress 安装,但如果你已经在要转换为多站点网络的站点上创建了一些内容,那么备份是个好主意。

此外,如果你有站点文件的备份,那么在创建多站点网络过程中如果出现任何问题,你可以快速撤销所做的任何更改。

同时,你应该确保站点上的固定链接正常工作,并且已停用所有已安装的插件。

最后,如果你希望将 WordPress 安装运行在其自己的目录中,请确保在创建多站点网络之前完成此操作。

启用多站点

要启用多站点,你需要编辑 WordPress 安装根目录下的 wp-config.php 文件,并将 PHP 常量 WP_ALLOW_MULTISITE 定义为 true

/* 多站点 */
define( 'WP_ALLOW_MULTISITE', true );

然后,刷新你的 WordPress 仪表盘。通过设置此常量,你现在会在仪表盘的“工具”菜单下看到一个新的菜单项,名为“网络设置”。

安装网络

“网络设置”页面将引导你完成创建多站点网络的步骤。

首先,你需要选择是使用顶级域名的子域名还是子目录作为网络上站点的地址。子目录更简单,因为你不需要任何额外的 DNS 配置,但子域名能让站点拥有更专业的 URL。要使用子域名,你需要为你的顶级域名设置一个通配符 DNS 记录。

在本课中,我们将使用子目录。

您可以保留其余设置不变,或根据自己的喜好进行更改。

准备好后,点击“安装”按钮。

WordPress 现在将运行网络安装,创建所需的任何数据库表,并向这些表添加所需的特定数据。

启用网络

安装完成后,您需要启用网络。这需要做两处更改:

  1. 再次编辑 wp-config.php 文件,并添加仪表盘中“启用网络”页面第一步描述的常量。
  2. 编辑 WordPress 安装根目录中的 .htaccess 文件,并添加仪表盘中“启用网络”页面第二步描述的规则。

完成这些更改后,刷新您的 WordPress 仪表盘,系统会要求您重新登录。

您将被重定向回“网络设置”页面,但会注意到您现在已作为网络管理员登录,并且新创建的多站点网络为您提供了一组不同的菜单选项。

进一步阅读

有关如何创建多站点网络的更多详细信息,请务必阅读官方 WordPress 文档中的“创建网络”页面。