Changeset 57593 for trunk/tests/phpunit/tests/script-modules/wpScriptModules.php

Timestamp:

02/12/2024 12:58:53 PM (14 months ago)

Author:

gziolo

Message:

Script Modules API: Add deregister module function

It was impossible to deregister a script module. It is changing to avoid problems for extenders that want to override any Core script module.

Fixes #60463.
Props cbravobernal, gziolo, mukesh27, youknowriad.

File:

• trunk/tests/phpunit/tests/script-modules/wpScriptModules.php (modified) (1 diff)

trunk/tests/phpunit/tests/script-modules/wpScriptModules.php

@@ -127 +127 @@
     }
 
+
+    /**
+     * Tests that a script module can be deregistered
+     * after being enqueued, and that will be removed
+     * from the enqueue list too.
+     *
+     * @ticket 60463
+     *
+     * @covers ::register()
+     * @covers ::enqueue()
+     * @covers ::deregister()
+     * @covers ::get_enqueued_script_modules()
+     */
+    public function test_wp_deregister_script_module() {
+        $this->script_modules->register( 'foo', '/foo.js' );
+        $this->script_modules->register( 'bar', '/bar.js' );
+        $this->script_modules->enqueue( 'foo' );
+        $this->script_modules->enqueue( 'bar' );
+        $this->script_modules->deregister( 'foo' ); // Dequeued.
+
+        $enqueued_script_modules = $this->get_enqueued_script_modules();
+
+        $this->assertCount( 1, $enqueued_script_modules );
+        $this->assertFalse( isset( $enqueued_script_modules['foo'] ) );
+        $this->assertTrue( isset( $enqueued_script_modules['bar'] ) );
+    }
+
+    /**
+     * Tests that a script module is not deregistered
+     * if it has not been registered before, causing
+     * no errors.
+     *
+     * @ticket 60463
+     *
+     * @covers ::deregister()
+     * @covers ::get_enqueued_script_modules()
+     */
+    public function test_wp_deregister_unexistent_script_module() {
+        $this->script_modules->deregister( 'unexistent' );
+        $enqueued_script_modules = $this->get_enqueued_script_modules();
+
+        $this->assertCount( 0, $enqueued_script_modules );
+        $this->assertFalse( isset( $enqueued_script_modules['unexistent'] ) );
+    }
+
+    /**
+     * Tests that a script module is not deregistered
+     * if it has been deregistered previously, causing
+     * no errors.
+     *
+     * @ticket 60463
+     *
+     * @covers ::get_enqueued_script_modules()
+     * @covers ::register()
+     * @covers ::deregister()
+     * @covers ::enqueue()
+     */
+    public function test_wp_deregister_already_deregistered_script_module() {
+        $this->script_modules->register( 'foo', '/foo.js' );
+        $this->script_modules->enqueue( 'foo' );
+        $this->script_modules->deregister( 'foo' ); // Dequeued.
+        $enqueued_script_modules = $this->get_enqueued_script_modules();
+
+        $this->assertCount( 0, $enqueued_script_modules );
+        $this->assertFalse( isset( $enqueued_script_modules['foo'] ) );
+
+        $this->script_modules->deregister( 'foo' ); // Dequeued.
+        $enqueued_script_modules = $this->get_enqueued_script_modules();
+
+        $this->assertCount( 0, $enqueued_script_modules );
+        $this->assertFalse( isset( $enqueued_script_modules['foo'] ) );
+    }
+
     /**
     * Tests that a script module can be enqueued before it is registered, and will