Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Script Modules API: Add deregister module function #6061

Conversation

cbravobernal
Copy link

Trac ticket: https://core.trac.wordpress.org/ticket/60463

Right now is impossible to deregister a script module. This can cause problems for extenders that want to override any Core script module.

It will eventually happen in Gutenberg once 6.5 is out. We already had dequeue, but also, being consistent with script_register, style_register, there should be a script_module_register.


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

Copy link

github-actions bot commented Feb 7, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props cbravobernal, gziolo, mukesh27, youknowriad.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link

github-actions bot commented Feb 8, 2024

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Copy link
Member

@gziolo gziolo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would be in favor for offering a way for extenders to remove a registered script module. It’s a well established pattern for scripts, styles, and many other registries in WordPress that offer a flexible way to change the default experience.

Thank you for starting the discussion!

src/wp-includes/class-wp-script-modules.php Outdated Show resolved Hide resolved
src/wp-includes/class-wp-script-modules.php Outdated Show resolved Hide resolved
*
* @param string $id The identifier of the script module.
*/
public function deregister( string $id ) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it "unregister" or "deregister"? It seems on Core, we use "unregister" everywhere except for WP_Scripts and Styles. It seems a bit awkward.

I understand the reasoning about modules being scripts to keep them consistent but wanted to mention.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, that's unfortunate. It's probably better to keep it awkward but similar to scripts. I don't have strong opinion here though 😅

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's even more interesting:

function wp_deregister_script( $handle ) {

but:

wp_scripts()->remove( $handle );

@gziolo
Copy link
Member

gziolo commented Feb 12, 2024

Committed with https://core.trac.wordpress.org/changeset/57593. I'm still open to changing the function or method names.

@gziolo gziolo closed this Feb 12, 2024
@cbravobernal
Copy link
Author

Committed with https://core.trac.wordpress.org/changeset/57593. I'm still open to changing the function or method names.

If we want to keep consistency with scripts and styles, we need to rename all $id with $handle and deregister() with remove()

@gziolo
Copy link
Member

gziolo commented Feb 12, 2024

If we want to keep consistency with scripts and styles, we need to rename all $id with $handle and deregister() with remove()

Let's continue the discussion on WordPress Trac. Commented https://core.trac.wordpress.org/ticket/56313#comment:79.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants