深入理解 WordPress `wp_temp_images_dir()` 函数的源码：如何获取临时图片目录路径。

各位听众，晚上好！我是今天的主讲人，咱们今天来聊聊 WordPress 里的一个“小透明”，但其实很重要的函数：wp_temp_images_dir()。 别看它名字长，功能却很实在，就是帮你找到 WordPress 存放临时图片的地方。

一、 临时图片目录：为什么要它？

在深入代码之前，咱们先搞清楚一个问题：WordPress 为什么要专门搞一个临时图片目录？

想象一下，你上传一张图片，WordPress 并不会直接把原始图片扔到服务器上。它可能需要做一些处理，比如：

• 生成缩略图： 为了在文章列表、搜索结果等地方更快地展示，会生成各种尺寸的缩略图。
• 编辑图片： 你可能需要裁剪、旋转、调整亮度等等。
• 处理大型图片： 对于超大图片，可能需要压缩或优化。

这些处理过程，都需要一个“中转站”，存放中间生成的文件。这个“中转站”，就是我们的临时图片目录。处理完成后，最终的图片才会移动到正式的上传目录。

如果没有临时目录，直接在正式目录里操作，可能会出现以下问题：

• 文件损坏： 如果处理过程中出现错误，可能会破坏原始文件。
• 性能问题： 频繁的读写操作会影响服务器性能。
• 安全问题： 不完整的处理过程可能留下安全漏洞。

所以，临时目录就像一个安全可靠的“缓冲区”，保证图片处理的顺利进行。

二、 wp_temp_images_dir()： 找到你的临时“秘密基地”

现在，咱们来揭开 wp_temp_images_dir() 的神秘面纱。这个函数的主要作用就是返回临时图片目录的完整路径。

/**
 * Retrieves the path to the temporary images directory.
 *
 * @since 4.5.0
 *
 * @return string Path to temporary images directory.
 */
function wp_temp_images_dir() {
    $upload_dir = wp_upload_dir();

    if ( ! empty( $upload_dir['basedir'] ) ) {
        $dir = trailingslashit( $upload_dir['basedir'] ) . 'wp-temp-images';
    }

    /**
     * Filters the temporary images directory path.
     *
     * @since 4.5.0
     *
     * @param string $dir Path to temporary images directory.
     */
    return apply_filters( 'wp_temp_images_dir', $dir );
}

咱们一行一行来解读：

1. $upload_dir = wp_upload_dir();

   • 首先，它调用了 wp_upload_dir() 函数。这个函数会返回一个包含上传目录信息的数组，包括：
     • 'basedir'：上传目录的绝对路径。
     • 'baseurl'：上传目录的 URL。
     • 'path'：当前月份的上传目录的绝对路径。
     • 'url'：当前月份的上传目录的 URL。
     • 'subdir'：当前月份的子目录。
     • 'error'：错误信息。

   简单来说，wp_upload_dir() 负责告诉我们图片上传的大本营在哪里。

2. if ( ! empty( $upload_dir['basedir'] ) ) { ... }

   • 这是一个判断语句，检查 wp_upload_dir() 是否成功获取了上传目录的绝对路径。 如果 basedir 为空，说明获取失败，可能存在一些配置问题。

3. $dir = trailingslashit( $upload_dir['basedir'] ) . 'wp-temp-images';

   • 这是关键的一步！它构建了临时图片目录的路径。
     • trailingslashit( $upload_dir['basedir'] )： 确保上传目录路径以斜杠 / 结尾。 trailingslashit() 是 WordPress 提供的一个实用函数，专门用来在路径末尾添加斜杠，避免路径拼接错误。
     • . 'wp-temp-images'： 在上传目录后面拼接 'wp-temp-images'，形成完整的临时图片目录路径。 默认情况下，WordPress 会在上传目录下创建一个名为 'wp-temp-images' 的子目录来存放临时图片。

4. return apply_filters( 'wp_temp_images_dir', $dir );

   • 这行代码使用了 WordPress 的一个非常重要的机制：过滤器（Filter）。

     • apply_filters( 'wp_temp_images_dir', $dir )： 允许其他插件或主题通过 wp_temp_images_dir 过滤器来修改临时图片目录的路径。 也就是说，你可以通过代码自定义临时目录的位置！

   • 为什么要用过滤器？

     • 灵活性： 允许开发者根据自己的需求修改默认行为。
     • 可扩展性： 方便插件和主题扩展 WordPress 的功能。
     • 解耦： 降低代码之间的依赖性，提高代码的可维护性。

