Make WordPress Core


Ignore:
Timestamp:
09/28/2022 05:31:53 PM (21 months 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.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/tests/phpunit/tests/dependencies/scripts.php

    r54289 r54349  
    722722        $wp_scripts->do_concat = true;
    723723
    724         if ( PHP_VERSION_ID >= 80100 ) {
    725             /*
    726              * For the time being, ignoring PHP 8.1 "null to non-nullable" deprecations coming in
    727              * via hooked in filter functions until a more structural solution to the
    728              * "missing input validation" conundrum has been architected and implemented.
    729              */
    730             $this->expectDeprecation();
    731             $this->expectDeprecationMessageMatches( '`Passing null to parameter \#[0-9]+ \(\$[^\)]+\) of type [^ ]+ is deprecated`' );
    732         }
    733 
    734724        $ver       = get_bloginfo( 'version' );
    735725        $suffix    = wp_scripts_get_suffix();
     
    783773        $wp_scripts->base_url  = '';
    784774        $wp_scripts->do_concat = true;
    785 
    786         if ( PHP_VERSION_ID >= 80100 ) {
    787             /*
    788              * For the time being, ignoring PHP 8.1 "null to non-nullable" deprecations coming in
    789              * via hooked in filter functions until a more structural solution to the
    790              * "missing input validation" conundrum has been architected and implemented.
    791              */
    792             $this->expectDeprecation();
    793             $this->expectDeprecationMessageMatches( '`Passing null to parameter \#[0-9]+ \(\$[^\)]+\) of type [^ ]+ is deprecated`' );
    794         }
    795775
    796776        $expected_tail  = "<script type='text/javascript' src='/customize-dependency.js' id='customize-dependency-js'></script>\n";
Note: See TracChangeset for help on using the changeset viewer.