Changeset 64320

Timestamp:

10/13/2026 04:12:29 AM (6 days ago)

Author:

westonruter

Message:

Script Loader: Disable script/style concatenation by default.

Scripts and styles in the admin and on the login screen are no longer concatenated by default. When the CONCATENATE_SCRIPTS constant is not defined, wp_should_concatenate_admin_scripts() now returns false, so load-scripts.php and load-styles.php are only used when a site opts in with define( 'CONCATENATE_SCRIPTS', true ). This is the next step toward retiring concatenation. It also puts into effect the prefetching of the admin's assets added in r64120, which only applies when concatenation is off. With an empty browser cache, logging in and then opening the Dashboard, the Posts list and the block editor was measured to be faster this way than with concatenation on.

TinyMCE is now always registered as two separate files instead of the prebuilt wp-tinymce.js bundle: TinyMCE core and the compat3x plugin. The bundle was registered only when scripts were both concatenated and compressed, and since r43580 and r44651 the $compress_scripts global has not compressed anything, so the registration no longer depends on either. The block editor loads TinyMCE on every screen but initializes it only when a Classic block is edited, so it now downloads 369 KB for the two files instead of 671 KB for the bundle, which also holds the theme and all 22 plugins. When TinyMCE is initialized, in the classic editor or for a Classic block, it now requests them itself and takes longer to become ready, a cost deemed acceptable since the role TinyMCE is increasingly diminished. A site can still register the bundle under the wp-tinymce handle. The unused second parameter of wp_register_tinymce_scripts() is deprecated.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/13090.
Follow-up to r43580, r44114, r44651, r64120.

Props adnan007, westonruter.
See #57548, #66053.

Location:

trunk

Files:

• src/wp-includes/class-wp-editor.php (modified) (1 diff)
• src/wp-includes/script-loader.php (modified) (5 diffs)
• tests/phpunit/tests/dependencies/scripts.php (modified) (5 diffs)
• tests/phpunit/tests/dependencies/wpShouldConcatenateAdminScripts.php (modified) (3 diffs)

trunk/src/wp-includes/class-wp-editor.php

@@ -1542 +1542 @@
 
                 $wp_scripts->remove( 'wp-tinymce' );
-                wp_register_tinymce_scripts( $wp_scripts, true );
+                wp_register_tinymce_scripts( $wp_scripts );
         }
 

trunk/src/wp-includes/script-loader.php

@@ -5 +5 @@
  * Several constants are used to manage the loading, concatenating and compression of scripts and CSS:
  * define('SCRIPT_DEBUG', true); loads the development (non-minified) versions of all scripts and CSS, and disables compression and concatenation,
- * define('CONCATENATE_SCRIPTS', false); disables compression and concatenation of scripts and CSS,
+ * define('CONCATENATE_SCRIPTS', true); enables concatenation of scripts and CSS in the admin and on the login screen (disabled by default),
  * define('COMPRESS_SCRIPTS', false); disables compression of scripts,
  * define('COMPRESS_CSS', false); disables compression of CSS,
@@ -38 +38 @@
  * Registers TinyMCE scripts.
  *
+ * TinyMCE core and the compat3x plugin are registered as separate files. TinyMCE loads its theme
+ * and any other plugins itself when an editor is initialized. The `wp-tinymce.js` bundle of all of
+ * them is no longer registered, but it can still be registered in their place under the
+ * `wp-tinymce` handle.
+ *
  * @since 5.0.0
+ * @since 7.2.0 The `wp-tinymce.js` bundle is no longer registered, regardless of whether scripts
+ *              are concatenated or compressed.
+ * @since 7.2.0 The `$force_uncompressed` parameter was deprecated and renamed to `$deprecated`.
  *
  * @global string $tinymce_version
