Changeset 44134

Timestamp:

12/14/2018 01:31:27 AM (6 years ago)

Author:

jeremyfelt

Message:

REST API: Render response in user locale with ?_locale=user.

Introduces new determine_locale() function for deciding the proper locale to use for a response. Default value is get_user_locale() in the admin, and get_locale() on the frontend. Because REST API requests are considered frontend requests, ?_locale=user can be used to render the response in the user's locale.

Also updates wp-login.php?wp_lang implementation to benefit from this abstraction.

Merges [43776] from the 5.0 branch to trunk.

Props flixos90, mnelson4, swissspidy, TimothyBlynJacobs.
Fixes #44758.

Location:

trunk

Files:

• . (modified) (1 prop)
• src/wp-includes/class-wp-locale-switcher.php (modified) (2 diffs)
• src/wp-includes/general-template.php (modified) (1 diff)
• src/wp-includes/l10n.php (modified) (6 diffs)
• src/wp-includes/script-loader.php (modified) (1 diff)
• src/wp-login.php (modified) (7 diffs)

trunk/src/wp-includes/class-wp-locale-switcher.php

@@ -46 +46 @@
      */
     public function __construct() {
-        $this->original_locale     = is_admin() ? get_user_locale() : get_locale();
+        $this->original_locale     = determine_locale();
         $this->available_languages = array_merge( array( 'en_US' ), get_available_languages() );
     }
@@ -70 +70 @@
      */
     public function switch_to_locale( $locale ) {
-        $current_locale = is_admin() ? get_user_locale() : get_locale();
+        $current_locale = determine_locale();
         if ( $current_locale === $locale ) {
             return false;

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

@@ -719 +719 @@
             $output = __( 'html_lang_attribute' );
             if ( 'html_lang_attribute' === $output || preg_match( '/[^a-zA-Z0-9-]/', $output ) ) {
-                $output = is_admin() ? get_user_locale() : get_locale();
+                $output = determine_locale();
                 $output = str_replace( '_', '-', $output );
             }

trunk/src/wp-includes/l10n.php

@@ -103 +103 @@
     $locale = $user->locale;
     return $locale ? $locale : get_locale();
+}
+
+/**
+ * Determine the current locale desired for the request.
+ *
+ * @since 5.0.0
+ *
+ * @global string $pagenow
+ *
+ * @return string The determined locale.
+ */
+function determine_locale() {
+    /**
+     * Filters the locale for the current request prior to the default determination process.
+     *
+     * Using this filter allows to override the default logic, effectively short-circuiting the function.
+     *
+     * @since 5.0.0
+     *
+     * @param string|null The locale to return and short-circuit, or null as default.
+     */
+    $determined_locale = apply_filters( 'pre_determine_locale', null );
+    if ( ! empty( $determined_locale ) && is_string( $determined_locale ) ) {
+        return $determined_locale;
+    }
+
+    $determined_locale = get_locale();
+
+    if ( is_admin() ) {
+        $determined_locale = get_user_locale();
+    }
+
+    if ( isset( $_GET['_locale'] ) && 'user' === $_GET['_locale'] && wp_is_json_request() && is_user_logged_in() ) {
+        $determined_locale = get_user_locale();
+    }
+
+    if ( ! empty( $_GET['wp_lang'] ) && 'wp-login.php' === $GLOBALS['pagenow'] ) {
+        $determined_locale = sanitize_text_field( $_GET['wp_lang'] );
+    }
+
+    /**
+     * Filters the locale for the current request.
+     *
+     * @since 5.0.0
+     *
+     * @param string $locale The locale.
+     */
+    return apply_filters( 'determine_locale', $determined_locale );
 }
 
@@ -686 +734 @@
 function load_default_textdomain( $locale = null ) {
     if ( null === $locale ) {
-        $locale = is_admin() ? get_user_locale() : get_locale();
+        $locale = determine_locale();
     }
 
@@ -735 +783 @@
      * @param string $domain Text domain. Unique identifier for retrieving translated strings.
      */
-    $locale = apply_filters( 'plugin_locale', is_admin() ? get_user_locale() : get_locale(), $domain );
+    $locale = apply_filters( 'plugin_locale', determine_locale(), $domain );
 
     $mofile = $domain . '-' . $locale . '.mo';
@@ -769 +817 @@
 function load_muplugin_textdomain( $domain, $mu_plugin_rel_path = '' ) {
     /** This filter is documented in wp-includes/l10n.php */
-    $locale = apply_filters( 'plugin_locale', is_admin() ? get_user_locale() : get_locale(), $domain );
+    $locale = apply_filters( 'plugin_locale', determine_locale(), $domain );
 
     $mofile = $domain . '-' . $locale . '.mo';
@@ -808 +856 @@
      * @param string $domain Text domain. Unique identifier for retrieving translated strings.
      */
-    $locale = apply_filters( 'theme_locale', is_admin() ? get_user_locale() : get_locale(), $domain );
+    $locale = apply_filters( 'theme_locale', determine_locale(), $domain );
 
     $mofile = $domain . '-' . $locale . '.mo';
@@ -942 +990 @@
     }
 
-    $locale = is_admin() ? get_user_locale() : get_locale();
+    $locale = determine_locale();
     $mofile = "{$domain}-{$locale}.mo";
 

trunk/src/wp-includes/script-loader.php

@@ -955 +955 @@
             wp_json_encode(
                 array(
-                    'language' => strtolower( strtok( is_admin() ? get_user_locale() : get_locale(), '_-' ) ),
+                    'language' => strtolower( strtok( determine_locale(), '_-' ) ),
                     'strings'  => array(
                         'mejs.install-flash'       => __( 'You are using a browser that does not have Flash player enabled or installed. Please turn on your Flash player plugin or download the latest version from https://get.adobe.com/flashplayer/' ),

trunk/src/wp-login.php

@@ -465 +465 @@
 }
 
-$lang            = ! empty( $_GET['wp_lang'] ) ? sanitize_text_field( $_GET['wp_lang'] ) : '';
-$switched_locale = switch_to_locale( $lang );
-
 /**
  * Fires when the login form is initialized.
@@ -528 +525 @@
         setcookie( 'wp-postpass_' . COOKIEHASH, $hasher->HashPassword( wp_unslash( $_POST['post_password'] ) ), $expire, COOKIEPATH, COOKIE_DOMAIN, $secure );
 
-        if ( $switched_locale ) {
-            restore_previous_locale();
-        }
-
         wp_safe_redirect( wp_get_referer() );
         exit();
@@ -547 +540 @@
             $redirect_to           = 'wp-login.php?loggedout=true';
             $requested_redirect_to = '';
-        }
-
-        if ( $switched_locale ) {
-            restore_previous_locale();
         }
 
@@ -649 +638 @@
         <?php
         login_footer( 'user_login' );
-
-        if ( $switched_locale ) {
-            restore_previous_locale();
-        }
 
         break;
@@ -781 +766 @@
         login_footer( 'user_pass' );
 
-        if ( $switched_locale ) {
-            restore_previous_locale();
-        }
-
         break;
 
@@ -867 +848 @@
         <?php
         login_footer( 'user_login' );
-
-        if ( $switched_locale ) {
-            restore_previous_locale();
-        }
 
         break;
@@ -1180 +1157 @@
         login_footer();
 
-        if ( $switched_locale ) {
-            restore_previous_locale();
-        }
-
         break;
 } // End action switch.