Changeset 38705

Timestamp:

10/03/2016 07:03:41 AM (8 years ago)

Author:

swissspidy

Message:

I18N: Introduce a user-specific language setting.

By enabling the user to select their preferred locale when editing the profile, we allow for greater personalization of the WordPress admin and therefore a better user experience.

The back end will be displayed in the user's individual locale while the locale used on the front end equals the one set for the whole site. If the user didn't specify a locale, the site's locale will be used as a fallback. The new locale property of the WP_User class can be used to retrieve the user's locale setting.

Props ocean90, ipm-frommen, swissspidy.
Fixes #29783.

Location:

trunk

Files:

• src/wp-admin/admin-header.php (modified) (1 diff)
• src/wp-admin/includes/class-wp-plugin-install-list-table.php (modified) (1 diff)
• src/wp-admin/includes/class-wp-press-this.php (modified) (1 diff)
• src/wp-admin/includes/credits.php (modified) (1 diff)
• src/wp-admin/includes/dashboard.php (modified) (1 diff)
• src/wp-admin/includes/import.php (modified) (2 diffs)
• src/wp-admin/includes/plugin-install.php (modified) (1 diff)
• src/wp-admin/includes/template.php (modified) (1 diff)
• src/wp-admin/includes/theme.php (modified) (1 diff)
• src/wp-admin/includes/user.php (modified) (1 diff)
• src/wp-admin/options.php (modified) (2 diffs)
• src/wp-admin/plugin-editor.php (modified) (1 diff)
• src/wp-admin/theme-editor.php (modified) (1 diff)
• src/wp-admin/user-edit.php (modified) (1 diff)
• src/wp-includes/class-wp-editor.php (modified) (2 diffs)
• src/wp-includes/class-wp-theme.php (modified) (1 diff)
• src/wp-includes/class-wp-user.php (modified) (1 diff)
• src/wp-includes/l10n.php (modified) (2 diffs)
• src/wp-includes/user.php (modified) (4 diffs)
• tests/phpunit/tests/l10n/getUserLocale.php (added)

trunk/src/wp-admin/admin-header.php

@@ -157 +157 @@
 $admin_body_class .= ' version-' . str_replace( '.', '-', preg_replace( '/^([.0-9]+).*/', '$1', get_bloginfo( 'version' ) ) );
 $admin_body_class .= ' admin-color-' . sanitize_html_class( get_user_option( 'admin_color' ), 'fresh' );
-$admin_body_class .= ' locale-' . sanitize_html_class( strtolower( str_replace( '_', '-', get_locale() ) ) );
+$admin_body_class .= ' locale-' . sanitize_html_class( strtolower( str_replace( '_', '-', get_user_locale() ) ) );
 
 if ( wp_is_mobile() )

trunk/src/wp-admin/includes/class-wp-plugin-install-list-table.php

@@ -135 +135 @@
             ),
             // Send the locale and installed plugin slugs to the API so it can provide context-sensitive results.
-            'locale' => get_locale(),
+            'locale' => get_user_locale(),
             'installed_plugins' => $this->get_installed_plugin_slugs(),
         );

trunk/src/wp-admin/includes/class-wp-press-this.php

@@ -1313 +1313 @@
     $admin_body_class .= ' version-' . str_replace( '.', '-', preg_replace( '/^([.0-9]+).*/', '$1', $wp_version ) );
     $admin_body_class .= ' admin-color-' . sanitize_html_class( get_user_option( 'admin_color' ), 'fresh' );
-    $admin_body_class .= ' locale-' . sanitize_html_class( strtolower( str_replace( '_', '-', get_locale() ) ) );
+    $admin_body_class .= ' locale-' . sanitize_html_class( strtolower( str_replace( '_', '-', get_user_locale() ) ) );
 
     /** This filter is documented in wp-admin/admin-header.php */

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

