Changeset 59157

Timestamp:

10/02/2024 01:42:11 PM (6 months ago)

Author:

swissspidy

Message:

I18N: Do not load translations directly in load_*_textdomain.

In [59127], _doing_it_wrong warnings were added if plugins or themes load translations too early, either through a manual function call or just-in-time loading.

Because many plugins and themes still manually call load_plugin_textdomain(), load_theme_textdomain() or load_muplugin_textdomain(), even though they don't have to anymore, that caused a lot of warnings.

With this new approach, these functions merely register the translations path in the existing WP_Textdomain_Registry and do not immediately try to load the translations anymore. The loading is all handled by the just-in-time functionality.

This way, warnings will only be emitted if triggering the just-in-time loading too early, greatly improving the developer experience and to a degree also performance.

Props swissspidy, sergeybiryukov, mukesh27.
See #44937.

Location:

trunk

Files:

• src/wp-includes/l10n.php (modified) (9 diffs)
• tests/phpunit/tests/l10n/loadTextdomain.php (modified) (4 diffs)
• tests/phpunit/tests/rest-api/rest-themes-controller.php (modified) (1 diff)

trunk/src/wp-includes/l10n.php

@@ -984 +984 @@
  * @since 1.5.0
  * @since 4.6.0 The function now tries to load the .mo file from the languages directory first.
+ * @since 6.7.0 Translations are no longer immediately loaded, but handed off to the just-in-time loading mechanism.
  *
  * @param string       $domain          Unique identifier for retrieving translated strings
@@ -998 +999 @@
     if ( ! is_string( $domain ) ) {
         return false;
-    }
-
-    if ( ! doing_action( 'after_setup_theme' ) && ! did_action( 'after_setup_theme' ) ) {
-        _doing_it_wrong(
-            __FUNCTION__,
-            sprintf(
-                /* translators: 1: The text domain. 2: 'after_setup_theme'. */
-                __( 'Attempted to load translations for the %1$s domain too early. Translations should be loaded after the %2$s action has fired, to ensure that the current user is already set up.' ),
-                '<code>' . $domain . '</code>',
-                '<code>after_setup_theme</code>'
-            ),
-            '6.7.0'
-        );
-    }
-
-    /**
-     * Filters a plugin's locale.
-     *
-     * @since 3.0.0
-     *
-     * @param string $locale The plugin's current locale.
-     * @param string $domain Text domain. Unique identifier for retrieving translated strings.
-     */
-    $locale = apply_filters( 'plugin_locale', determine_locale(), $domain );
-
-    $mofile = $domain . '-' . $locale . '.mo';
-
-    // Try to load from the languages directory first.
-    if ( load_textdomain( $domain, WP_LANG_DIR . '/plugins/' . $mofile, $locale ) ) {
-        return true;
     }
 
@@ -1041 +1012 @@
     $wp_textdomain_registry->set_custom_path( $domain, $path );
 
-    return load_textdomain( $domain, $path . '/' . $mofile, $locale );
+    return true;
 }
 
@@ -1049 +1020 @@
  * @since 3.0.0
  * @since 4.6.0 The function now tries to load the .mo file from the languages directory first.
+ * @since 6.7.0 Translations are no longer immediately loaded, but handed off to the just-in-time loading mechanism.
  *
  * @global WP_Textdomain_Registry $wp_textdomain_registry WordPress Textdomain Registry.
@@ -1065 +1037 @@
     }
 
-    if ( ! doing_action( 'after_setup_theme' ) && ! did_action( 'after_setup_theme' ) ) {
-        _doing_it_wrong(
-            __FUNCTION__,
-            sprintf(
-                /* translators: 1: The text domain. 2: 'after_setup_theme'. */
-                __( 'Attempted to load translations for the %1$s domain too early. Translations should be loaded after the %2$s action has fired, to ensure that the current user is already set up.' ),
-                '<code>' . $domain . '</code>',
-                '<code>after_setup_theme</code>'
-            ),
-            '6.7.0'
-        );
-    }
-
-    /** This filter is documented in wp-includes/l10n.php */
-    $locale = apply_filters( 'plugin_locale', determine_locale(), $domain );
-
-    $mofile = $domain . '-' . $locale . '.mo';
-
-    // Try to load from the languages directory first.
-    if ( load_textdomain( $domain, WP_LANG_DIR . '/plugins/' . $mofile, $locale ) ) {
-        return true;
-    }
-
     $path = WPMU_PLUGIN_DIR . '/' . ltrim( $mu_plugin_rel_path, '/' );
 
     $wp_textdomain_registry->set_custom_path( $domain, $path );
 
-    return load_textdomain( $domain, $path . '/' . $mofile, $locale );
+    return true;
 }
 
@@ -1105 +1054 @@
  * @since 1.5.0
  * @since 4.6.0 The function now tries to load the .mo file from the languages directory first.
+ * @since 6.7.0 Translations are no longer immediately loaded, but handed off to the just-in-time loading mechanism.
  *
  * @global WP_Textdomain_Registry $wp_textdomain_registry WordPress Textdomain Registry.
