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

Interactivity API: Use Script Modules data filter #6683

Conversation

sirreal
Copy link
Member

@sirreal sirreal commented May 30, 2024

https://core.trac.wordpress.org/changeset/58579 introduced an API for passing data to Script Modules similar to what Interactivity API does.

Instead of its own implementation, change the Interactivity API to use the Core API via the script_module_data_{$module_id} filter.

Todo:

This will not work until client scripts are updated. The @wordpress/interactivity Script Module was updated in WordPress/gutenberg#61658 to try to get client data from an updated element ID. This requires @wordpress/interactivity@>5.7.0.

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


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

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.

@sirreal sirreal force-pushed the update/use-scriptmoduledata-for-interactivity-api branch from c07dd24 to f57725f Compare June 26, 2024 14:26
@sirreal sirreal marked this pull request as ready for review June 26, 2024 20:22
Copy link

github-actions bot commented Jun 26, 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 jonsurrell, gziolo, luisherranz, cbravobernal.

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

@sirreal sirreal requested a review from gziolo June 26, 2024 20:22
@sirreal
Copy link
Member Author

sirreal commented Jun 26, 2024

@luisherranz @cbravobernal @DAreRodz I'd love to get an Interactivity API review of this 🙏

Copy link
Member

@luisherranz luisherranz left a comment

Choose a reason for hiding this comment

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

Looks good to me 🙂

Good trick to update the JS handle beforehand 😄

Use the "script_module_data_@wordpress/interactivity" filter to pass
Script Module data to the Interactivity API client.
@sirreal sirreal force-pushed the update/use-scriptmoduledata-for-interactivity-api branch from 41388bf to d51b1ce Compare July 4, 2024 16:29
Copy link
Contributor

@cbravobernal cbravobernal left a comment

Choose a reason for hiding this comment

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

LGTM.

@sirreal
Copy link
Member Author

sirreal commented Jul 15, 2024

Suggested commit message:

Interactivity API: Use Script Modules filter for store and config data

A dedicated API exists for passing data to Script Modules implemented in
changeset [58579]. Use this Core API instead of a custom implementation
for Interactivity API to pass data to the client.

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

Props jonsurrell, gziolo, luisherranz, cbravobernal.
Fixes #61512.

pento pushed a commit that referenced this pull request Jul 16, 2024
A dedicated API exists for passing data to Script Modules implemented in changeset [58579].
Use this Core API instead of a custom implementation for Interactivity API to pass data to the client.

Developed in #6683.

Props jonsurrell, gziolo, luisherranz, cbravobernal.
Fixes #61512.

git-svn-id: https://develop.svn.wordpress.org/trunk@58729 602fd350-edb4-49c9-b593-d223f7449a82
@ockham
Copy link
Contributor

ockham commented Jul 16, 2024

Committed to Core in https://core.trac.wordpress.org/changeset/58729.

@ockham ockham closed this Jul 16, 2024
@gziolo gziolo deleted the update/use-scriptmoduledata-for-interactivity-api branch July 16, 2024 09:44
markjaquith pushed a commit to WordPress/WordPress that referenced this pull request Jul 16, 2024
A dedicated API exists for passing data to Script Modules implemented in changeset [58579].
Use this Core API instead of a custom implementation for Interactivity API to pass data to the client.

Developed in WordPress/wordpress-develop#6683.

Props jonsurrell, gziolo, luisherranz, cbravobernal.
Fixes #61512.
Built from https://develop.svn.wordpress.org/trunk@58729


git-svn-id: http://core.svn.wordpress.org/trunk@58131 1a063a9b-81f0-0310-95a4-ce76da25c4cd
github-actions bot pushed a commit to gilzow/wordpress-performance that referenced this pull request Jul 16, 2024
A dedicated API exists for passing data to Script Modules implemented in changeset [58579].
Use this Core API instead of a custom implementation for Interactivity API to pass data to the client.

Developed in WordPress/wordpress-develop#6683.

Props jonsurrell, gziolo, luisherranz, cbravobernal.
Fixes #61512.
Built from https://develop.svn.wordpress.org/trunk@58729


git-svn-id: https://core.svn.wordpress.org/trunk@58131 1a063a9b-81f0-0310-95a4-ce76da25c4cd
Debarghya-Banerjee pushed a commit to Debarghya-Banerjee/wordpress-develop that referenced this pull request Jul 18, 2024
A dedicated API exists for passing data to Script Modules implemented in changeset [58579].
Use this Core API instead of a custom implementation for Interactivity API to pass data to the client.

Developed in WordPress#6683.

Props jonsurrell, gziolo, luisherranz, cbravobernal.
Fixes #61512.

git-svn-id: https://develop.svn.wordpress.org/trunk@58729 602fd350-edb4-49c9-b593-d223f7449a82
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants