Changeset 52338

Timestamp:

12/07/2021 05:44:46 PM (3 years ago)

Author:

audrasjb

Message:

Script Loader: Allow for wp_register_script() to be called after wp_enqueue_script().

When a plugin registers styles/scripts on wp_enqueue_scripts (as plugin authors are encouraged to do), and conditionally enqueues their script/style on the_content filter, things "just work". In block themes, the_content is run prior to the header being processed, which results in the above scenario failing.

This change makes a wp_enqueue_script( 'example' ); wp_register_script( 'example' ); work, where as currently the enqueue silently fails (no "doing it wrong" message) and the following register has no impact. Scripts can therefore be enqueued and dequeued (by "handle") before they are registered.

Fixes #54529.

Location:

trunk

Files:

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

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

@@ -94 +94 @@
      */
     private $all_queued_deps;
+
+    /**
+     * List of assets enqueued before details were registered.
+     *
+     * @since 5.9.0
+     *
+     * @var array
+     */
+    private $queued_before_register = array();
 
     /**
@@ -249 +258 @@
         }
         $this->registered[ $handle ] = new _WP_Dependency( $handle, $src, $deps, $ver, $args );
+
+        // If the item was enqueued before the details were registered, enqueue it now.
+        if ( array_key_exists( $handle, $this->queued_before_register ) ) {
+            if ( ! is_null( $this->queued_before_register[ $handle ] ) ) {
+                $this->enqueue( $handle . '?' . $this->queued_before_register[ $handle ] );
+            } else {
+                $this->enqueue( $handle );
+            }
+
+            unset( $this->queued_before_register[ $handle ] );
+        }
+
         return true;
     }
@@ -335 +356 @@
                     $this->args[ $handle[0] ] = $handle[1];
                 }
+            } else if ( ! isset( $this->registered[ $handle[0] ] ) ) {
+                $this->queued_before_register[ $handle[0] ] = null; // $args
+
+                if ( isset( $handle[1] ) ) {
+                    $this->queued_before_register[ $handle[0] ] = $handle[1];
+                }
             }
         }
@@ -361 +388 @@
                 unset( $this->queue[ $key ] );
                 unset( $this->args[ $handle[0] ] );
+            } else if ( array_key_exists( $handle[0], $this->queued_before_register ) ) {
+                unset( $this->queued_before_register[ $handle[0] ] );
             }
         }

trunk/tests/phpunit/tests/dependencies.php

@@ -137 +137 @@
 
     }
+
+    function test_enqueue_before_register() {
+        $dep = new WP_Dependencies;
+
+        $this->assertArrayNotHasKey( 'one', $dep->registered );
+
+        $dep->enqueue( 'one' );
+
+        $this->assertNotContains( 'one', $dep->queue );
+
+        $this->assertTrue( $dep->add( 'one', '' ) );
+
+        $this->assertContains( 'one', $dep->queue );
+    }
 }