Changeset 60930 for trunk/src/wp-includes/class-wp-script-modules.php

Timestamp:

10/14/2025 12:10:31 AM (4 months ago)

Author:

westonruter

Message:

Editor: Avoid enqueueing assets for blocks which do not render content.

This change prevents scripts, styles, and script modules from being enqueued for blocks that do not render any HTML content. This is common for hidden blocks or blocks like the Featured Image block when no image is present. This change reduces the amount of unused CSS and JavaScript on a page, improving performance.

A new filter, enqueue_empty_block_content_assets, is introduced to allow developers to override this behavior and enqueue assets for empty blocks if needed.

The implementation involves capturing the asset queues before and after a block is rendered. The newly enqueued assets are only merged if the block's rendered content is not empty. This is done recursively for nested blocks to ensure that assets for inner blocks are also not enqueued if a parent block is hidden.

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

Props westonruter, aristath, peterwilsoncc, gziolo, krupajnanda, dd32, jorbin.
See #50328.
Fixes #63676.

File:

• trunk/src/wp-includes/class-wp-script-modules.php (modified) (9 diffs)

trunk/src/wp-includes/class-wp-script-modules.php

@@ -24 +24 @@
 
     /**
-     * Holds the script module identifiers that were enqueued before registered.
-     *
-     * @since 6.5.0
-     * @var array<string, true>
-     */
-    private $enqueued_before_registered = array();
+     * An array of IDs for queued script modules.
+     *
+     * @since 6.9.0
+     * @var string[]
+     */
+    public $queue = array();
 
     /**
@@ -123 +123 @@
                 'src'           => $src,
                 'version'       => $version,
-                'enqueue'       => isset( $this->enqueued_before_registered[ $id ] ),
                 'dependencies'  => $dependencies,
                 'fetchpriority' => $fetchpriority,
@@ -214 +213 @@
      */
     public function enqueue( string $id, string $src = '', array $deps = array(), $version = false, array $args = array() ) {
-        if ( isset( $this->registered[ $id ] ) ) {
-            $this->registered[ $id ]['enqueue'] = true;
-        } elseif ( $src ) {
+        if ( ! in_array( $id, $this->queue, true ) ) {
+            $this->queue[] = $id;
+        }
+        if ( ! isset( $this->registered[ $id ] ) && $src ) {
             $this->register( $id, $src, $deps, $version, $args );
-            $this->registered[ $id ]['enqueue'] = true;
-        } else {
-            $this->enqueued_before_registered[ $id ] = true;
         }
     }
@@ -232 +229 @@
      */
     public function dequeue( string $id ) {
-        if ( isset( $this->registered[ $id ] ) ) {
-            $this->registered[ $id ]['enqueue'] = false;
-        }
-        unset( $this->enqueued_before_registered[ $id ] );
+        $this->queue = array_diff( $this->queue, array( $id ) );
     }
 
@@ -246 +240 @@
      */
     public function deregister( string $id ) {
+        $this->dequeue( $id );
         unset( $this->registered[ $id ] );
-        unset( $this->enqueued_before_registered[ $id ] );
     }
 
@@ -305 +299 @@
      */
     public function print_script_module_preloads() {
-        foreach ( $this->get_dependencies( array_keys( $this->get_marked_for_enqueue() ), array( 'static' ) ) as $id => $script_module ) {
+        foreach ( $this->get_dependencies( array_unique( $this->queue ), array( 'static' ) ) as $id => $script_module ) {
             // Don't preload if it's marked for enqueue.
-            if ( true !== $script_module['enqueue'] ) {
+            if ( ! in_array( $id, $this->queue, true ) ) {
                 echo sprintf(
                     '<link rel="modulepreload" href="%s" id="%s"%s>',
@@ -346 +340 @@
     private function get_import_map(): array {
         $imports = array();
-        foreach ( $this->get_dependencies( array_keys( $this->get_marked_for_enqueue() ) ) as $id => $script_module ) {
+        foreach ( $this->get_dependencies( array_unique( $this->queue ) ) as $id => $script_module ) {
             $imports[ $id ] = $this->get_src( $id );
         }
@@ -360 +354 @@
      */
     private function get_marked_for_enqueue(): array {
-        $enqueued = array();
-        foreach ( $this->registered as $id => $script_module ) {
-            if ( true === $script_module['enqueue'] ) {
-                $enqueued[ $id ] = $script_module;
-            }
-        }
-        return $enqueued;
+        return wp_array_slice_assoc(
+            $this->registered,
+            $this->queue
+        );
     }
 
@@ -458 +449 @@
     public function print_script_module_data(): void {
         $modules = array();
-        foreach ( array_keys( $this->get_marked_for_enqueue() ) as $id ) {
+        foreach ( array_unique( $this->queue ) as $id ) {
             if ( '@wordpress/a11y' === $id ) {
                 $this->a11y_available = true;