Changeset 58066

Timestamp:

04/30/2024 09:45:39 AM (6 months ago)

Author:

swissspidy

Message:

I18N: Bail early if an invalid text domain is passed to load_textdomain() et al.

Some plugins pass invalid values such as null instead of a string, which has never been supported by WordPress (no translations are loaded) and was technically undefined behavior. With the introduction of the new l10n library in #59656, which has stricter type hints, this could end up causing warnings or even fatal errors.

This change adds a deliberate short-circuit to load_textdomain() & co. to better handle such a case and document that it is not supported.

Merges [57925] to the 6.5 branch.
Reviewed by jorbin.

Props verygoode, swissspidy.
Fixes #60888.

Location:

branches/6.5

Files:

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

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

@@ -729 +729 @@
     $l10n_unloaded = (array) $l10n_unloaded;
 
+    if ( ! is_string( $domain ) ) {
+        return false;
+    }
+
     /**
      * Filters whether to short-circuit loading .mo file.
@@ -990 +994 @@
     global $wp_textdomain_registry;
 
+    if ( ! is_string( $domain ) ) {
+        return false;
+    }
+
     /**
      * Filters a plugin's locale.
@@ -1038 +1046 @@
     global $wp_textdomain_registry;
 
+    if ( ! is_string( $domain ) ) {
+        return false;
+    }
+
     /** This filter is documented in wp-includes/l10n.php */
     $locale = apply_filters( 'plugin_locale', determine_locale(), $domain );
@@ -1076 +1088 @@
     /** @var WP_Textdomain_Registry $wp_textdomain_registry */
     global $wp_textdomain_registry;
+
+    if ( ! is_string( $domain ) ) {
+        return false;
+    }
 
     /**

branches/6.5/tests/phpunit/tests/l10n/loadTextdomain.php

@@ -317 +317 @@
         $this->assertSame( 0, $override_load_textdomain_callback->get_call_count(), 'Expected override_load_textdomain not to be called.' );
     }
+
+    /**
+     * @ticket 60888
+     * @covers ::load_plugin_textdomain
+     */
+    public function test_load_plugin_textdomain_invalid_domain() {
+        $this->assertFalse( load_plugin_textdomain( null ) );
+    }
+
+    /**
+     * @ticket 60888
+     * @covers ::load_muplugin_textdomain
+     */
+    public function test_load_muplugin_textdomain_invalid_domain() {
+        $this->assertFalse( load_muplugin_textdomain( null ) );
+    }
+
+    /**
+     * @ticket 60888
+     * @covers ::load_theme_textdomain
+     */
+    public function test_load_theme_textdomain_invalid_domain() {
+        $this->assertFalse( load_theme_textdomain( null ) );
+    }
+
+    /**
+     * @ticket 60888
+     * @covers ::load_textdomain
+     */
+    public function test_load_textdomain_invalid_domain() {
+        $this->assertFalse( load_textdomain( null, DIR_TESTDATA . '/pomo/thisfiledoesnotexist.mo' ) );
+    }
 }