- * @global bool   $concatenate_scripts
- * @global bool   $compress_scripts
- *
- * @param WP_Scripts $scripts            WP_Scripts object.
- * @param bool       $force_uncompressed Whether to forcibly prevent gzip compression. Default false.
- */
-function wp_register_tinymce_scripts( $scripts, $force_uncompressed = false ) {
-        global $tinymce_version, $concatenate_scripts, $compress_scripts;
+ *
+ * @param WP_Scripts $scripts    WP_Scripts object.
+ * @param bool       $deprecated Not used.
+ *
+ * @phpstan-param false $deprecated
+ */
+function wp_register_tinymce_scripts( $scripts, $deprecated = false ): void {
+        global $tinymce_version;
+
+        if ( false !== $deprecated ) {
+                _deprecated_argument( __FUNCTION__, '7.2.0' );
+        }
 
         $suffix     = wp_scripts_get_suffix();
         $dev_suffix = wp_scripts_get_suffix( 'dev' );
 
+        /*
+         * This no longer depends on the concatenation settings, but it is where an admin screen has
+         * settled them until now, which the 'wp_should_concatenate_admin_scripts' filter documents.
+         */
         script_concat_settings();
 
-        $compressed = $compress_scripts && $concatenate_scripts && ! $force_uncompressed;
-
-        /*
-         * Load tinymce.js when running from /src, otherwise load wp-tinymce.js (in production)
-         * or tinymce.min.js (when SCRIPT_DEBUG is true).
-         */
-        if ( $compressed ) {
-                $scripts->add( 'wp-tinymce', includes_url( 'js/tinymce/' ) . 'wp-tinymce.js', array(), $tinymce_version );
-        } else {
-                $scripts->add( 'wp-tinymce-root', includes_url( 'js/tinymce/' ) . "tinymce$dev_suffix.js", array(), $tinymce_version );
-                $scripts->add( 'wp-tinymce', includes_url( 'js/tinymce/' ) . "plugins/compat3x/plugin$dev_suffix.js", array( 'wp-tinymce-root' ), $tinymce_version );
-        }
+        // Load tinymce.js when running from /src, otherwise tinymce.min.js.
+        $scripts->add( 'wp-tinymce-root', includes_url( 'js/tinymce/' ) . "tinymce$dev_suffix.js", array(), $tinymce_version );
+        $scripts->add( 'wp-tinymce', includes_url( 'js/tinymce/' ) . "plugins/compat3x/plugin$dev_suffix.js", array( 'wp-tinymce-root' ), $tinymce_version );
 
         $scripts->add( 'wp-tinymce-lists', includes_url( "js/tinymce/plugins/lists/plugin$suffix.js" ), array( 'wp-tinymce' ), $tinymce_version );
@@ -2499 +2506 @@
  * Determines whether scripts and styles are concatenated on admin screens and the login screen.
  *
- * Concatenation is on unless the `CONCATENATE_SCRIPTS` constant turns it off, and `SCRIPT_DEBUG`
+ * Concatenation is off unless the `CONCATENATE_SCRIPTS` constant turns it on, and `SCRIPT_DEBUG`
  * turns it off regardless. Scripts and styles are never concatenated elsewhere.
  *
@@ -2516 +2523 @@
  */
 function wp_should_concatenate_admin_scripts(): bool {
-        $concatenate = ( defined( 'CONCATENATE_SCRIPTS' ) ? (bool) CONCATENATE_SCRIPTS : true )
+        $concatenate = ( defined( 'CONCATENATE_SCRIPTS' ) ? (bool) CONCATENATE_SCRIPTS : false )
                 && ! ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG );
 
@@ -2533 +2540 @@
          * @since 7.2.0
          *
-         * @param bool $concatenate Whether scripts and styles are concatenated. Default true, unless the
-         *                          `CONCATENATE_SCRIPTS` constant is false or `SCRIPT_DEBUG` is true.
+         * @param bool $concatenate Whether scripts and styles are concatenated. Default false, unless the
+         *                          `CONCATENATE_SCRIPTS` constant is true and `SCRIPT_DEBUG` is not.
          */
         return (bool) apply_filters( 'wp_should_concatenate_admin_scripts', $concatenate );

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

@@ -37 +37 @@
 
         /**
+         * @var mixed
+         */
+        protected $old_compress_scripts;
+
+        /**
          * @var WP_Styles
          */
@@ -55 +60 @@
                 $this->old_wp_styles           = $GLOBALS['wp_styles'] ?? null;
                 $this->old_concatenate_scripts = $GLOBALS['concatenate_scripts'] ?? null;
+                $this->old_compress_scripts    = $GLOBALS['compress_scripts'] ?? null;
                 remove_action( 'wp_default_scripts', 'wp_default_scripts' );
                 remove_action( 'wp_default_scripts', 'wp_default_packages' );
@@ -78 +84 @@
                 $GLOBALS['wp_styles']           = $this->old_wp_styles;
                 $GLOBALS['concatenate_scripts'] = $this->old_concatenate_scripts;
+                $GLOBALS['compress_scripts']    = $this->old_compress_scripts;
                 add_action( 'wp_default_scripts', 'wp_default_scripts' );
                 parent::tear_down();
@@ -3831 +3838 @@
          */
         public function test_printing_tinymce_scripts() {
-                global $wp_scripts;
-
-                wp_register_tinymce_scripts( $wp_scripts, true );
+                wp_register_tinymce_scripts( wp_scripts() );
 
                 $actual = get_echo( 'wp_print_scripts', array( array( 'wp-tinymce' ) ) );
@@ -3839 +3844 @@
                 $this->assertStringNotContainsString( 'async', $actual, 'TinyMCE should not have an async attribute.' );
                 $this->assertStringNotContainsString( 'defer', $actual, 'TinyMCE should not have a defer attribute.' );
+        }
+
+        /**
+         * Tests that TinyMCE is registered as separate files, never as the `wp-tinymce.js` bundle.
+         *
+         * @ticket 57548
+         *
+         * @covers ::wp_register_tinymce_scripts
+         *
+         * @dataProvider data_register_tinymce_scripts_unbundled
+         *
+         * @param bool $concatenate Value of the `$concatenate_scripts` global.
+         * @param bool $compress    Value of the `$compress_scripts` global.
+         */
+        public function test_register_tinymce_scripts_unbundled( bool $concatenate, bool $compress ): void {
+                global $concatenate_scripts, $compress_scripts;
+
+                $concatenate_scripts = $concatenate;
+                $compress_scripts    = $compress;
+
+                $wp_scripts = wp_scripts();
+                wp_register_tinymce_scripts( $wp_scripts );
+
+                $root = $wp_scripts->query( 'wp-tinymce-root' );
+                $this->assertInstanceOf( _WP_Dependency::class, $root, 'Expected TinyMCE core to be registered.' );
+                $this->assertIsString( $root->src );
+                $this->assertMatchesRegularExpression( '#/js/tinymce/tinymce(\.min)?\.js$#', $root->src );
+
+                $tinymce = $wp_scripts->query( 'wp-tinymce' );
+                $this->assertInstanceOf( _WP_Dependency::class, $tinymce, 'Expected the wp-tinymce handle to be registered.' );
+                $this->assertIsString( $tinymce->src );
+                $this->assertMatchesRegularExpression( '#/js/tinymce/plugins/compat3x/plugin(\.min)?\.js$#', $tinymce->src );
+                $this->assertSame( array( 'wp-tinymce-root' ), $tinymce->deps );
+        }
+
+        /**
+         * Data provider for test_register_tinymce_scripts_unbundled().
+         *
+         * @return array<non-falsy-string, array{ concatenate: bool, compress: bool }>
+         */
+        public function data_register_tinymce_scripts_unbundled(): array {
+                return array(
+                        'concatenated and compressed' => array(
+                                'concatenate' => true,
+                                'compress'    => true,
+                        ),
+                        'concatenated only'           => array(
+                                'concatenate' => true,
+                                'compress'    => false,
+                        ),
+                        'compressed only'             => array(
+                                'concatenate' => false,
+                                'compress'    => true,
+                        ),
+                        'neither'                     => array(
+                                'concatenate' => false,
+                                'compress'    => false,
+                        ),
+                );
         }
 

trunk/tests/phpunit/tests/dependencies/wpShouldConcatenateAdminScripts.php

@@ -75 +75 @@
 
         /**
-         * Tests the default when `CONCATENATE_SCRIPTS` is not defined, which is to concatenate unless
-         * `SCRIPT_DEBUG` is on.
+         * Tests the default when `CONCATENATE_SCRIPTS` is not defined, which is not to concatenate.
          *
          * @ticket 57548
@@ -85 +84 @@
                 }
 
-                $this->assertSame( ! SCRIPT_DEBUG, wp_should_concatenate_admin_scripts() );
+                $this->assertFalse( wp_should_concatenate_admin_scripts() );
         }
 
@@ -97 +96 @@
                 add_filter( 'wp_should_concatenate_admin_scripts', array( $filter, 'filter' ) );
 
-                $this->assertSame( ! SCRIPT_DEBUG && ( ! defined( 'CONCATENATE_SCRIPTS' ) || CONCATENATE_SCRIPTS ), wp_should_concatenate_admin_scripts() );
+                $this->assertSame( ! SCRIPT_DEBUG && defined( 'CONCATENATE_SCRIPTS' ) && CONCATENATE_SCRIPTS, wp_should_concatenate_admin_scripts() );
                 $this->assertSame( 1, $filter->get_call_count() );