Changeset 39127

Timestamp:

11/03/2016 08:07:08 PM (8 years ago)

Author:

swissspidy

Message:

I18N: Use the user's locale when loading text domains in the admin.

Leverages get_user_locale() in load_*_textdomain() and _load_textdomain_just_in_time() to always load translations in the user's language when in the admin.

This re-introduces [39069], but now with additional tests and a function_exists( 'wp_get_current_user' ) check in get_user_locale() in case it gets used early.

Props swissspidy, ocean90.
Fixes #38485.

Location:

trunk

Files:

• src/wp-includes/l10n.php (modified) (5 diffs)
• tests/phpunit/tests/l10n/loadTextdomain.php (modified) (4 diffs)
• tests/phpunit/tests/l10n/loadTextdomainJustInTime.php (modified) (2 diffs)

trunk/src/wp-includes/l10n.php

@@ -89 +89 @@
 function get_user_locale( $user_id = 0 ) {
     $user = false;
-    if ( 0 === $user_id ) {
+    if ( 0 === $user_id && function_exists( 'wp_get_current_user' ) ) {
         $user = wp_get_current_user();
     } elseif ( $user_id instanceof WP_User ) {
@@ -711 +711 @@
      * @param string $domain Text domain. Unique identifier for retrieving translated strings.
      */
-    $locale = apply_filters( 'plugin_locale', get_locale(), $domain );
+    $locale = apply_filters( 'plugin_locale', is_admin() ? get_user_locale() : get_locale(), $domain );
 
     $mofile = $domain . '-' . $locale . '.mo';
@@ -745 +745 @@
 function load_muplugin_textdomain( $domain, $mu_plugin_rel_path = '' ) {
     /** This filter is documented in wp-includes/l10n.php */
-    $locale = apply_filters( 'plugin_locale', get_locale(), $domain );
+    $locale = apply_filters( 'plugin_locale', is_admin() ? get_user_locale() : get_locale(), $domain );
 
     $mofile = $domain . '-' . $locale . '.mo';
@@ -784 +784 @@
      * @param string $domain Text domain. Unique identifier for retrieving translated strings.
      */
-    $locale = apply_filters( 'theme_locale', get_locale(), $domain );
+    $locale = apply_filters( 'theme_locale', is_admin() ? get_user_locale() : get_locale(), $domain );
 
     $mofile = $domain . '-' . $locale . '.mo';
@@ -866 +866 @@
     }
 
-    $locale = get_locale();
+    $locale = is_admin() ? get_user_locale() : get_locale();
     $mofile = "{$domain}-{$locale}.mo";
 

trunk/tests/phpunit/tests/l10n/loadTextdomain.php

@@ -7 +7 @@
 class Tests_L10n_loadTextdomain extends WP_UnitTestCase {
     protected $locale;
+    protected static $user_id;
+
+    public static function wpSetUpBeforeClass( $factory ) {
+        self::$user_id = $factory->user->create( array(
+            'role'   => 'administrator',
+            'locale' => 'de_DE',
+        ) );
+    }
 
     public function setUp() {
@@ -184 +192 @@
     }
 
+    /**
+     * @ticket 38485
+     */
+    public function test_load_muplugin_textdomain_user_locale() {
+        set_current_screen( 'dashboard' );
+        wp_set_current_user( self::$user_id );
+
+        load_muplugin_textdomain( 'wp-tests-domain' );
+
+        set_current_screen( 'front' );
+
+        $this->assertSame( get_user_locale(), $this->locale );
+    }
+
     public function test_load_plugin_textdomain_site_locale() {
         load_plugin_textdomain( 'wp-tests-domain' );
@@ -190 +212 @@
     }
 
+    /**
+     * @ticket 38485
+     */
+    public function test_load_plugin_textdomain_user_locale() {
+        set_current_screen( 'dashboard' );
+        wp_set_current_user( self::$user_id );
+
+        load_plugin_textdomain( 'wp-tests-domain' );
+
+        set_current_screen( 'front' );
+
+        $this->assertSame( get_user_locale(), $this->locale );
+    }
+
     public function test_load_theme_textdomain_site_locale() {
         load_theme_textdomain( 'wp-tests-domain' );
@@ -195 +231 @@
         $this->assertSame( get_locale(), $this->locale );
     }
+
+    /**
+     * @ticket 38485
+     */
+    public function test_load_theme_textdomain_user_locale() {
+        set_current_screen( 'dashboard' );
+        wp_set_current_user( self::$user_id );
+
+        load_theme_textdomain( 'wp-tests-domain' );
+
+        set_current_screen( 'front' );
+
+        $this->assertSame( get_user_locale(), $this->locale );
+    }
 }

trunk/tests/phpunit/tests/l10n/loadTextdomainJustInTime.php

@@ -6 +6 @@
  */
 class Tests_L10n_loadTextdomainJustInTime extends WP_UnitTestCase {
-
-    private $orig_theme_dir;
-    private $theme_root;
+    protected $orig_theme_dir;
+    protected $theme_root;
+    protected static $user_id;
+
+    public static function wpSetUpBeforeClass( $factory ) {
+        self::$user_id = $factory->user->create( array(
+            'role'   => 'administrator',
+            'locale' => 'de_DE',
+        ) );
+    }
 
     public function setUp() {
@@ -172 +179 @@
         $this->assertSame( 'Das ist ein Dummy Theme', $expected );
     }
+
+    /**
+     * @ticket 38485
+     */
+    public function test_plugin_translation_with_user_locale() {
+        require_once DIR_TESTDATA . '/plugins/internationalized-plugin.php';
+
+        set_current_screen( 'dashboard' );
+        wp_set_current_user( self::$user_id );
+
+        $expected = i18n_plugin_test();
+
+        set_current_screen( 'front' );
+
+        $this->assertSame( 'Das ist ein Dummy Plugin', $expected );
+    }
+
+    /**
+     * @ticket 38485
+     */
+    public function test_theme_translation_with_user_locale() {
+        switch_theme( 'internationalized-theme' );
+        set_current_screen( 'dashboard' );
+        wp_set_current_user( self::$user_id );
+
+        require_once get_stylesheet_directory() . '/functions.php';
+
+        $expected = i18n_theme_test();
+
+        set_current_screen( 'front' );
+        switch_theme( WP_DEFAULT_THEME );
+
+        $this->assertSame( 'Das ist ein Dummy Theme', $expected );
+    }
 }