发布于 由admin

分析 WordPress `switch_to_locale()` 函数的源码：如何在代码中临时切换语言环境。

各位观众老爷，晚上好！我是你们的老朋友，今天咱们来聊聊 WordPress 里一个挺有意思的函数：switch_to_locale()。这玩意儿就像个魔法棒，能让你的 WordPress 网站在代码里瞬间变身成另一种语言环境。

咱们都知道，WordPress 玩的是国际化，一个网站恨不得能说八国语言，方便来自五湖四海的朋友。但问题来了，有时候咱们需要在代码里，临时的切换一下语言环境，比如发送一封特定语言的邮件，或者展示一段特定语言的内容。这时候，switch_to_locale() 就闪亮登场了。

第一部分：switch_to_locale() 的前世今生

switch_to_locale() 函数，顾名思义，就是“切换到某种语言环境”。 它的主要作用是：

  1. 加载指定语言的翻译文件 (MO 文件)：WordPress 的翻译文件是 .mo 文件，包含了各种文本字符串的翻译。switch_to_locale() 会尝试加载指定语言的 .mo 文件，让 WordPress 知道该用什么语言来显示文字。
  2. 更新全局 $locale 变量：$locale 是一个全局变量，存储着当前站点的语言代码，比如 zh_CN（简体中文）、en_US（美式英语）等等。switch_to_locale() 会修改这个变量，告诉 WordPress 现在应该用什么语言了。

第二部分：源码剖析，扒光 switch_to_locale() 的底裤

接下来，咱们一起钻到 WordPress 的源码里，看看 switch_to_locale() 到底是怎么工作的。这个函数位于 wp-includes/l10n.php 文件中。

/**
 * Switches the locale.
 *
 * Allows you to switch to a specific locale.
 *
 * @since 1.5.0
 *
 * @global string $locale Current locale.
 *
 * @param string|bool $locale Optional. Locale to switch to. Use false to reset
 *                            to the default locale. Default is the user's locale.
 * @return bool True on success, false on failure.
 */
function switch_to_locale( $locale = '' ) {
    global $locale, $wp_locale, $l10n;

    if ( false === $locale ) {
        $locale = get_locale();
    }

    if ( empty( $locale ) ) {
        $locale = get_user_locale();
    }

    if ( $locale === $locale ) { // Yes, it's intentional. Prevents unnecessary work.
        return true;
    }

    $old_locale = $locale;

    $locale = sanitize_key( $locale );

    if ( ! is_textdomain_loaded( 'default' ) ) {
        load_default_textdomain( $locale );
    } else {
        unload_textdomain( 'default' );
        load_default_textdomain( $locale );
    }

    $wp_locale = new WP_Locale();

    /**
     * Fires after the locale is switched.
     *
     * @since 4.7.0
     *
     * @param string $locale The new locale.
     * @param string $old_locale The previous locale.
     */
    do_action( 'switch_locale', $locale, $old_locale );

    return true;
}

