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

Editor: Make asset registration .asset.php optional for blocks #5799

Conversation

josephfusco
Copy link

@josephfusco josephfusco commented Dec 19, 2023

It is a hard requirement that a *.asset.php file is present to register a block in WordPress. Otherwise, it throws a Warning:

function register_block_script_handle was called incorrectly. The asset file (/wp-content/uploads/faustwp/blocks/block-a/index.asset.php) for the "editorScript" defined in "create-block/block-a" block definition is missing. (This message was added in version 5.5.0.)

and the block will not appear in the inserter.

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

Gutenberg issue: WordPress/gutenberg#57234


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.

Copy link

Hi @josephfusco! 👋

Thank you for your contribution to WordPress! 💖

It looks like this is your first pull request to wordpress-develop. Here are a few things to be aware of that may help you out!

No one monitors this repository for new pull requests. Pull requests must be attached to a Trac ticket to be considered for inclusion in WordPress Core. To attach a pull request to a Trac ticket, please include the ticket's full URL in your pull request description.

Pull requests are never merged on GitHub. The WordPress codebase continues to be managed through the SVN repository that this GitHub repository mirrors. Please feel free to open pull requests to work on any contribution you are making.

More information about how GitHub pull requests can be used to contribute to WordPress can be found in this blog post.

Please include automated tests. Including tests in your pull request is one way to help your patch be considered faster. To learn about WordPress' test suites, visit the Automated Testing page in the handbook.

If you have not had a chance, please review the Contribute with Code page in the WordPress Core Handbook.

The Developer Hub also documents the various coding standards that are followed:

Thank you,
The WordPress Project

@gziolo
Copy link
Member

gziolo commented Jan 3, 2024

Resharing my WordPress/gutenberg#57234 (comment) from the issue in the Gutenberg repository. I propose that we remove the handling for the missing asset file and provide the default values instead. To land this patch, the required changes would be removing the proposed filter, and the _doing_it_wrong handling. It would be great to add a unit test that covers the case when there is no asset file provided.

@josephfusco josephfusco force-pushed the asset.php-unnecessary-doing-it-wrong branch from 0fa43f5 to 837931e Compare January 4, 2024 21:34
Signed-off-by: Joe Fusco <[email protected]>
Signed-off-by: Joe Fusco <[email protected]>
Signed-off-by: Joe Fusco <[email protected]>
@colorful-tones
Copy link
Member

It looks like unit tests are failing. I do not have the knowledge to fix or write 'em. Would it be necessary for merging, and could we have a separate follow-up PR to address the tests @gziolo ?

@colorful-tones
Copy link
Member

Also, would it be easier to move this patch to be against the Gutenberg repo?

@josephfusco
Copy link
Author

A lot of the failing tests were fixed with 5c67d33, however there are still a few tests failing but seem unrelated.

Also, would it be easier to move this patch to be against the Gutenberg repo?

If the code for register_block_script_handle is sourced from outside of wordpress-develop, I'm happy to move this patch there.

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.

Thank you for iterations. All changes need to get applied in WordPress core.

src/wp-includes/blocks.php Outdated Show resolved Hide resolved
tests/phpunit/tests/blocks/register.php Show resolved Hide resolved
tests/phpunit/tests/blocks/register.php Outdated Show resolved Hide resolved
src/wp-includes/blocks.php Outdated Show resolved Hide resolved
src/wp-includes/blocks.php Outdated Show resolved Hide resolved
Signed-off-by: Joe Fusco <[email protected]>
@colorful-tones
Copy link
Member

Nice progress here @josephfusco ! 🕺

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 SVN

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

Props joefusco, gziolo, spacedmonkey, colorful-tones.

GitHub Merge commits

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: josephfusco <[email protected]>
Co-authored-by: gziolo <[email protected]>
Co-authored-by: spacedmonkey <[email protected]>
Co-authored-by: colorful-tones <[email protected]>

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

src/wp-includes/blocks.php Outdated Show resolved Hide resolved
@gziolo gziolo changed the title Update blocks.php Editor: Make asset registration .asset.php optional for blocks Feb 7, 2024
sirreal added a commit to sirreal/wordpress-develop that referenced this pull request Feb 7, 2024
sirreal added a commit to sirreal/wordpress-develop that referenced this pull request Feb 7, 2024
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.

Updating code directly on GitHub isn't the best idea after all 😅

The good news is that it's ready to go!

@gziolo
Copy link
Member

gziolo commented Feb 8, 2024

Committed with https://core.trac.wordpress.org/changeset/57559.

@gziolo gziolo closed this Feb 8, 2024
sirreal added a commit to sirreal/wordpress-develop that referenced this pull request Feb 8, 2024
sirreal added a commit to sirreal/wordpress-develop that referenced this pull request Feb 8, 2024
@colorful-tones
Copy link
Member

Thanks for getting this over the line @gziolo and thanks @josephfusco for kicking it off 🙌

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.

4 participants