Modules API: Script Modules add deregister option. (#58830)

* Add deregister module function * Sync with core PR
WordPress · Feb 19, 2024 · b0aa007 · b0aa007 · github-actions · Feb 19, 2024
1 parent ac64d16
commit b0aa007
Show file tree

Hide file tree

Showing 5 changed files with 58 additions and 23 deletions.
diff --git a/lib/compat/wordpress-6.5/class-wp-script-modules.php b/lib/compat/wordpress-6.5/class-wp-script-modules.php
@@ -152,6 +152,18 @@ public function dequeue( string $id ) {
 			unset( $this->enqueued_before_registered[ $id ] );
 		}
 
+		/**
+		 * Removes a registered script module.
+		 *
+		 * @since 6.5.0
+		 *
+		 * @param string $id The identifier of the script module.
+		 */
+		public function deregister( string $id ) {
+			unset( $this->registered[ $id ] );
+			unset( $this->enqueued_before_registered[ $id ] );
+		}
+
 		/**
 		 * Adds the hooks to print the import map, enqueued script modules and script
 		 * module preloads.

diff --git a/lib/compat/wordpress-6.5/scripts-modules.php b/lib/compat/wordpress-6.5/scripts-modules.php
@@ -207,3 +207,16 @@ function wp_dequeue_script_module( string $id ) {
 		wp_script_modules()->dequeue( $id );
 	}
 }
+
+if ( ! function_exists( 'wp_deregister_script_module' ) ) {
+	/**
+	 * Deregisters the script module.
+	 *
+	 * @since 6.5.0
+	 *
+	 * @param string $id The identifier of the script module.
+	 */
+	function wp_deregister_script_module( string $id ) {
+		wp_script_modules()->deregister( $id );
+	}
+}
diff --git a/lib/experimental/interactivity-api.php b/lib/experimental/interactivity-api.php
diff --git a/lib/interactivity-api.php b/lib/interactivity-api.php
@@ -0,0 +1,32 @@
+<?php
+/**
+ * Interactivity API functions specific for the Gutenberg editor plugin.
+ *
+ * @package gutenberg
+ */
+
+/**
+ * Deregisters the Core Interactivity API Modules and replace them
+ * with the ones from the Gutenberg plugin.
+ */
+function gutenberg_reregister_interactivity_script_modules() {
+	$default_version = defined( 'GUTENBERG_VERSION' ) && ! SCRIPT_DEBUG ? GUTENBERG_VERSION : time();
+	wp_deregister_script_module( '@wordpress/interactivity' );
+	wp_deregister_script_module( '@wordpress/interactivity-router' );
+
+	wp_register_script_module(
+		'@wordpress/interactivity',
+		gutenberg_url( '/build/interactivity/index.min.js' ),
+		array(),
+		$default_version
+	);
+
+	wp_register_script_module(
+		'@wordpress/interactivity-router',
+		gutenberg_url( '/build/interactivity/router.min.js' ),
+		array( '@wordpress/interactivity' ),
+		$default_version
+	);
+}
+
+add_action( 'init', 'gutenberg_reregister_interactivity_script_modules' );
diff --git a/lib/load.php b/lib/load.php
@@ -133,7 +133,6 @@ function gutenberg_is_experiment_enabled( $name ) {
 require __DIR__ . '/experimental/l10n.php';
 require __DIR__ . '/experimental/synchronization.php';
 require __DIR__ . '/experimental/script-modules.php';
-require __DIR__ . '/experimental/interactivity-api.php';
 
 if ( gutenberg_is_experiment_enabled( 'gutenberg-no-tinymce' ) ) {
 	require __DIR__ . '/experimental/disable-tinymce.php';
@@ -192,6 +191,7 @@ function gutenberg_is_experiment_enabled( $name ) {
 require __DIR__ . '/client-assets.php';
 require __DIR__ . '/demo.php';
 require __DIR__ . '/experiments-page.php';
+require __DIR__ . '/interactivity-api.php';
 
 // Copied package PHP files.
 if ( is_dir( __DIR__ . '/../build/style-engine' ) ) {