Changeset 39169

Timestamp:

11/08/2016 11:00:38 PM (8 years ago)

Author:

swissspidy

Message:

I18N: Add ability to change user's locale back to site's locale.

Previously there was no way to remove the user locale setting again, even though that might be desirable.

This adds a new 'Site Default' option to the user-specific language setting by introducing a new show_site_locale_default argument to wp_dropdown_languages().

Props ocean90.
See #29783.
Fixes #38632.

Location:

trunk

Files:

• src/wp-admin/includes/user.php (modified) (1 diff)
• src/wp-admin/user-edit.php (modified) (2 diffs)
• src/wp-includes/l10n.php (modified) (4 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php (modified) (1 diff)
• tests/phpunit/tests/l10n.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-users-controller.php (modified) (1 diff)

trunk/src/wp-admin/includes/user.php

@@ -99 +99 @@
         if ( isset( $_POST['locale'] ) ) {
             $locale = sanitize_text_field( $_POST['locale'] );
-            if ( ! in_array( $locale, get_available_languages(), true ) ) {
+            if ( 'site-default' === $locale ) {
                 $locale = '';
+            } elseif ( ! in_array( $locale, get_available_languages(), true ) ) {
+                $locale = 'en_US';
             }
 
-            $user->locale = ( '' === $locale ) ? 'en_US' : $locale;
+            $user->locale = $locale;
         }
     }

trunk/src/wp-admin/user-edit.php

@@ -285 +285 @@
 
         if ( 'en_US' === $user_locale ) {
-            $user_locale = false;
-        } elseif ( ! in_array( $user_locale, $languages, true ) ) {
-            $user_locale = get_locale();
+            $user_locale = '';
+        } elseif ( '' === $user_locale || ! in_array( $user_locale, $languages, true ) ) {
+            $user_locale = 'site-default';
         }
 
@@ -295 +295 @@
             'selected'                    => $user_locale,
             'languages'                   => $languages,
-            'show_available_translations' => false
+            'show_available_translations' => false,
+            'show_site_locale_default'    => true
         ) );
         ?>

trunk/src/wp-includes/l10n.php

@@ -1049 +1049 @@
  * @since 4.0.0
  * @since 4.3.0 Introduced the `echo` argument.
+ * @since 4.7.0 Introduced the `show_site_locale_default` argument.
  *
  * @see get_available_languages()
@@ -1066 +1067 @@
  *                                                  boolean equivalents. Default 1.
  *     @type bool     $show_available_translations  Whether to show available translations. Default true.
+ *     @type bool     $show_site_locale_default     Whether to show an option to fall back to the site's locale. Default false.
  * }
  * @return string HTML content
@@ -1079 +1081 @@
         'echo'         => 1,
         'show_available_translations' => true,
+        'show_site_locale_default'    => false,
     ) );
+
+    // English (United States) uses an empty string for the value attribute.
+    if ( 'en_US' === $args['selected'] ) {
+        $args['selected'] = '';
+    }
 
     $translations = $args['translations'];
@@ -1123 +1131 @@
         $structure[] = '<optgroup label="' . esc_attr_x( 'Installed', 'translations' ) . '">';
     }
-    $structure[] = '<option value="" lang="en" data-installed="1">English (United States)</option>';
+
+    if ( $args['show_site_locale_default'] ) {
+        $structure[] = sprintf(
+            '<option value="site-default" data-installed="1"%s>%s</option>',
+            selected( 'site-default', $args['selected'], false ),
+            _x( 'Site Default', 'default site language' )
+        );
+    }
+
+    $structure[] = sprintf(
+        '<option value="" lang="en" data-installed="1"%s>English (United States)</option>',
+        selected( '', $args['selected'], false )
+    );
+
     foreach ( $languages as $language ) {
         $structure[] = sprintf(

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php

@@ -1075 +1075 @@
                     'description' => __( 'Locale for the resource.' ),
                     'type'        => 'string',
-                    'enum'        => array_merge( array( 'en_US' ), get_available_languages() ),
+                    'enum'        => array_merge( array( '', 'en_US' ), get_available_languages() ),
                     'context'     => array( 'edit' ),
                 ),

trunk/tests/phpunit/tests/l10n.php

@@ -101 +101 @@
 
     /**
+     * @ticket 38632
+     */
+    function test_wp_dropdown_languages_site_default() {
+        $args = array(
+            'id'                       => 'foo',
+            'name'                     => 'bar',
+            'languages'                => array( 'de_DE' ),
+            'translations'             => $this->wp_dropdown_languages_filter(),
+            'selected'                 => 'de_DE',
+            'echo'                     => false,
+            'show_site_locale_default' => true,
+        );
+        $actual = wp_dropdown_languages( $args );
+
+        $this->assertContains( 'id="foo"', $actual );
+        $this->assertContains( 'name="bar"', $actual );
+        $this->assertContains( '<option value="site-default" data-installed="1">Site Default</option>', $actual );
+        $this->assertContains( '<option value="" lang="en" data-installed="1">English (United States)</option>', $actual );
+        $this->assertContains( '<option value="de_DE" lang="de" selected=\'selected\' data-installed="1">Deutsch</option>', $actual );
+        $this->assertContains( '<option value="it_IT" lang="it">Italiano</option>', $actual );
+    }
+
+    /**
+     * @ticket 38632
+     */
+    function test_wp_dropdown_languages_en_US_selected() {
+        $args = array(
+            'id'           => 'foo',
+            'name'         => 'bar',
+            'languages'    => array( 'de_DE' ),
+            'translations' => $this->wp_dropdown_languages_filter(),
+            'selected'     => 'en_US',
+            'echo'         => false,
+        );
+        $actual = wp_dropdown_languages( $args );
+
+        $this->assertContains( 'id="foo"', $actual );
+        $this->assertContains( 'name="bar"', $actual );
+        $this->assertContains( '<option value="" lang="en" data-installed="1" selected=\'selected\'>English (United States)</option>', $actual );
+        $this->assertContains( '<option value="de_DE" lang="de" data-installed="1">Deutsch</option>', $actual );
+        $this->assertContains( '<option value="it_IT" lang="it">Italiano</option>', $actual );
+    }
+
+    /**
      * We don't want to call the API when testing.
      *

trunk/tests/phpunit/tests/rest-api/rest-users-controller.php

@@ -878 +878 @@
         $user = get_userdata( $user_id );
         $this->assertEquals( 'en_US', $user->locale );
+    }
+
+    /**
+     * @ticket 38632
+     */
+    public function test_update_item_empty_locale() {
+        $user_id = $this->factory->user->create( array( 'user_login' => 'test_json_user', 'user_email' => 'testjson@example.com', 'locale' => 'de_DE' ) );
+        $this->allow_user_to_manage_multisite();
+        wp_set_current_user( self::$user );
+
+        $request = new WP_REST_Request( 'PUT', '/wp/v2/users/' . $user_id );
+        $request->set_param( 'locale', '' );
+        $response = $this->server->dispatch( $request );
+        $this->check_add_edit_user_response( $response, true );
+
+        $data = $response->get_data();
+        $this->assertEquals( get_locale(), $data['locale'] );
+        $user = get_userdata( $user_id );
+        $this->assertEquals( '', $user->locale );
     }