@@ -1121 +1071 @@
     }
 
-    if ( ! doing_action( 'after_setup_theme' ) && ! did_action( 'after_setup_theme' ) ) {
-        _doing_it_wrong(
-            __FUNCTION__,
-            sprintf(
-                /* translators: 1: The text domain. 2: 'after_setup_theme'. */
-                __( 'Attempted to load translations for the %1$s domain too early. Translations should be loaded after the %2$s action has fired, to ensure that the current user is already set up.' ),
-                '<code>' . $domain . '</code>',
-                '<code>after_setup_theme</code>'
-            ),
-            '6.7.0'
-        );
-    }
-
-    /**
-     * Filters a theme's locale.
-     *
-     * @since 3.0.0
-     *
-     * @param string $locale The theme's current locale.
-     * @param string $domain Text domain. Unique identifier for retrieving translated strings.
-     */
-    $locale = apply_filters( 'theme_locale', determine_locale(), $domain );
-
-    $mofile = $domain . '-' . $locale . '.mo';
-
-    // Try to load from the languages directory first.
-    if ( load_textdomain( $domain, WP_LANG_DIR . '/themes/' . $mofile, $locale ) ) {
-        return true;
-    }
-
     if ( ! $path ) {
         $path = get_template_directory();
@@ -1157 +1077 @@
     $wp_textdomain_registry->set_custom_path( $domain, $path );
 
-    return load_textdomain( $domain, $path . '/' . $locale . '.mo', $locale );
+    return true;
 }
 
@@ -1426 +1346 @@
             __FUNCTION__,
             sprintf(
-                /* translators: %s: The text domain. */
-                __( 'Translation loading for the %s domain was triggered too early. This is usually an indicator for some code in the plugin or theme running too early.' ),
-                '<code>' . $domain . '</code>'
+                /* translators: 1: The text domain. 2: 'init'. */
+                __( 'Translation loading for the %1$s domain was triggered too early. This is usually an indicator for some code in the plugin or theme running too early. Translations should be loaded at the %2$s action or later.' ),
+                '<code>' . $domain . '</code>',
+                '<code>init</code>'
             ),
             '6.7.0'

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

@@ -6 +6 @@
  */
 class Tests_L10n_LoadTextdomain extends WP_UnitTestCase {
-    protected $locale;
     protected static $user_id;
 
@@ -21 +20 @@
         parent::set_up();
 
-        $this->locale = '';
-
-        add_filter( 'plugin_locale', array( $this, 'store_locale' ) );
-        add_filter( 'theme_locale', array( $this, 'store_locale' ) );
-
         /** @var WP_Textdomain_Registry $wp_textdomain_registry */
         global $wp_textdomain_registry;
@@ -40 +34 @@
 
         parent::tear_down();
-    }
-
-    public function store_locale( $locale ) {
-        $this->locale = $locale;
-
-        return $locale;
     }
 
@@ -234 +222 @@
 
     /**
-     * @covers ::load_muplugin_textdomain
-     */
-    public function test_load_muplugin_textdomain_site_locale() {
-        load_muplugin_textdomain( 'wp-tests-domain' );
-
-        $this->assertSame( get_locale(), $this->locale );
-    }
-
-    /**
-     * @ticket 38485
-     *
-     * @covers ::load_muplugin_textdomain
-     */
-    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' );
-
-        $this->assertSame( get_user_locale(), $this->locale );
-    }
-
-    /**
-     * @covers ::load_plugin_textdomain
-     */
-    public function test_load_plugin_textdomain_site_locale() {
-        load_plugin_textdomain( 'wp-tests-domain' );
-
-        $this->assertSame( get_locale(), $this->locale );
-    }
-
-    /**
-     * @ticket 38485
-     *
-     * @covers ::load_plugin_textdomain
-     */
-    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' );
-
-        $this->assertSame( get_user_locale(), $this->locale );
-    }
-
-    /**
-     * @covers ::load_theme_textdomain
-     */
-    public function test_load_theme_textdomain_site_locale() {
-        load_theme_textdomain( 'wp-tests-domain' );
-
-        $this->assertSame( get_locale(), $this->locale );
-    }
-
-    /**
-     * @ticket 38485
-     *
-     * @covers ::load_theme_textdomain
-     */
-    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' );
-
-        $this->assertSame( get_user_locale(), $this->locale );
-    }
-
-    /**
      * @ticket 58035
      *

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

@@ -583 +583 @@
         $result   = $response->get_data();
         $this->assertArrayHasKey( 'tags', $result[0] );
-        $this->assertSame( array( 'holiday', 'custom-menu' ), $result[0]['tags']['raw'] );
-        $this->assertSame( 'holiday, custom-menu', $result[0]['tags']['rendered'] );
+        $this->assertSame( array( 'Holiday', 'custom-menu' ), $result[0]['tags']['raw'] );
+        $this->assertSame( 'Holiday, custom-menu', $result[0]['tags']['rendered'] );
     }