解析 WordPress `wp_upload_dir()` 函数在多站点模式下的源码：上传目录是如何根据站点 ID 组织的。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷们，晚上好！我是今天的主讲人，咱们今晚就来扒一扒 WordPress 多站点模式下 wp_upload_dir() 这个函数，看看它怎么把大家的图片、文件安排得井井有条的。

开场白：多站点，不只是复制粘贴！

很多人以为 WordPress 多站点就是把一个网站复制粘贴 N 份，然后改改域名，就能当成独立站点卖钱了。Naive！多站点模式可比这复杂多了，它需要一套机制来隔离各个站点的数据，尤其是上传的文件。想象一下，如果没有隔离，你站点的猫片岂不是要跑到隔壁站点的狗粮广告里去了？

所以，WordPress 通过 wp_upload_dir() 这个函数，巧妙地为每个站点创建了独立的上传目录，避免了这种尴尬情况的发生。今天，我们就来深入了解一下这个“文件管理员”的工作原理。

wp_upload_dir()：你的文件管家

wp_upload_dir() 函数是 WordPress 中用来获取上传目录信息的关键函数。它会返回一个包含各种路径和 URL 的数组，方便你存储和访问上传的文件。

在单站点模式下，这个函数比较简单，直接返回 wp-content/uploads 目录的相关信息。但在多站点模式下，事情就变得有趣起来了。

源码剖析：找到隐藏的站点 ID

要理解 wp_upload_dir() 在多站点模式下的工作方式，我们需要深入到 WordPress 的核心代码中。

以下是 wp_upload_dir() 函数的简化版（省略了一些错误处理和过滤器的部分，只保留核心逻辑）：

function wp_upload_dir( $time = null, $deprecated = false, $create_dir = true ) {
    global $switched;

    if ( $deprecated ) {
        _deprecated_argument( __FUNCTION__, '2.0' );
    }

    $siteurl = get_option( 'siteurl' );
    $upload_path = trim( get_option( 'upload_path' ) );

    if ( empty( $upload_path ) ) {
        $dir = WP_CONTENT_DIR . '/uploads';
    } else {
        $dir = ABSPATH . $upload_path;
    }

    $url = str_replace( ABSPATH, $siteurl . '/', $dir );

    if ( is_multisite() ) {
        // Multisite!
        if ( ! isset( $switched ) || ! $switched ) {
            $ms_dir = '/sites/' . get_current_blog_id();
        } else {
            $ms_dir = '/sites/' . $switched;
        }

        $dir .= $ms_dir;
        $url .= $ms_dir;
    }

    $subdir = '';
    if ( get_option( 'uploads_use_yearmonth_folders' ) ) {
        // Generate the yearly and monthly directories
        if ( ! $time ) {
            $time = current_time( 'mysql' );
        }

        $y = substr( $time, 0, 4 );
        $m = substr( $time, 5, 2 );

        $subdir = "/$y/$m";
    }

    $dir .= $subdir;
    $url .= $subdir;

    $basedir = $dir;
    $baseurl = $url;

    $result = apply_filters( 'upload_dir', array(
        'path'   => $dir,
        'url'    => $url,
        'subdir' => $subdir,
        'basedir' => $basedir,
        'baseurl' => $baseurl,
        'error'  => false,
    ) );

    if ( $create_dir ) {
        wp_mkdir_p( $result['path'] );
    }

    return $result;
}

注意这段代码：

if ( is_multisite() ) {
    // Multisite!
    if ( ! isset( $switched ) || ! $switched ) {
        $ms_dir = '/sites/' . get_current_blog_id();
    } else {
        $ms_dir = '/sites/' . $switched;
    }

    $dir .= $ms_dir;
    $url .= $ms_dir;
}

这里是关键！当 is_multisite() 返回 true 时，表示当前是多站点模式。这段代码会根据当前站点的 ID (get_current_blog_id())，生成一个形如 /sites/X 的目录名，并将其添加到上传目录的路径中。

get_current_blog_id() 函数会返回当前站点的 ID。每个站点在多站点网络中都有一个唯一的 ID。

$switched 全局变量：站点切换的秘密

你可能注意到代码中还有一个 $switched 变量。这个变量与站点切换有关。在多站点模式下，管理员可以在不同的站点之间切换。当使用 switch_to_blog() 函数切换站点时，$switched 变量会被设置为目标站点的 ID。

因此，wp_upload_dir() 函数会根据 $switched 变量的值，来确定当前应该使用哪个站点的 ID 来生成上传目录。

