Skip to content

Backport: Elements - Merge element style and classname generation to single filter#6214

Closed
aaronrobertshaw wants to merge 6 commits intoWordPress:trunkfrom
aaronrobertshaw:fix/element-block-support-application
Closed

Backport: Elements - Merge element style and classname generation to single filter#6214
aaronrobertshaw wants to merge 6 commits intoWordPress:trunkfrom
aaronrobertshaw:fix/element-block-support-application

Conversation

@aaronrobertshaw
Copy link
Copy Markdown

@aaronrobertshaw aaronrobertshaw commented Mar 4, 2024 •
edited
Loading

Syncs the changes from WordPress/gutenberg#59535 and WordPress/gutenberg#59538.

These change update the elements block support filters such that the elements class name is only generated in a single location. This avoids conflicts between class names and makes the block support robust in the face of a block's data being filtered via other render_block_data filters.

To test:

Confirm WordPress/gutenberg#59462 is still resolved

  1. Edit a post and add a paragraph
  2. Create a link with the paragraph
  3. Via the block inspector apply a link color to the paragraph
  4. Save and view the frontend confirming the correct link color is shown
  5. Confirm nested applications of the same element styles work correctly:

Create some nested blocks containing links

  1. Apply a set of element styles to the parent block
  2. Apply different styles to a child block
  3. Apply the first set of element styles to a grand-child block
  4. Confirm the correct display of element styles

Unit tests:

npm run test:php -- --filter Tests_Block_Supports_WpRenderElementsSupport
npm run test:php -- --filter Tests_Block_Supports_WpRenderElementsSupportStyles

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

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.

@aaronrobertshaw
Copy link
Copy Markdown
Author

aaronrobertshaw commented Mar 4, 2024

This PR is still only in a draft state as I have run out of time. Unfortunately, I'll be AFK until next week with limited bandwidth to push this across the line.

Anyone is welcome to pick this up, push to it, or create an alternate PR 🙏

@aaronrobertshaw aaronrobertshaw mentioned this pull request Mar 4, 2024
Merged
@aaronrobertshaw aaronrobertshaw marked this pull request as ready for review March 14, 2024 05:45
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 14, 2024 •
edited
Loading

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 aaronrobertshaw, isabel_brison.

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

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 14, 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.

@aaronrobertshaw aaronrobertshaw force-pushed the fix/element-block-support-application branch from 342eb52 to 7b64d09 Compare May 1, 2024 05:27
This was referenced May 1, 2024
Merged
Closed
tellthemachines
tellthemachines reviewed May 1, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@tellthemachines tellthemachines left a comment

Choose a reason for hiding this comment

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

This is testing well for me! In order to reproduce the bug that this fixes, I dumped the filter that originally caused it in gutenberg into the layout.php file. I was then able to confirm that this change fixes the issue.

Just a couple minor corrections below, but otherwise looks good!

@aaronrobertshaw
Copy link
Copy Markdown
Author

aaronrobertshaw commented May 2, 2024

Thanks for the review @tellthemachines 👍

I've addressed the feedback 1789ecf & 8e60ca7.

tellthemachines
tellthemachines approved these changes May 2, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@tellthemachines tellthemachines left a comment

Choose a reason for hiding this comment

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

Thanks for the update! LGTM.

@tellthemachines
Copy link
Copy Markdown
Contributor

tellthemachines commented May 2, 2024

Committed in r58074.

mukeshpanchal27
mukeshpanchal27 reviewed May 2, 2024
View reviewed changes
src/wp-includes/block-supports/elements.php
* `render_block_data` filter in 6.6.0 to avoid filtered attributes
* breaking the application of the elements CSS class.
*
* @see https://github.com/WordPress/gutenberg/pull/59535.
Copy link
Copy Markdown
Member

@mukeshpanchal27 mukeshpanchal27 May 2, 2024

Choose a reason for hiding this comment

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

Remove end period.

mukeshpanchal27
mukeshpanchal27 reviewed May 2, 2024
View reviewed changes
src/wp-includes/block-supports/elements.php
Comment on lines +261 to +263
* @param array $block Block object.
*
* @return string Filtered block content.
Copy link
Copy Markdown
Member

@mukeshpanchal27 mukeshpanchal27 May 2, 2024

Choose a reason for hiding this comment

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

Remove empty line.

@aaronrobertshaw aaronrobertshaw mentioned this pull request May 3, 2024
Closed
@aaronrobertshaw
Copy link
Copy Markdown
Author

aaronrobertshaw commented May 3, 2024

@mukeshpanchal27 as these changes were already committed, I've created a follow-up PR to address the issues noted

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tellthemachines tellthemachines tellthemachines approved these changes

+1 more reviewer

@mukeshpanchal27 mukeshpanchal27 mukeshpanchal27 left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@aaronrobertshaw @tellthemachines @mukeshpanchal27