函数文档

restore_current_locale()

💡 云策文档标注

概述

restore_current_locale() 函数用于根据原始区域设置恢复翻译,是 WordPress 中处理多语言切换的核心功能。它返回成功时的区域设置字符串或失败时的 false。

关键要点

  • 函数 restore_current_locale() 恢复翻译到原始区域设置,常用于多语言环境切换后还原。
  • 返回值:成功时返回区域设置字符串,失败时返回 false,便于错误处理。
  • 依赖全局变量 $wp_locale_switcher,需确保 WP_Locale_Switcher 类已初始化。
  • 自 WordPress 4.7.0 版本引入,是 WP_Locale_Switcher 类的一部分。

代码示例

function restore_current_locale() {
    /* @var WP_Locale_Switcher $wp_locale_switcher */
    global $wp_locale_switcher;

    if ( ! $wp_locale_switcher ) {
        return false;
    }

    return $wp_locale_switcher->restore_current_locale();
}

📄 原文内容

Restores the translations according to the original locale.

Return

string|false Locale on success, false on error.

Source

function restore_current_locale() {
	/* @var WP_Locale_Switcher $wp_locale_switcher */
	global $wp_locale_switcher;

	if ( ! $wp_locale_switcher ) {
		return false;
	}

	return $wp_locale_switcher->restore_current_locale();
}

Changelog

Version Description
4.7.0 Introduced.