Changeset 54349

Timestamp:

09/28/2022 05:31:53 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Use correct default value for JavaScript translations path.

The $path parameter of load_script_textdomain() had a default value of null, but would be passed onto the untrailingslashit() function without any input validation, even though the latter explicitly only expects/supports a string input.

This commit changes the default value for $path to an empty string, and adds an is_string() check before passing the value to untrailingslashit() to fix the issue at the point where the invalid input is incorrectly (not) validated.

Note: Changing the untrailingslashit() function is outside the scope of this commit.

Includes:

• Adding a dedicated unit test for this issue.
• Correcting the default value for $path from null to an empty string in a few related methods and functions:
  • WP_Dependency::set_translations()
  • WP_Scripts::set_translations()
  • wp_set_script_translations()
  • load_script_textdomain()

This fix also allows to remove a couple of calls to expectDeprecation() in unrelated tests.

Fixes an error when running the test suite:

4) Tests_Dependencies_Scripts::test_wp_external_wp_i18n_print_order
rtrim(): Passing null to parameter #1 ($string) of type string is deprecated

/var/www/src/wp-includes/formatting.php:2782
/var/www/src/wp-includes/l10n.php:1068
/var/www/src/wp-includes/class.wp-scripts.php:605
/var/www/src/wp-includes/class.wp-scripts.php:320
/var/www/src/wp-includes/class.wp-dependencies.php:136
/var/www/src/wp-includes/functions.wp-scripts.php:109
/var/www/tests/phpunit/tests/dependencies/scripts.php:1505
/var/www/tests/phpunit/includes/utils.php:436
/var/www/tests/phpunit/tests/dependencies/scripts.php:1507
/var/www/vendor/bin/phpunit:123

Follow-up to [44169], [44607], [51968].

Props jrf, ocean90, Chouby, swissspidy, lovor, iviweb, meysamnorouzi, DarkoG, oneearth27, SergeyBiryukov.
Fixes #55967. See #55656.

Location:

trunk

Files:

• src/wp-includes/l10n.php (modified) (2 diffs)
• tests/phpunit/tests/dependencies/scripts.php (modified) (2 diffs)
• tests/phpunit/tests/l10n/loadScriptTextdomain.php (modified) (1 diff)

trunk/src/wp-includes/l10n.php

@@ -1059 +1059 @@
  *                      false if the script textdomain could not be loaded.
  */
-function load_script_textdomain( $handle, $domain = 'default', $path = null ) {
+function load_script_textdomain( $handle, $domain = 'default', $path = '' ) {
     $wp_scripts = wp_scripts();
 
@@ -1066 +1066 @@
     }
 
-    $path   = untrailingslashit( $path );
+    if ( is_string( $path ) ) {
+        $path = untrailingslashit( $path );
+    }
+
     $locale = determine_locale();
 

trunk/tests/phpunit/tests/dependencies/scripts.php

@@ -722 +722 @@
         $wp_scripts->do_concat = true;
 
-        if ( PHP_VERSION_ID >= 80100 ) {
-            /*
-             * For the time being, ignoring PHP 8.1 "null to non-nullable" deprecations coming in
-             * via hooked in filter functions until a more structural solution to the
-             * "missing input validation" conundrum has been architected and implemented.
-             */
-            $this->expectDeprecation();
-            $this->expectDeprecationMessageMatches( '`Passing null to parameter \#[0-9]+ \(\$[^\)]+\) of type [^ ]+ is deprecated`' );
-        }
-
         $ver       = get_bloginfo( 'version' );
         $suffix    = wp_scripts_get_suffix();
@@ -783 +773 @@
         $wp_scripts->base_url  = '';
         $wp_scripts->do_concat = true;
-
-        if ( PHP_VERSION_ID >= 80100 ) {
-            /*
-             * For the time being, ignoring PHP 8.1 "null to non-nullable" deprecations coming in
-             * via hooked in filter functions until a more structural solution to the
-             * "missing input validation" conundrum has been architected and implemented.
-             */
-            $this->expectDeprecation();
-            $this->expectDeprecationMessageMatches( '`Passing null to parameter \#[0-9]+ \(\$[^\)]+\) of type [^ ]+ is deprecated`' );
-        }
 
         $expected_tail  = "<script type='text/javascript' src='/customize-dependency.js' id='customize-dependency-js'></script>\n";

trunk/tests/phpunit/tests/l10n/loadScriptTextdomain.php

@@ -132 +132 @@
         return $relative;
     }
+
+    /**
+     * Tests that PHP 8.1 "passing null to non-nullable" deprecation notice
+     * is not thrown when passing the default `$path` to untrailingslashit() in the function.
+     *
+     * The notice that we should not see:
+     * `Deprecated: rtrim(): Passing null to parameter #1 ($string) of type string is deprecated`.
+     *
+     * @ticket 55967
+     */
+    public function test_does_not_throw_deprecation_notice_for_rtrim_with_default_parameters() {
+        $handle = 'test-example-root';
+        $src    = '/wp-includes/js/script.js';
+
+        wp_enqueue_script( $handle, $src );
+
+        $expected = file_get_contents( DIR_TESTDATA . '/languages/en_US-813e104eb47e13dd4cc5af844c618754.json' );
+        $this->assertSame( $expected, load_script_textdomain( $handle ) );
+    }
 }