@@ -17 +17 @@
 function wp_credits() {
     $wp_version = get_bloginfo( 'version' );
-    $locale = get_locale();
+    $locale = get_user_locale();
 
     $results = get_site_transient( 'wordpress_credits_' . $locale );

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

@@ -1354 +1354 @@
 
         $browsehappy = 'http://browsehappy.com/';
-        $locale = get_locale();
+        $locale = get_user_locale();
         if ( 'en_US' !== $locale )
             $browsehappy = add_query_arg( 'locale', $locale, $browsehappy );

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

@@ -126 +126 @@
     include( ABSPATH . WPINC . '/version.php' ); // include an unmodified $wp_version
 
-    $locale = get_locale();
+    $locale = get_user_locale();
     $cache_key = 'popular_importers_' . md5( $locale . $wp_version );
     $popular_importers = get_site_transient( $cache_key );
@@ -132 +132 @@
     if ( ! $popular_importers ) {
         $url = add_query_arg( array(
-            'locale'  => get_locale(),
+            'locale'  => get_user_locale(),
             'version' => $wp_version,
         ), 'http://api.wordpress.org/core/importers/1.1/' );

trunk/src/wp-admin/includes/plugin-install.php

@@ -110 +110 @@
 
     if ( ! isset( $args->locale ) ) {
-        $args->locale = get_locale();
+        $args->locale = get_user_locale();
     }
 

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

@@ -1623 +1623 @@
 do_action( 'admin_head' );
 
-$admin_body_class .= ' locale-' . sanitize_html_class( strtolower( str_replace( '_', '-', get_locale() ) ) );
+$admin_body_class .= ' locale-' . sanitize_html_class( strtolower( str_replace( '_', '-', get_user_locale() ) ) );
 
 if ( is_rtl() )

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

@@ -413 +413 @@
 
     if ( ! isset( $args->locale ) ) {
-        $args->locale = get_locale();
+        $args->locale = get_user_locale();
     }
 

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

@@ -95 +95 @@
         $user->admin_color = isset( $_POST['admin_color'] ) ? sanitize_text_field( $_POST['admin_color'] ) : 'fresh';
         $user->show_admin_bar_front = isset( $_POST['admin_bar_front'] ) ? 'true' : 'false';
+        $user->locale = '';
+
+        if ( isset( $_POST['locale'] ) ) {
+            $locale = sanitize_text_field( $_POST['locale'] );
+            if ( ! in_array( $locale, get_available_languages(), true ) ) {
+                $locale = '';
+            }
+
+            $user->locale = ( '' === $locale ) ? 'en_US' : $locale;
+        }
     }
 

trunk/src/wp-admin/options.php

@@ -210 +210 @@
             if ( isset( $_POST[ $option ] ) ) {
                 $value = $_POST[ $option ];
-                if ( ! is_array( $value ) )
+                if ( ! is_array( $value ) ) {
                     $value = trim( $value );
+                }
                 $value = wp_unslash( $value );
             }
@@ -218 +219 @@
 
         // Switch translation in case WPLANG was changed.
-        $language = get_option( 'WPLANG' );
-        if ( $language ) {
-            load_default_textdomain( $language );
-        } else {
-            unload_textdomain( 'default' );
+        $language      = get_option( 'WPLANG' );
+        $user_language = get_user_locale();
+        if ( $language === $user_language ) {
+            if ( $language ) {
+                load_default_textdomain( $language );
+            } else {
+                unload_textdomain( 'default' );
+            }
         }
     }

trunk/src/wp-admin/plugin-editor.php

@@ -261 +261 @@
         </div>
         <?php if ( !empty( $docs_select ) ) : ?>
-        <div id="documentation" class="hide-if-no-js"><label for="docs-list"><?php _e('Documentation:') ?></label> <?php echo $docs_select ?> <input type="button" class="button" value="<?php esc_attr_e( 'Look Up' ) ?> " onclick="if ( '' != jQuery('#docs-list').val() ) { window.open( 'https://api.wordpress.org/core/handbook/1.0/?function=' + escape( jQuery( '#docs-list' ).val() ) + '&amp;locale=<?php echo urlencode( get_locale() ) ?>&amp;version=<?php echo urlencode( get_bloginfo( 'version' ) ) ?>&amp;redirect=true'); }" /></div>
+        <div id="documentation" class="hide-if-no-js"><label for="docs-list"><?php _e('Documentation:') ?></label> <?php echo $docs_select ?> <input type="button" class="button" value="<?php esc_attr_e( 'Look Up' ) ?> " onclick="if ( '' != jQuery('#docs-list').val() ) { window.open( 'https://api.wordpress.org/core/handbook/1.0/?function=' + escape( jQuery( '#docs-list' ).val() ) + '&amp;locale=<?php echo urlencode( get_user_locale() ) ?>&amp;version=<?php echo urlencode( get_bloginfo( 'version' ) ) ?>&amp;redirect=true'); }" /></div>
         <?php endif; ?>
 <?php if ( is_writeable($real_file) ) : ?>

trunk/src/wp-admin/theme-editor.php

@@ -264 +264 @@
         <label for="docs-list"><?php _e('Documentation:') ?></label>
         <?php echo $docs_select; ?>
-        <input type="button" class="button" value="<?php esc_attr_e( 'Look Up' ); ?>" onclick="if ( '' != jQuery('#docs-list').val() ) { window.open( 'https://api.wordpress.org/core/handbook/1.0/?function=' + escape( jQuery( '#docs-list' ).val() ) + '&amp;locale=<?php echo urlencode( get_locale() ) ?>&amp;version=<?php echo urlencode( get_bloginfo( 'version' ) ) ?>&amp;redirect=true'); }" />
+        <input type="button" class="button" value="<?php esc_attr_e( 'Look Up' ); ?>" onclick="if ( '' != jQuery('#docs-list').val() ) { window.open( 'https://api.wordpress.org/core/handbook/1.0/?function=' + escape( jQuery( '#docs-list' ).val() ) + '&amp;locale=<?php echo urlencode( get_user_locale() ) ?>&amp;version=<?php echo urlencode( get_bloginfo( 'version' ) ) ?>&amp;redirect=true'); }" />
         </div>
     <?php endif; ?>

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

@@ -270 +270 @@
 </td>
 </tr>
+
+<?php
+$languages = get_available_languages();
+if ( $languages ) : ?>
+<tr class="user-language-wrap">
+    <th scope="row">
+        <label for="site_language"><?php _e( 'Site Language' ); ?></label>
+    </th>
+    <td>
+        <?php
+        $user_locale = get_user_option( 'locale', $profileuser->ID );
+
+        if ( 'en_US' === $user_locale ) { // en_US
+            $user_locale = false;
+        } elseif ( ! in_array( $user_locale, $languages, true ) ) {
+            $user_locale = get_locale();
+        }
+
+        wp_dropdown_languages( array(
+            'name'                        => 'locale',
+            'id'                          => 'locale',
+            'selected'                    => $user_locale,
+            'languages'                   => $languages,
+            'show_available_translations' => false
+        ) );
+        ?>
+    </td>
+</tr>
+<?php
+endif;
+?>
+
 <?php
 /**

trunk/src/wp-includes/class-wp-editor.php

@@ -352 +352 @@
                 self::$baseurl = includes_url( 'js/tinymce' );
 
-                $mce_locale = get_locale();
+                $mce_locale = get_user_locale();
                 self::$mce_locale = $mce_locale = empty( $mce_locale ) ? 'en' : strtolower( substr( $mce_locale, 0, 2 ) ); // ISO 639-1
 
@@ -673 +673 @@
             }
 
-            $body_class .= ' locale-' . sanitize_html_class( strtolower( str_replace( '_', '-', get_locale() ) ) );
+            $body_class .= ' locale-' . sanitize_html_class( strtolower( str_replace( '_', '-', get_user_locale() ) ) );
 
             if ( !empty($set['tinymce']['body_class']) ) {

trunk/src/wp-includes/class-wp-theme.php

@@ -1396 +1396 @@
      */
     public static function sort_by_name( &$themes ) {
-        if ( 0 === strpos( get_locale(), 'en_' ) ) {
+        if ( 0 === strpos( get_user_locale(), 'en_' ) ) {
             uasort( $themes, array( 'WP_Theme', '_name_sort' ) );
         } else {

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

@@ -32 +32 @@
  * @property string $spam
  * @property string $deleted
+ * @property string $locale
  */
 class WP_User {

trunk/src/wp-includes/l10n.php

@@ -77 +77 @@
 
 /**
+ * Retrieves the locale of the current user.
+ *
+ * If the user has a locale set to a non-empty string then it will be
+ * returned. Otherwise it returns the locale of get_locale().
+ *
+ * @since 4.7.0
+ *
+ * @return string The locale of the current user.
+ */
+function get_user_locale() {
+    $user = wp_get_current_user();
+
+    $locale = $user->locale;
+    return ( '' === $locale ) ? get_locale() : $locale;
+}
+
+/**
  * Retrieve the translation of $text.
  *
@@ -634 +651 @@
 function load_default_textdomain( $locale = null ) {
     if ( null === $locale ) {
-        $locale = get_locale();
+        $locale = is_admin() ? get_user_locale() : get_locale();
     }
 

trunk/src/wp-includes/user.php

@@ -1359 +1359 @@
  * @since 3.6.0 The `aim`, `jabber`, and `yim` fields were removed as default user contact
  *              methods for new installs. See wp_get_user_contact_methods().
+ * @since 4.7.0 The user's locale can be passed to `$userdata`.
  *
  * @global wpdb $wpdb WordPress database abstraction object.
@@ -1393 +1394 @@
  *                                             site's front end. Default true.
  *     @type string      $role                 User's role.
+ *     @type string      $locale               User's locale. Default empty.
  * }
  * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not
@@ -1606 +1608 @@
 
     $meta['show_admin_bar_front'] = empty( $userdata['show_admin_bar_front'] ) ? 'true' : $userdata['show_admin_bar_front'];
+
+    $meta['locale'] = isset( $userdata['locale'] ) ? $userdata['locale'] : '';
 
     $user_nicename_check = $wpdb->get_var( $wpdb->prepare("SELECT ID FROM $wpdb->users WHERE user_nicename = %s AND user_login != %s LIMIT 1" , $user_nicename, $user_login));
@@ -1966 +1970 @@
  */
 function _get_additional_user_keys( $user ) {
-    $keys = array( 'first_name', 'last_name', 'nickname', 'description', 'rich_editing', 'comment_shortcuts', 'admin_color', 'use_ssl', 'show_admin_bar_front' );
+    $keys = array( 'first_name', 'last_name', 'nickname', 'description', 'rich_editing', 'comment_shortcuts', 'admin_color', 'use_ssl', 'show_admin_bar_front', 'locale' );
     return array_merge( $keys, array_keys( wp_get_user_contact_methods( $user ) ) );
 }