云策 WordPress 开发者社区

函数文档

switch_to_locale()

查看官方原文 ↗
💡 云策文档标注

概述

switch_to_locale() 函数用于根据给定的区域设置切换翻译，是 WordPress 国际化功能的一部分。它通过 WP_Locale_Switcher 类实现，返回布尔值表示操作成功与否。

关键要点

  • 参数：$locale（字符串，必需），指定要切换到的区域设置。
  • 返回值：成功时返回 true，失败时返回 false。
  • 依赖：函数内部使用全局变量 $wp_locale_switcher 调用 WP_Locale_Switcher::switch_to_locale() 方法。
  • 引入版本：4.7.0。

代码示例

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

if ( ! $wp_locale_switcher ) {
    return false;
}

return $wp_locale_switcher->switch_to_locale( $locale );
}
📄 原文内容

Switches the translations according to the given locale.

Parameters

$localestringrequired
The locale.

Return

bool True on success, false on failure.

Source

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

	if ( ! $wp_locale_switcher ) {
		return false;
	}

	return $wp_locale_switcher->switch_to_locale( $locale );
}

View all references View on Trac View on GitHub

Uses Description
WP_Locale_Switcher::switch_to_locale()wp-includes/class-wp-locale-switcher.php

Switches the translations according to the given locale.
Used by Description
wpmu_new_site_admin_notification()wp-includes/ms-functions.php

Notifies the Multisite network administrator that a new site was created.
WP_Automatic_Updater::send_plugin_theme_email()wp-admin/includes/class-wp-automatic-updater.php

Sends an email upon the completion or failure of a plugin or theme background update.
WP_Recovery_Mode_Email_Service::send_recovery_mode_email()wp-includes/class-wp-recovery-mode-email-service.php

Sends the Recovery Mode email to the site admin email address.
_wp_privacy_send_erasure_fulfillment_notification()wp-includes/user.php

Notifies the user when their erasure request is fulfilled.
wp_send_user_request()wp-includes/user.php

Send a confirmation request email to confirm an action.
wp_privacy_send_personal_data_export_email()wp-admin/includes/privacy-tools.php

Send an email to the user with a link to the personal data export file
WP_Automatic_Updater::send_email()wp-admin/includes/class-wp-automatic-updater.php

Sends an email upon the completion or failure of a background core update.
WP_Automatic_Updater::send_debug_email()wp-admin/includes/class-wp-automatic-updater.php

Prepares and sends an email of a full log of background update results, useful for debugging and geekery.
insert_with_markers()wp-admin/includes/misc.php

Inserts an array of strings into a file (.htaccess), placing it between BEGIN and END markers.
wp_password_change_notification()wp-includes/pluggable.php

Notifies the blog admin of a user changing password, normally via email.
wp_new_user_notification()wp-includes/pluggable.php

Emails login credentials to a newly-registered user.
wp_notify_postauthor()wp-includes/pluggable.php

Notifies an author (and/or others) of a comment/trackback/pingback on a post.
wp_notify_moderator()wp-includes/pluggable.php

Notifies the moderator of the site about a new comment that is awaiting approval.

Show 8 moreShow less

Changelog

Version Description
4.7.0 Introduced.