上传目录的结构：站点 ID 说了算

通过以上分析，我们可以得出结论：在多站点模式下，wp_upload_dir() 函数会根据站点的 ID，在 wp-content/uploads/sites/ 目录下创建独立的上传目录。

例如，如果你的站点 ID 是 3，那么该站点的上传目录就会是 wp-content/uploads/sites/3。

更进一步，如果启用了按年月组织上传文件的选项，那么最终的上传目录结构可能会是这样：

wp-content/uploads/sites/3/2023/10

其中，2023 是年份，10 是月份。

示例：代码胜于雄辩

为了更好地理解 wp_upload_dir() 的工作方式，我们来看一个简单的示例：

<?php
// 假设当前是多站点模式，并且当前站点的 ID 是 5

// 获取上传目录信息
$upload_dir = wp_upload_dir();

// 打印上传目录信息
echo '<pre>';
print_r( $upload_dir );
echo '</pre>';

// 假设启用了按年月组织上传文件的选项，并且当前是 2023 年 10 月
// 那么 $upload_dir 数组的内容可能如下：

/*
Array
(
    [path] => /path/to/wordpress/wp-content/uploads/sites/5/2023/10
    [url] => http://example.com/wp-content/uploads/sites/5/2023/10
    [subdir] => /2023/10
    [basedir] => /path/to/wordpress/wp-content/uploads/sites/5
    [baseurl] => http://example.com/wp-content/uploads/sites/5
    [error] => false
)
*/
?>

在这个示例中，我们可以看到 wp_upload_dir() 函数返回的数组包含了各种路径和 URL 信息，其中 path 字段表示上传目录的完整路径，url 字段表示上传目录的 URL。

表格总结：wp_upload_dir() 的秘密

模式	是否多站点	上传目录结构
单站点	否	`wp-content/uploads/` + 年月目录（如果启用）
多站点	是	`wp-content/uploads/sites/X/` + 年月目录（如果启用），X 为站点 ID

实际应用：自定义上传目录

了解了 wp_upload_dir() 的工作原理，我们就可以利用它来做一些有趣的事情，比如自定义上传目录。

WordPress 提供了 upload_dir 过滤器，允许我们修改 wp_upload_dir() 函数返回的结果。

例如，我们可以使用以下代码，将所有站点的上传目录都放到一个单独的目录中：

add_filter( 'upload_dir', 'custom_upload_dir' );

function custom_upload_dir( $dirs ) {
    $custom_dir = '/custom-uploads';

    $dirs['path'] = WP_CONTENT_DIR . $custom_dir . $dirs['subdir'];
    $dirs['url'] = WP_CONTENT_URL . $custom_dir . $dirs['subdir'];
    $dirs['basedir'] = WP_CONTENT_DIR . $custom_dir;
    $dirs['baseurl'] = WP_CONTENT_URL . $custom_dir;

    return $dirs;
}

这段代码会将所有站点的上传目录都放到 wp-content/custom-uploads 目录下。当然，这只是一个示例，你可以根据自己的需求，进行更复杂的自定义。

注意事项：小心驶得万年船

在修改 wp_upload_dir() 函数返回的结果时，需要注意以下几点：

确保目录存在： 如果你自定义了上传目录，需要确保该目录存在，并且 WordPress 有写入权限。
更新数据库： 如果你修改了上传目录的 URL，需要更新数据库中所有指向旧 URL 的链接。
兼容性： 你的自定义代码可能会与其他插件或主题不兼容，需要进行充分的测试。
仔细测试: 修改上传目录是非常危险的操作，请在生产环境以外的地方充分测试。
数据库备份: 在修改前备份你的数据库，以防不测。

总结：wp_upload_dir()，多站点模式的基石

wp_upload_dir() 函数是 WordPress 多站点模式下文件管理的基础。它通过站点 ID 将各个站点的上传文件隔离，保证了数据的安全性和独立性。

通过深入了解 wp_upload_dir() 的工作原理，我们可以更好地理解 WordPress 多站点模式，并利用它来构建更强大的网站。

彩蛋：一些有趣的思考

除了站点 ID，是否可以使用其他方式来区分上传目录？例如，使用域名或用户 ID。
wp_upload_dir() 函数的性能如何？在高并发情况下，是否会成为瓶颈？
如何优化多站点模式下的文件存储，提高网站的性能和可扩展性？

这些问题留给大家思考，希望今天的讲座能对你有所启发。

感谢大家的收听！下次再见！

发表回复 取消回复

发表回复取消回复