三、 深入 wp_upload_dir()： 探寻上传目录的奥秘

既然 wp_temp_images_dir() 依赖于 wp_upload_dir()， 咱们也来简单了解一下 wp_upload_dir() 的工作原理。

/**
 * Retrieves upload directory information.
 *
 * @since 2.0.0
 *
 * @param string|null $time Optional. Time formatted in 'yyyy/mm' format.
 *                            Default null.
 * @param bool        $refresh Whether to force refresh the internal cache.
 *                            Default false.
 *
 * @return array {
 *     Array of upload directory information.
 *
 *     @type string 'path'    Absolute path to upload directory.
 *     @type string 'url'     URL to upload directory.
 *     @type string 'subdir'  Subdirectory if multisite.
 *     @type string 'basedir' Absolute path to base upload directory.
 *     @type string 'baseurl' URL to base upload directory.
 *     @type string 'error'   False or error message.
 * }
 */
function wp_upload_dir( $time = null, $refresh = false ) {
    static $cache = array();

    if ( null === $time ) {
        $time = gmdate( 'Y/m' );
    }

    $key = $time;
    if ( $refresh ) {
        $key .= ':refresh';
    }

    if ( isset( $cache[ $key ] ) ) {
        return $cache[ $key ];
    }

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

    if ( ini_get( 'safe_mode' ) ) {
        $upload_path = trim( $upload_path );
    }

    if ( empty( $upload_path ) ) {
        $dir = WP_CONTENT_DIR . '/uploads';
    } elseif ( 0 !== strpos( $upload_path, ABSPATH ) ) {
        // $dir is absolute, $upload_path is (maybe) relative to ABSPATH
        $dir = path_join( ABSPATH, $upload_path );
    } else {
        $dir = $upload_path;
    }

    $siteurl = untrailingslashit( $siteurl );
    $dir = trailingslashit( $dir );

    if ( is_multisite() ) {
        // Multisite: site-specific directories.
        if ( ! get_site_option( 'ms_upload_sites_enabled' ) ) {
            // All sites share the same 'uploads' directory.
            $ms_dir = '/sites/' . get_current_blog_id();
        } else {
            // The site has its own 'uploads' directory.
            $ms_dir = '/' . get_current_blog_id();
        }

        $dir .= $ms_dir;
    }

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

    if ( defined( 'UPLOADS' ) && false === strpos( $url, WP_CONTENT_URL ) ) {
        $url = untrailingslashit( WP_CONTENT_URL ) . str_replace( WP_CONTENT_DIR, '', $dir );
    }

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

    $subdir = '';
    if ( get_option( 'uploads_use_yearmonth_folders' ) ) {
        // Generate the yearly and monthly directories
        $subdir = '/' . $time;
        $dir .= $subdir;
        $url .= $subdir;
    }

    /**
     * Filters the uploads directory data.
     *
     * @since 2.0.0
     *
     * @param array $uploads Array of upload directory data with keys of 'path',
     *                       'url', 'subdir, 'basedir', and 'baseurl'.
     * @param string $time Optional. Time formatted in 'yyyy/mm' format.
     */
    $uploads = apply_filters(
        'upload_dir',
        array(
            'path'    => $dir,
            'url'     => $url,
            'subdir'  => $subdir,
            'basedir' => $basedir,
            'baseurl' => $baseurl,
            'error'   => false,
        ),
        $time
    );

    $cache[ $key ] = $uploads;

    return $uploads;
}

代码有点长，咱们挑重点说：

1. 缓存机制：

   • static $cache = array();： 使用静态变量 $cache 来缓存上传目录信息。 这意味着，如果之前已经计算过上传目录信息，下次再调用 wp_upload_dir() 时，会直接从缓存中读取，提高性能。

2. 获取配置：

   • $siteurl = get_option( 'siteurl' );： 获取站点 URL。
   • $upload_path = trim( get_option( 'upload_path' ) );： 获取上传路径配置。 这个配置项允许你自定义上传目录的位置。 如果没有设置，默认使用 wp-content/uploads 目录。
   • get_option( 'uploads_use_yearmonth_folders' )： 获取是否按年月分文件夹存储上传文件的配置。

