Changeset 43776 for branches/5.0/src/wp-includes/l10n.php

Timestamp:

10/21/2018 03:02:49 PM (6 years ago)

Author:

danielbachhuber

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.

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

File:

• branches/5.0/src/wp-includes/l10n.php (modified) (8 diffs)

branches/5.0/src/wp-includes/l10n.php

@@ -106 +106 @@
 
 /**
+ * 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 );
+}
+
+/**
  * Retrieve the translation of $text.
  *
@@ -664 +712 @@
 function load_default_textdomain( $locale = null ) {
     if ( null === $locale ) {
-        $locale = is_admin() ? get_user_locale() : get_locale();
+        $locale = determine_locale();
     }
 
@@ -712 +760 @@
      * @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';
@@ -746 +794 @@
 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';
@@ -785 +833 @@
      * @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';
@@ -916 +964 @@
     }
 
-    $locale = is_admin() ? get_user_locale() : get_locale();
+    $locale = determine_locale();
     $mofile = "{$domain}-{$locale}.mo";
 
@@ -1211 +1259 @@
     );
 
-    // List installed languages. 
+    // List installed languages.
     foreach ( $languages as $language ) {
         $structure[] = sprintf(
@@ -1348 +1396 @@
         '' => array(
             'domain' => $domain,
-            'lang'   => is_admin() ? get_user_locale() : get_locale(),
+            'lang'   => determine_locale(),
         ),
     );