Changeset 53367

Timestamp:

05/09/2022 12:01:48 AM (2 years ago)

Author:

peterwilsoncc

Message:

Script Loader: Fix i18n edge case breaking dependencies.

Prevent concatenation of scripts if the text domain is defined to ensure the dependency order is respected.

This accounts for an edge case in which replacing a core script via a plugin and a lack of translations (eg, for a US English site) could cause the JavaScript files to be ordered incorrectly.

Follow up to [52937].

Props audrasjb, boniu91, chaion07, costdev, hellofromtonya, jsnajdr, mukesh27, ndiego, ugyensupport, SergeyBiryukov.
Merges [53360,53366] to the 6.0 branch.
Fixes #55628.

Location:

branches/6.0

Files:

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

branches/6.0/src/wp-includes/class.wp-scripts.php

@@ -311 +311 @@
             $inline_script_tag = '';
         }
+
+        /*
+         * Prevent concatenation of scripts if the text domain is defined
+         * to ensure the dependency order is respected.
+         */
+        $translations_stop_concat = ! empty( $obj->textdomain );
 
         $translations = $this->print_translations( $handle, false );
@@ -328 +334 @@
             $srce = apply_filters( 'script_loader_src', $src, $handle );
 
-            if ( $this->in_default_dir( $srce ) && ( $before_handle || $after_handle || $translations ) ) {
+            if ( $this->in_default_dir( $srce ) && ( $before_handle || $after_handle || $translations_stop_concat ) ) {
                 $this->do_concat = false;
 

branches/6.0/tests/phpunit/tests/dependencies/scripts.php

@@ -1482 +1482 @@
         );
     }
+
+    /**
+     * @ticket 55628
+     * @covers ::wp_set_script_translations
+     */
+    public function test_wp_external_wp_i18n_print_order() {
+        global $wp_scripts;
+
+        $wp_scripts->do_concat    = true;
+        $wp_scripts->default_dirs = array( '/default/' );
+
+        // wp-i18n script in a non-default directory.
+        wp_register_script( 'wp-i18n', '/plugins/wp-i18n.js', array(), null );
+        // Script in default dir that's going to be concatenated.
+        wp_enqueue_script( 'jquery-core', '/default/jquery-core.js', array(), null );
+        // Script in default dir that depends on wp-i18n.
+        wp_enqueue_script( 'common', '/default/common.js', array(), null );
+        wp_set_script_translations( 'common' );
+
+        $print_scripts = get_echo(
+            function() {
+                wp_print_scripts();
+                _print_scripts();
+            }
+        );
+
+        // The non-default script should end concatenation and maintain order.
+        $ver       = get_bloginfo( 'version' );
+        $expected  = "<script type='text/javascript' src='/wp-admin/load-scripts.php?c=0&amp;load%5Bchunk_0%5D=jquery-core&amp;ver={$ver}'></script>\n";
+        $expected .= "<script type='text/javascript' src='/plugins/wp-i18n.js' id='wp-i18n-js'></script>\n";
+        $expected .= "<script type='text/javascript' src='/default/common.js' id='common-js'></script>\n";
+
+        $this->assertSame( $expected, $print_scripts );
+    }
 }