3. 构建路径：

   • 根据配置信息，构建上传目录的绝对路径和 URL。 这里会考虑是否使用自定义上传路径、是否是多站点环境、是否按年月分文件夹存储等因素。

4. 多站点支持：

   • if ( is_multisite() ) { ... }： 如果是多站点环境，会为每个站点创建独立的上传目录。

5. 过滤器：

   • apply_filters( 'upload_dir', ... )： 同样使用了过滤器，允许其他插件或主题修改上传目录的信息。

四、 实战演练：自定义临时图片目录

现在，咱们来演示一下如何使用过滤器自定义临时图片目录。 假设我们想把临时图片目录放到 wp-content/temp-images 目录下。

add_filter( 'wp_temp_images_dir', 'my_custom_temp_images_dir' );

function my_custom_temp_images_dir( $dir ) {
    $dir = WP_CONTENT_DIR . '/temp-images';
    return $dir;
}

这段代码做了什么？

1. add_filter( 'wp_temp_images_dir', 'my_custom_temp_images_dir' );

   • 这行代码把我们自定义的函数 my_custom_temp_images_dir 挂载到 wp_temp_images_dir 过滤器上。 也就是说，当 WordPress 调用 apply_filters( 'wp_temp_images_dir', $dir ) 时，我们的函数 my_custom_temp_images_dir 也会被执行。

2. function my_custom_temp_images_dir( $dir ) { ... }

   • 这是我们自定义的函数，它接收原始的临时图片目录路径 $dir 作为参数。
   • $dir = WP_CONTENT_DIR . '/temp-images';： 我们在这里把 $dir 的值修改为 WP_CONTENT_DIR . '/temp-images'，也就是我们想要的自定义目录。
   • return $dir;： 把修改后的 $dir 返回。

把这段代码添加到你的主题的 functions.php 文件或者一个自定义插件中， 临时图片目录就会被修改为 wp-content/temp-images 了。

五、 常见问题与注意事项

• 权限问题： 确保临时图片目录具有正确的读写权限，否则 WordPress 无法创建和写入文件。
• 目录不存在： 如果自定义的临时图片目录不存在，WordPress 不会自动创建。 你需要手动创建目录。
• 清理临时文件： WordPress 不会自动清理临时图片目录。 你需要定期清理，避免占用过多磁盘空间。 可以写一个定时任务来清理旧的临时文件。
• 多站点环境： 在多站点环境中，每个站点最好都有独立的临时图片目录，避免文件冲突。
• 调试技巧： 可以使用 var_dump( wp_temp_images_dir() ); 来输出临时图片目录的路径，方便调试。

六、 总结

wp_temp_images_dir() 就像一个默默奉献的幕后英雄， 保证 WordPress 图片处理的顺利进行。 通过理解它的源码， 我们可以更好地掌握 WordPress 的工作原理， 并且可以利用过滤器机制， 根据自己的需求自定义临时图片目录。

希望今天的讲座能帮助大家更深入地理解 wp_temp_images_dir() 函数。 感谢大家的聆听！

补充表格：常用函数对比

函数名	功能描述	返回值类型	备注
wp_temp_images_dir()	获取临时图片目录的绝对路径	string	默认位于上传目录下，名为 wp-temp-images。 可以通过 wp_temp_images_dir 过滤器修改。
wp_upload_dir()	获取上传目录的信息	array	返回一个包含上传目录路径、URL 等信息的数组。 依赖于 siteurl 和 upload_path 配置项。 可以通过 upload_dir 过滤器修改。
trailingslashit( $string )	确保字符串以斜杠 / 结尾	string	常用于路径拼接，避免路径错误。
untrailingslashit( $string )	移除字符串末尾的斜杠 /	string	常用于 URL 处理。
get_option( $option )	获取 WordPress 选项的值	mixed	用于获取 WordPress 配置信息，比如 siteurl、upload_path 等。
apply_filters( $tag, $value )	应用过滤器，允许修改变量的值	mixed	WordPress 的核心机制，允许插件和主题扩展 WordPress 的功能。
WP_CONTENT_DIR	WordPress 内容目录的绝对路径 (常量)	string	定义了 wp-content 目录的绝对路径。

希望这个表格能帮助大家更好地理解这些函数。