mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2026-08-11 20:30:23 +00:00
I18N: Introduce a locale-switching function.
With the introduction of user-specific languages in [38705] it's necessary to be able to switch translations on the fly. For example emails should be sent in the language of the recipient and not the one of the current user. This introduces a new `WP_Locale_Switcher` class which is used for switching locales and translations. It holds the stack of locales whenever `switch_to_locale( $locale )` is called. With `restore_previous_locale()` you can restore the previous locale. `restore_current_locale()` empties the stack and sets the locale back to the initial value. `switch_to_locale()` is added to most of core's email functions, either with the value of `get_locale()` (site language) or `get_user_locale()` (user language with fallback to site language). Props yoavf, tfrommen, swissspidy, pbearne, ocean90. See #29783. Fixes #26511. git-svn-id: https://develop.svn.wordpress.org/trunk@38961 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Dominik Schilling (ocean90)
@@ -9,7 +9,7 @@ class Tests_L10n_loadTextdomainJustInTime extends WP_UnitTestCase {
|
||||
private $orig_theme_dir;
|
||||
private $theme_root;
|
||||
|
||||
function setUp() {
|
||||
public function setUp() {
|
||||
parent::setUp();
|
||||
|
||||
$this->theme_root = DIR_TESTDATA . '/themedir1';
|
||||
@@ -22,17 +22,19 @@ class Tests_L10n_loadTextdomainJustInTime extends WP_UnitTestCase {
|
||||
add_filter( 'template_root', array( $this, 'filter_theme_root' ) );
|
||||
wp_clean_themes_cache();
|
||||
unset( $GLOBALS['wp_themes'] );
|
||||
|
||||
unset( $GLOBALS['l10n'] );
|
||||
unset( $GLOBALS['l10n_unloaded'] );
|
||||
}
|
||||
|
||||
function tearDown() {
|
||||
public function tearDown() {
|
||||
$GLOBALS['wp_theme_directories'] = $this->orig_theme_dir;
|
||||
remove_filter( 'theme_root', array( $this, 'filter_theme_root' ) );
|
||||
remove_filter( 'stylesheet_root', array( $this, 'filter_theme_root' ) );
|
||||
remove_filter( 'template_root', array( $this, 'filter_theme_root' ) );
|
||||
wp_clean_themes_cache();
|
||||
unset( $GLOBALS['wp_themes'] );
|
||||
unset( $GLOBALS['l10n'] );
|
||||
unset( $GLOBALS['l10n_unloaded'] );
|
||||
|
||||
parent::tearDown();
|
||||
}
|
||||
@@ -60,7 +62,6 @@ class Tests_L10n_loadTextdomainJustInTime extends WP_UnitTestCase {
|
||||
$expected_output = i18n_plugin_test();
|
||||
$is_textdomain_loaded_after = is_textdomain_loaded( 'internationalized-plugin' );
|
||||
|
||||
unload_textdomain( 'internationalized-plugin' );
|
||||
remove_filter( 'locale', array( $this, 'filter_set_locale_to_german' ) );
|
||||
|
||||
$this->assertFalse( $is_textdomain_loaded_before );
|
||||
@@ -82,7 +83,6 @@ class Tests_L10n_loadTextdomainJustInTime extends WP_UnitTestCase {
|
||||
$expected_output = i18n_theme_test();
|
||||
$is_textdomain_loaded_after = is_textdomain_loaded( 'internationalized-theme' );
|
||||
|
||||
unload_textdomain( 'internationalized-theme' );
|
||||
remove_filter( 'locale', array( $this, 'filter_set_locale_to_german' ) );
|
||||
|
||||
$this->assertFalse( $is_textdomain_loaded_before );
|
||||
@@ -141,4 +141,34 @@ class Tests_L10n_loadTextdomainJustInTime extends WP_UnitTestCase {
|
||||
$this->assertSame( 'Das ist ein Dummy Plugin', $expected_output_final );
|
||||
$this->assertTrue( $is_textdomain_loaded_final );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 26511
|
||||
*/
|
||||
public function test_plugin_translation_after_switching_locale() {
|
||||
require_once DIR_TESTDATA . '/plugins/internationalized-plugin.php';
|
||||
|
||||
switch_to_locale( 'de_DE' );
|
||||
$expected = i18n_plugin_test();
|
||||
restore_previous_locale();
|
||||
|
||||
$this->assertSame( 'Das ist ein Dummy Plugin', $expected );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 26511
|
||||
*/
|
||||
public function test_theme_translation_after_switching_locale() {
|
||||
switch_theme( 'internationalized-theme' );
|
||||
|
||||
require_once get_stylesheet_directory() . '/functions.php';
|
||||
|
||||
switch_to_locale( 'de_DE' );
|
||||
$expected = i18n_theme_test();
|
||||
restore_previous_locale();
|
||||
|
||||
switch_theme( WP_DEFAULT_THEME );
|
||||
|
||||
$this->assertSame( 'Das ist ein Dummy Theme', $expected );
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,386 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @group l10n
|
||||
* @group i18n
|
||||
* @group 26511
|
||||
*/
|
||||
class Tests_Locale_Switcher extends WP_UnitTestCase {
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
protected $locale = '';
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
protected $previous_locale = '';
|
||||
|
||||
public function setUp() {
|
||||
parent::setUp();
|
||||
|
||||
$this->locale = '';
|
||||
$this->previous_locale = '';
|
||||
|
||||
unset( $GLOBALS['l10n'] );
|
||||
unset( $GLOBALS['l10n_unloaded'] );
|
||||
}
|
||||
|
||||
public function tearDown() {
|
||||
unset( $GLOBALS['l10n'] );
|
||||
unset( $GLOBALS['l10n_unloaded'] );
|
||||
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
public function test_switch_to_non_existent_locale_returns_false() {
|
||||
$this->assertFalse( switch_to_locale( 'foo_BAR' ) );
|
||||
}
|
||||
|
||||
public function test_switch_to_non_existent_locale_does_not_change_locale() {
|
||||
switch_to_locale( 'foo_BAR' );
|
||||
|
||||
$this->assertSame( 'en_US', get_locale() );
|
||||
}
|
||||
|
||||
public function test_switch_to_locale_returns_true() {
|
||||
$expected = switch_to_locale( 'en_GB' );
|
||||
|
||||
// Cleanup.
|
||||
restore_previous_locale();
|
||||
|
||||
$this->assertTrue( $expected );
|
||||
}
|
||||
|
||||
public function test_switch_to_locale_changes_the_locale() {
|
||||
switch_to_locale( 'en_GB' );
|
||||
|
||||
$locale = get_locale();
|
||||
|
||||
// Cleanup.
|
||||
restore_previous_locale();
|
||||
|
||||
$this->assertSame( 'en_GB', $locale );
|
||||
}
|
||||
|
||||
public function test_switch_to_locale_loads_translation() {
|
||||
switch_to_locale( 'es_ES' );
|
||||
|
||||
$actual = __( 'Invalid parameter.' );
|
||||
|
||||
// Cleanup.
|
||||
restore_previous_locale();
|
||||
|
||||
$this->assertSame( 'Parámetro no válido. ', $actual );
|
||||
}
|
||||
|
||||
public function test_switch_to_locale_changes_wp_locale_global() {
|
||||
global $wp_locale;
|
||||
|
||||
$expected = array(
|
||||
'thousands_sep' => '.',
|
||||
'decimal_point' => ',',
|
||||
);
|
||||
|
||||
switch_to_locale( 'de_DE' );
|
||||
|
||||
$wp_locale_de_DE = clone $wp_locale;
|
||||
|
||||
// Cleanup.
|
||||
restore_previous_locale();
|
||||
|
||||
$this->assertEqualSetsWithIndex( $expected, $wp_locale_de_DE->number_format );
|
||||
}
|
||||
|
||||
public function test_switch_to_locale_en_US() {
|
||||
switch_to_locale( 'en_GB' );
|
||||
$locale_en_GB = get_locale();
|
||||
switch_to_locale( 'en_US' );
|
||||
$locale_en_US = get_locale();
|
||||
|
||||
// Cleanup.
|
||||
restore_current_locale();
|
||||
|
||||
$this->assertSame( 'en_GB', $locale_en_GB );
|
||||
$this->assertSame( 'en_US', $locale_en_US );
|
||||
}
|
||||
|
||||
public function test_switch_to_locale_multiple_times() {
|
||||
switch_to_locale( 'en_GB' );
|
||||
switch_to_locale( 'es_ES' );
|
||||
$locale = get_locale();
|
||||
|
||||
// Cleanup.
|
||||
restore_previous_locale();
|
||||
restore_previous_locale();
|
||||
|
||||
$this->assertSame( 'es_ES', $locale );
|
||||
}
|
||||
|
||||
public function test_switch_to_locale_multiple_times_loads_translation() {
|
||||
switch_to_locale( 'en_GB' );
|
||||
switch_to_locale( 'de_DE' );
|
||||
switch_to_locale( 'es_ES' );
|
||||
|
||||
$actual = __( 'Invalid parameter.' );
|
||||
|
||||
// Cleanup.
|
||||
restore_previous_locale();
|
||||
restore_previous_locale();
|
||||
restore_previous_locale();
|
||||
|
||||
$this->assertSame( 'Parámetro no válido. ', $actual );
|
||||
}
|
||||
|
||||
public function test_restore_previous_locale_without_switching() {
|
||||
$this->assertFalse( restore_previous_locale() );
|
||||
}
|
||||
|
||||
public function test_restore_previous_locale_changes_the_locale_back() {
|
||||
switch_to_locale( 'en_GB' );
|
||||
|
||||
// Cleanup.
|
||||
restore_previous_locale();
|
||||
|
||||
$this->assertSame( 'en_US', get_locale() );
|
||||
}
|
||||
|
||||
public function test_restore_previous_locale_after_switching_multiple_times() {
|
||||
switch_to_locale( 'en_GB' );
|
||||
switch_to_locale( 'es_ES' );
|
||||
restore_previous_locale();
|
||||
|
||||
$locale = get_locale();
|
||||
|
||||
// Cleanup.
|
||||
restore_previous_locale();
|
||||
|
||||
$this->assertSame( 'en_GB', $locale );
|
||||
}
|
||||
|
||||
public function test_restore_previous_locale_restores_translation() {
|
||||
switch_to_locale( 'es_ES' );
|
||||
restore_previous_locale();
|
||||
|
||||
$actual = __( 'Invalid parameter.' );
|
||||
|
||||
$this->assertSame( 'Invalid parameter.', $actual );
|
||||
}
|
||||
|
||||
public function test_restore_previous_locale_action_passes_previous_locale() {
|
||||
switch_to_locale( 'en_GB' );
|
||||
switch_to_locale( 'es_ES' );
|
||||
|
||||
add_action( 'restore_previous_locale', array( $this, 'store_locale' ), 10, 2 );
|
||||
|
||||
restore_previous_locale();
|
||||
|
||||
$previous_locale = $this->previous_locale;
|
||||
|
||||
// Cleanup.
|
||||
restore_previous_locale();
|
||||
|
||||
$this->assertSame( 'es_ES', $previous_locale );
|
||||
}
|
||||
|
||||
public function test_restore_previous_locale_restores_wp_locale_global() {
|
||||
global $wp_locale;
|
||||
|
||||
$expected = array(
|
||||
'thousands_sep' => ',',
|
||||
'decimal_point' => '.',
|
||||
);
|
||||
|
||||
switch_to_locale( 'de_DE' );
|
||||
restore_previous_locale();
|
||||
|
||||
$this->assertEqualSetsWithIndex( $expected, $wp_locale->number_format );
|
||||
}
|
||||
|
||||
public function test_restore_current_locale_without_switching() {
|
||||
$this->assertFalse( restore_current_locale() );
|
||||
}
|
||||
|
||||
public function test_restore_current_locale_after_switching_multiple_times() {
|
||||
switch_to_locale( 'en_GB' );
|
||||
switch_to_locale( 'nl_NL' );
|
||||
switch_to_locale( 'es_ES' );
|
||||
|
||||
restore_current_locale();
|
||||
|
||||
$this->assertSame( 'en_US', get_locale() );
|
||||
}
|
||||
|
||||
public function store_locale( $locale, $previous_locale ) {
|
||||
$this->locale = $locale;
|
||||
$this->previous_locale = $previous_locale;
|
||||
}
|
||||
|
||||
public function test_is_locale_switched_if_not_switched() {
|
||||
$this->assertFalse( is_locale_switched() );
|
||||
}
|
||||
|
||||
public function test_is_locale_switched_original_locale() {
|
||||
$original_locale = get_locale();
|
||||
|
||||
switch_to_locale( 'en_GB' );
|
||||
switch_to_locale( $original_locale );
|
||||
|
||||
$is_locale_switched = is_locale_switched();
|
||||
|
||||
restore_current_locale();
|
||||
|
||||
$this->assertTrue( $is_locale_switched );
|
||||
}
|
||||
|
||||
public function test_is_locale_switched() {
|
||||
switch_to_locale( 'en_GB' );
|
||||
switch_to_locale( 'nl_NL' );
|
||||
|
||||
$is_locale_switched = is_locale_switched();
|
||||
|
||||
restore_current_locale();
|
||||
|
||||
$this->assertTrue( $is_locale_switched );
|
||||
}
|
||||
|
||||
public function test_switch_to_site_locale_if_user_locale_is_set() {
|
||||
global $l10n, $wp_locale_switcher;
|
||||
|
||||
$site_locale = get_locale();
|
||||
|
||||
$user_id = $this->factory()->user->create( array(
|
||||
'role' => 'administrator',
|
||||
'locale' => 'de_DE',
|
||||
) );
|
||||
|
||||
wp_set_current_user( $user_id );
|
||||
set_current_screen( 'dashboard' );
|
||||
|
||||
$locale_switcher = clone $wp_locale_switcher;
|
||||
|
||||
$wp_locale_switcher = new WP_Locale_Switcher();
|
||||
$wp_locale_switcher->init();
|
||||
|
||||
$user_locale = get_user_locale();
|
||||
|
||||
$this->assertSame( 'de_DE', $user_locale );
|
||||
|
||||
load_default_textdomain( $user_locale );
|
||||
$language_header_before_switch = $l10n['default']->headers['Language']; // de_DE
|
||||
|
||||
$locale_switched_user_locale = switch_to_locale( $user_locale ); // False.
|
||||
$locale_switched_site_locale = switch_to_locale( $site_locale ); // True.
|
||||
$site_locale_after_switch = get_locale();
|
||||
$language_header_after_switch = isset( $l10n['default'] ); // en_US
|
||||
|
||||
restore_current_locale();
|
||||
|
||||
$language_header_after_restore = $l10n['default']->headers['Language']; // de_DE
|
||||
|
||||
$wp_locale_switcher = $locale_switcher;
|
||||
|
||||
set_current_screen( 'front' );
|
||||
|
||||
$this->assertFalse( $locale_switched_user_locale );
|
||||
$this->assertTrue( $locale_switched_site_locale );
|
||||
$this->assertSame( $site_locale, $site_locale_after_switch );
|
||||
$this->assertSame( 'de_DE', $language_header_before_switch );
|
||||
$this->assertFalse( $language_header_after_switch );
|
||||
$this->assertSame( 'de_DE', $language_header_after_restore );
|
||||
}
|
||||
|
||||
public function test_switch_to_different_site_locale_if_user_locale_is_set() {
|
||||
global $l10n, $wp_locale_switcher;
|
||||
|
||||
// Change site locale to es_ES.
|
||||
add_filter( 'locale', array( $this, 'filter_locale' ) );
|
||||
|
||||
$site_locale = get_locale();
|
||||
|
||||
$user_id = $this->factory()->user->create( array(
|
||||
'role' => 'administrator',
|
||||
'locale' => 'de_DE',
|
||||
) );
|
||||
|
||||
wp_set_current_user( $user_id );
|
||||
set_current_screen( 'dashboard' );
|
||||
|
||||
$locale_switcher = clone $wp_locale_switcher;
|
||||
|
||||
$wp_locale_switcher = new WP_Locale_Switcher();
|
||||
$wp_locale_switcher->init();
|
||||
|
||||
$user_locale = get_user_locale();
|
||||
|
||||
$this->assertSame( 'de_DE', $user_locale );
|
||||
|
||||
load_default_textdomain( $user_locale );
|
||||
$language_header_before_switch = $l10n['default']->headers['Language']; // de_DE
|
||||
|
||||
$locale_switched_user_locale = switch_to_locale( $user_locale ); // False.
|
||||
$locale_switched_site_locale = switch_to_locale( $site_locale ); // True.
|
||||
$site_locale_after_switch = get_locale();
|
||||
$language_header_after_switch = $l10n['default']->headers['Language']; // es_ES
|
||||
|
||||
restore_current_locale();
|
||||
|
||||
$language_header_after_restore = $l10n['default']->headers['Language']; // de_DE
|
||||
|
||||
$wp_locale_switcher = $locale_switcher;
|
||||
|
||||
set_current_screen( 'front' );
|
||||
|
||||
remove_filter( 'locale', array( $this, 'filter_locale' ) );
|
||||
|
||||
$this->assertFalse( $locale_switched_user_locale );
|
||||
$this->assertTrue( $locale_switched_site_locale );
|
||||
$this->assertSame( $site_locale, $site_locale_after_switch );
|
||||
$this->assertSame( 'de_DE', $language_header_before_switch );
|
||||
$this->assertSame( 'es_ES', $language_header_after_switch );
|
||||
$this->assertSame( 'de_DE', $language_header_after_restore );
|
||||
}
|
||||
|
||||
public function test_multiple_switches_to_site_locale_and_user_locale() {
|
||||
global $wp_locale_switcher;
|
||||
|
||||
$site_locale = get_locale();
|
||||
|
||||
$user_id = $this->factory()->user->create( array(
|
||||
'role' => 'administrator',
|
||||
'locale' => 'en_GB',
|
||||
) );
|
||||
|
||||
wp_set_current_user( $user_id );
|
||||
set_current_screen( 'dashboard' );
|
||||
|
||||
$locale_switcher = clone $wp_locale_switcher;
|
||||
|
||||
$wp_locale_switcher = new WP_Locale_Switcher();
|
||||
$wp_locale_switcher->init();
|
||||
|
||||
$user_locale = get_user_locale();
|
||||
|
||||
load_default_textdomain( $user_locale );
|
||||
|
||||
require_once DIR_TESTDATA . '/plugins/internationalized-plugin.php';
|
||||
|
||||
switch_to_locale( 'de_DE' );
|
||||
switch_to_locale( $site_locale );
|
||||
|
||||
$expected = i18n_plugin_test();
|
||||
|
||||
restore_current_locale();
|
||||
|
||||
$wp_locale_switcher = $locale_switcher;
|
||||
|
||||
set_current_screen( 'front' );
|
||||
|
||||
$this->assertSame( 'en_US', get_locale() );
|
||||
$this->assertSame( 'This is a dummy plugin', $expected );
|
||||
}
|
||||
|
||||
public function filter_locale() {
|
||||
return 'es_ES';
|
||||
}
|
||||
}
|
||||
@@ -1,7 +1,7 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @group locale
|
||||
* @group l10n
|
||||
* @group i18n
|
||||
*/
|
||||
class Tests_Locale extends WP_UnitTestCase {
|
||||
|
||||
Reference in New Issue
Block a user