Changeset 55865

Timestamp:

05/29/2023 08:34:43 AM (3 years ago)

Author:

swissspidy

Message:

I18N: Improve _load_textdomain_just_in_time() logic when there are no translation files.

Fixes a performance issue where the JIT logic is invoked for every translation call if the there are no translations in the current locale. With this change, the information is cached by adding Noop_Translations instances to the global $l10n array. This way, get_translations_for_domain() returns earlier, thus avoiding subsequent _load_textdomain_just_in_time() calls.

Props swissspidy, johnbillion, ocean90.
Fixes #58321.

Location:

trunk

Files:

• src/wp-includes/class-wp-textdomain-registry.php (modified) (1 diff)
• src/wp-includes/l10n.php (modified) (3 diffs)
• tests/phpunit/tests/l10n/loadTextdomainJustInTime.php (modified) (1 diff)
• tests/phpunit/tests/l10n/wpLocaleSwitcher.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-textdomain-registry.php

@@ -98 +98 @@
         public function has( $domain ) {
                 return (
-                        ! empty( $this->current[ $domain ] ) ||
+                        isset( $this->current[ $domain ] ) ||
                         empty( $this->all[ $domain ] ) ||
                         in_array( $domain, $this->domains_with_translations, true )

trunk/src/wp-includes/l10n.php

@@ -835 +835 @@
 
         if ( isset( $l10n[ $domain ] ) ) {
+                if ( $l10n[ $domain ] instanceof NOOP_Translations ) {
+                        unset( $l10n[ $domain ] );
+
+                        return false;
+                }
+
                 unset( $l10n[ $domain ] );
 
@@ -1308 +1314 @@
         }
 
+        $l10n[ $domain ] = &$noop_translations;
+
         return $noop_translations;
 }
@@ -1323 +1331 @@
 function is_textdomain_loaded( $domain ) {
         global $l10n;
-        return isset( $l10n[ $domain ] );
+        return isset( $l10n[ $domain ] ) && ! $l10n[ $domain ] instanceof NOOP_Translations;
 }
 

trunk/tests/phpunit/tests/l10n/loadTextdomainJustInTime.php

@@ -123 +123 @@
 
         /**
+         * @ticket 58321
+         *
+         * @covers ::get_translations_for_domain
+         */
+        public function test_get_translations_for_domain_get_locale_is_called_only_once() {
+                $filter_locale = new MockAction();
+                add_filter( 'locale', array( $filter_locale, 'filter' ) );
+
+                get_translations_for_domain( 'internationalized-plugin' );
+                get_translations_for_domain( 'internationalized-plugin' );
+                get_translations_for_domain( 'internationalized-plugin' );
+                $translations = get_translations_for_domain( 'internationalized-plugin' );
+
+                remove_filter( 'locale', array( $filter_locale, 'filter' ) );
+
+                $this->assertSame( 1, $filter_locale->get_call_count() );
+                $this->assertInstanceOf( 'NOOP_Translations', $translations );
+                $this->assertFalse( is_textdomain_loaded( 'internationalized-plugin' ) );
+        }
+
+        /**
          * @ticket 37113
          *

trunk/tests/phpunit/tests/l10n/wpLocaleSwitcher.php

@@ -385 +385 @@
                 $locale_switched_site_locale  = switch_to_locale( $site_locale ); // True.
                 $site_locale_after_switch     = get_locale();
-                $language_header_after_switch = isset( $l10n['default'] ); // en_US
+                $language_header_after_switch = is_textdomain_loaded( 'default' ); // en_US
 
                 restore_current_locale();