Changeset 55928

Timestamp:

06/16/2023 12:56:03 PM (3 years ago)

Author:

swissspidy

Message:

I18N: Allow to short-circuit load_textdomain().

Introduces a new pre_load_textdomain filter, which is useful for plugins to develop and test alternative loading/caching strategies for translations. This brings consistency with the existing pre_load_script_translations filter for JavaScript translations.

Props ocean90, swissspidy.
Fixes #58035.

Location:

trunk

Files:

• src/wp-includes/l10n.php (modified) (1 diff)
• tests/phpunit/tests/l10n/loadTextdomain.php (modified) (1 diff)

trunk/src/wp-includes/l10n.php

@@ -717 +717 @@
 
         $l10n_unloaded = (array) $l10n_unloaded;
+
+        /**
+         * Filters whether to short-circuit loading .mo file.
+         *
+         * Returning a non-null value from the filter will effectively short-circuit
+         * the loading, returning the passed value instead.
+         *
+         * @since 6.3.0
+         *
+         * @param bool|null   $loaded The result of loading a .mo file. Default null.
+         * @param string      $domain Text domain. Unique identifier for retrieving translated strings.
+         * @param string      $mofile Path to the MO file.
+         * @param string|null $locale Locale.
+         */
+        $loaded = apply_filters( 'pre_load_textdomain', null, $domain, $mofile, $locale );
+        if ( null !== $loaded ) {
+                if ( true === $loaded ) {
+                        unset( $l10n_unloaded[ $domain ] );
+                }
+
+                return $loaded;
+        }
 
         /**

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

@@ -301 +301 @@
                 $this->assertSame( get_user_locale(), $this->locale );
         }
+
+        /**
+         * @ticket 58035
+         *
+         * @covers ::load_theme_textdomain
+         */
+        public function test_pre_load_textdomain_filter() {
+                $override_load_textdomain_callback = new MockAction();
+                add_filter( 'override_load_textdomain', array( $override_load_textdomain_callback, 'action' ) );
+
+                add_filter( 'pre_load_textdomain', '__return_true' );
+                load_plugin_textdomain( 'wp-tests-domain' );
+                remove_filter( 'pre_load_textdomain', '__return_true' );
+
+                $this->assertSame( 0, $override_load_textdomain_callback->get_call_count(), 'Expected override_load_textdomain not to be called.' );
+        }
 }