咱们一行一行地解读：

  1. 函数定义：

    function switch_to_locale( $locale = '' ) {

    switch_to_locale() 接受一个可选的参数 $locale，表示要切换到的语言代码。如果不传参数，或者传入空字符串，函数会尝试使用用户的语言环境。

  2. 获取语言代码：

    if ( false === $locale ) {
    $locale = get_locale();
}

if ( empty( $locale ) ) {
    $locale = get_user_locale();
}

    这段代码首先判断 $locale 是否为 false，如果是，则使用 get_locale() 函数获取站点的默认语言代码。如果 $locale 为空，则使用 get_user_locale() 函数获取当前用户的语言代码。

  3. 防止重复切换：

    if ( $locale === $locale ) { // Yes, it's intentional. Prevents unnecessary work.
    return true;
}

    这行代码看起来有点奇怪，但它的作用是防止重复切换到同一个语言环境。如果 $locale 的值没有改变，函数就直接返回 true，避免不必要的加载操作。

  4. 清理语言代码：

    $locale = sanitize_key( $locale );

    sanitize_key() 函数用于清理语言代码，确保它符合 WordPress 的规范。

  5. 加载翻译文件：

    if ( ! is_textdomain_loaded( 'default' ) ) {
    load_default_textdomain( $locale );
} else {
    unload_textdomain( 'default' );
    load_default_textdomain( $locale );
}

    这段代码是整个函数的核心。它首先判断 default 文本域是否已经加载。default 文本域是 WordPress 默认的文本域，包含了 WordPress 核心的翻译文件。如果 default 文本域没有加载，就使用 load_default_textdomain() 函数加载指定语言的翻译文件。如果 default 文本域已经加载，就先使用 unload_textdomain() 函数卸载它，然后再重新加载指定语言的翻译文件。

  6. 更新 $wp_locale 对象：

    $wp_locale = new WP_Locale();

    WP_Locale 是一个类，用于存储当前语言环境的信息，比如日期格式、时间格式等等。这段代码创建一个新的 WP_Locale 对象，并用当前语言环境的信息初始化它。

  7. 触发 switch_locale Action Hook：

    /**
 * Fires after the locale is switched.
 *
 * @since 4.7.0
 *
 * @param string $locale The new locale.
 * @param string $old_locale The previous locale.
 */
do_action( 'switch_locale', $locale, $old_locale );

    do_action() 函数用于触发一个 action hook。switch_locale action hook 在语言环境切换之后被触发，允许开发者执行一些自定义的操作，比如更新缓存、发送通知等等。

  8. 返回结果：

    return true;

    函数返回 true，表示切换语言环境成功。

第三部分：switch_to_locale() 的最佳实践

现在咱们已经了解了 switch_to_locale() 的工作原理，接下来咱们来看看如何在实际开发中使用它。

  1. 临时切换语言环境：

    switch_to_locale() 的主要用途是临时切换语言环境。比如，你可能需要在发送邮件时，使用用户的语言环境。

    $user_id = get_current_user_id();
$user_locale = get_user_locale( $user_id );

switch_to_locale( $user_locale );

// 发送邮件
$subject = __( '您的订单已发货', 'your-textdomain' );
$message = __( '您的订单已经发货，请注意查收。', 'your-textdomain' );

wp_mail( get_user_email( $user_id ), $subject, $message );

// 恢复原来的语言环境
restore_previous_locale();

    在这个例子中，咱们首先获取用户的语言环境，然后使用 switch_to_locale() 函数切换到用户的语言环境。接着，咱们发送一封邮件，邮件的主题和内容都会使用用户的语言。最后，咱们使用 restore_previous_locale() 函数恢复原来的语言环境。 restore_previous_locale()函数我们稍后会讲到。

  2. 展示特定语言的内容：

    你可能需要在网站上展示一段特定语言的内容，比如一段英文的法律声明。

    switch_to_locale( 'en_US' );

// 展示英文的法律声明
echo __( 'This is a legal disclaimer in English.', 'your-textdomain' );

// 恢复原来的语言环境
restore_previous_locale();

    在这个例子中，咱们使用 switch_to_locale() 函数切换到英文环境，然后展示一段英文的法律声明。最后，咱们使用 restore_previous_locale() 函数恢复原来的语言环境。

  3. 使用 get_locale() 获取当前语言环境：

    get_locale() 函数用于获取当前站点的语言代码。

    $current_locale = get_locale();

echo '当前语言环境：' . $current_locale;

  4. 使用 get_user_locale() 获取用户语言环境：

    get_user_locale() 函数用于获取用户的语言代码。

    $user_id = get_current_user_id();
$user_locale = get_user_locale( $user_id );

echo '用户语言环境：' . $user_locale;

第四部分：restore_previous_locale() 和全局状态管理

注意到了吗？上面的例子中，每次使用 switch_to_locale() 之后，都会调用 restore_previous_locale() 函数。这是因为 switch_to_locale() 会修改全局的语言环境，如果不恢复原来的语言环境，可能会导致网站的其他部分显示错误的语言。

那么，restore_previous_locale() 函数是怎么工作的呢？ 实际上 WordPress 并没有提供这个函数，我们需要自己实现一个简单的堆栈来管理语言环境的切换。

// 定义一个全局变量来保存语言环境堆栈
global $wp_locale_stack;
if ( ! isset( $wp_locale_stack ) ) {
    $wp_locale_stack = array();
}

/**
 * Switches the locale and saves the previous locale to a stack.
 *
 * @param string $locale The locale to switch to.
 */
function push_locale( $locale ) {
    global $wp_locale_stack, $locale;

    // 保存当前的语言环境
    array_push( $wp_locale_stack, $locale );

    // 切换到新的语言环境
    switch_to_locale( $locale );
}

/**
 * Restores the previous locale from the stack.
 */
function restore_previous_locale() {
    global $wp_locale_stack;

    // 检查堆栈是否为空
    if ( ! empty( $wp_locale_stack ) ) {
        // 从堆栈中取出上一个语言环境
        $previous_locale = array_pop( $wp_locale_stack );

        // 切换回上一个语言环境
        switch_to_locale( $previous_locale );
    } else {
        // 如果堆栈为空，则切换回默认语言环境
        switch_to_locale( get_locale() );
    }
}

在这个实现中：

  • $wp_locale_stack 是一个全局数组，用于存储语言环境的堆栈。
  • push_locale() 函数用于切换到新的语言环境，并将当前的语言环境压入堆栈。
  • restore_previous_locale() 函数用于从堆栈中取出上一个语言环境，并切换回上一个语言环境。

使用方法如下：

// 切换到英文环境
push_locale( 'en_US' );

// 展示英文的法律声明
echo __( 'This is a legal disclaimer in English.', 'your-textdomain' );

// 恢复原来的语言环境
restore_previous_locale();

第五部分：注意事项和最佳实践总结

  1. 避免滥用 switch_to_locale()：switch_to_locale() 函数会修改全局的语言环境，可能会影响网站的其他部分。因此，应该尽量避免滥用 switch_to_locale()，只在必要的时候使用它。
  2. 及时恢复原来的语言环境：在使用 switch_to_locale() 之后，一定要及时使用 restore_previous_locale() 函数恢复原来的语言环境，避免出现意外的错误。
  3. 使用文本域：在编写 WordPress 插件或主题时，一定要使用文本域来包裹需要翻译的文本。这样，WordPress 才能正确地加载翻译文件，并显示正确的语言。
  4. 测试你的代码：在发布你的插件或主题之前，一定要在不同的语言环境下测试你的代码，确保它能够正常工作。

总结

switch_to_locale() 函数是 WordPress 中一个非常有用的工具，它可以让你在代码里临时切换语言环境，方便你发送特定语言的邮件，或者展示特定语言的内容。但是，switch_to_locale() 函数也会修改全局的语言环境，如果不小心使用，可能会导致网站的其他部分显示错误的语言。因此，在使用 switch_to_locale() 函数时，一定要小心谨慎，避免出现意外的错误。 记住使用我们上面定义的push_locale() 和 restore_previous_locale()函数，这样可以避免很多潜在的问题。

好了，今天的讲座就到这里。希望大家能够掌握 switch_to_locale() 函数的使用方法，并在实际开发中灵活运用它。 谢谢大家！

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注