Context Navigation

← Previous Change
Next Change →

loadScriptTextdomain.php

Timestamp:

05/07/2026 09:22:08 PM (2 months ago)

Author:

jorbin

Message:

I18N: Harden against undefined index in _load_script_textdomain_from_src().

This guards against an undefined index warning being raised when a script or script module is registered with a URL that lacks a path component.

This also adds full PHPStan type definitions for wp_parse_url(), ensuring that the _load_script_textdomain_from_src() function has no PHPStan errors at rule level 10.

Developed in https://github.com/WordPress/wordpress-develop/pull/11690

Follow-up to r62278.

Reviewed by desrosj, jorbin.
Merges [62293] to the 7.0 branch.

Props westonruter, manzoorwanijk, mukesh27.
See #65015, #64238.

Location:

branches/7.0

Files:

: 2 edited

. (modified) (1 prop)
tests/phpunit/tests/l10n/loadScriptTextdomain.php (modified) (1 diff)

Legend:

: Unmodified
: Added
: Removed

branches/7.0
- Property svn:mergeinfo changed
  /trunk merged: 62293

branches/7.0/tests/phpunit/tests/l10n/loadScriptTextdomain.php

-              r61424
+              r62325
                 $this->assertSame( $expected, load_script_textdomain( $handle ) );
+        }
+        /**
+         * Tests that an unparseable script source URL short-circuits to
+         * `load_script_translations( false, ... )` instead of falling through
+         * to the relative-path computation.
+         *
+         * @ticket 65015
+         */
+        public function test_unparseable_src_returns_false(): void {
+                $handle = 'test-unparseable-src';
+                $src    = 'http:///example';
+                $this->assertFalse( wp_parse_url( $src ), 'Test prerequisite failed: the test src should be unparseable.' );
+                wp_enqueue_script( $handle, $src, array(), null );
+                $this->assertFalse( load_script_textdomain( $handle, 'default', DIR_TESTDATA . '/languages' ) );
+        }
+        /**
+         * Tests that an unparseable `content_url()` return value short-circuits
+         * to `load_script_translations( false, ... )` instead of computing
+         * `$relative` from a corrupted parsed-URL array.
+         *
+         * The `MockAction` spy on `pre_load_script_translations` is necessary
+         * here because the function's tail end also calls `load_script_translations( false, ... )`,
+         * so a regression that bypasses the early return would still return false
+         * via the fallback path. Asserting on the recorded `$file` arguments pins
+         * the test to the intended branch.
+         *
+         * @ticket 65015
+         */
+        public function test_unparseable_content_url_returns_false(): void {
+                $handle = 'test-unparseable-content-url';
+                $src    = '/wp-includes/js/script.js';
+                add_filter(
+                        'content_url',
+                        static function () {
+                                return 'http:///example';
+                        }
+                );
+                $mock = new MockAction();
+                add_filter( 'pre_load_script_translations', array( $mock, 'filter' ), 10, 4 );
+                wp_enqueue_script( $handle, $src, array(), null );
+                $this->assertFalse( load_script_textdomain( $handle, 'default', DIR_TESTDATA . '/languages' ) );
+                $this->assertSame(
+                        array(
+                                DIR_TESTDATA . '/languages/en_US-' . $handle . '.json',
+                                false,
+                        ),
+                        array_column( $mock->get_args(), 1 ),
+                        'Expected the unparseable content_url branch to short-circuit before any relative-path lookup.'
+                );
+        }
+        /**
+         * Tests that the `load_script_textdomain_relative_path` filter returning
+         * a non-string, non-false value (e.g., a callback that forgets to return)
+         * short-circuits via the `! is_string( $relative )` guard rather than
+         * falling through to string functions like `str_ends_with()` and `md5()`.
+         *
+         * @ticket 65015
+         */
+        public function test_non_string_relative_path_filter_returns_false(): void {
+                $handle = 'test-non-string-relative-path';
+                $src    = '/wp-includes/js/script.js';
+                add_filter( 'load_script_textdomain_relative_path', '__return_null' );
+                wp_enqueue_script( $handle, $src, array(), null );
+                $this->assertFalse( load_script_textdomain( $handle, 'default', DIR_TESTDATA . '/languages' ) );
+        }
+        /**
+         * Tests that a script source URL with no path component does not trigger
+         * an undefined index warning when the path is read further down in the
+         * function. The result is reached via the regular fallback path
+         * (no host/path match) rather than an early return.
+         *
+         * @ticket 65015
+         */
+        public function test_src_without_path_component_does_not_warn(): void {
+                $handle = 'test-src-without-path';
+                $src    = 'https://example.com';
+                $parsed = wp_parse_url( $src );
+                $this->assertIsArray( $parsed, 'Test prerequisite failed: the test src should parse.' );
+                $this->assertArrayNotHasKey( 'path', $parsed, 'Test prerequisite failed: the test src should have no path component.' );
+                wp_enqueue_script( $handle, $src, array(), null );
+                $this->assertFalse( load_script_textdomain( $handle, 'default', DIR_TESTDATA . '/languages' ) );
+        }
+}

Note: See TracChangeset for help on using the changeset viewer.

Make WordPress Core

Context Navigation

Changeset 62325 for branches/7.0/tests/phpunit/tests/l10n/loadScriptTextdomain.php

Legend:

branches/7.0

branches/7.0/tests/phpunit/tests/l10n/loadScriptTextdomain.php

Download in other formats: