Skip to content

Elements: Deprecate old block support filter callbacks#59538

Merged
aaronrobertshaw merged 6 commits intotrunkfrom
fix/element-block-support-filters-clean-up
Apr 22, 2024
Merged

Elements: Deprecate old block support filter callbacks#59538
aaronrobertshaw merged 6 commits intotrunkfrom
fix/element-block-support-filters-clean-up

Conversation

@aaronrobertshaw
Copy link
Copy Markdown
Contributor

@aaronrobertshaw aaronrobertshaw commented Mar 4, 2024 •
edited
Loading

Addresses: #59535 (comment)

What?

  • Deprecates remove block support filter callback function
  • Deprecates argument for callback function that was moved to a different filter
  • Fixes some code style issues

Why?

Whether the callback functions were part of a private API and not documented publicly or not, if it could be used, it might have been so better to deprecate the function or argument as required.

How?

  • Deprecates gutenberg_render_elements_support
  • Deprecates string value for first argument for gutenberg_render_elements_support_styles (now it is used with render_block_data the arg should be an array).
  • Fixes some code style issues

Testing Instructions

  1. Run unit tests: npm run test:unit:php:base -- --filter WP_Block_Supports_Elements_Test
  2. Test element styles can still be applied and rendered correctly on the frontend following the steps over on Elements: Merge element style and classname generation to single filter #59535.

Next Steps

@aaronrobertshaw aaronrobertshaw added [Type] Code Quality Issues or PRs that relate to code quality [Feature] Design Tools Tools that impact the appearance of blocks both to expand the number of tools and improve the experi [Feature] Colors Color management labels Mar 4, 2024
@aaronrobertshaw aaronrobertshaw self-assigned this Mar 4, 2024
@github-actions
Copy link
Copy Markdown

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

This pull request changed or added PHP files in previous commits, but none have been detected in the latest commit.

Thank you! ❤️

@aaronrobertshaw
Copy link
Copy Markdown
Contributor Author

aaronrobertshaw commented Mar 4, 2024

I'll be AFK for just over a week, so my connection and bandwidth might be limited in addressing any feedback until the middle of next week.

@aaronrobertshaw aaronrobertshaw mentioned this pull request Mar 4, 2024
Merged
@aaronrobertshaw aaronrobertshaw mentioned this pull request Mar 14, 2024
Closed
@aaronrobertshaw aaronrobertshaw marked this pull request as ready for review March 14, 2024 05:44
@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.

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: aaronrobertshaw <aaronrobertshaw@git.wordpress.org>
Co-authored-by: andrewserong <andrewserong@git.wordpress.org>
Co-authored-by: peterwilsoncc <peterwilsoncc@git.wordpress.org>

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

andrewserong
andrewserong approved these changes Mar 15, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@andrewserong andrewserong 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 follow-up! The elements styles are still being output correctly, and the deprecated calls all look good to me. I'm not super confident with my understanding of PHP deprecated calls, though, so it might be worth getting a second opinion from @peterwilsoncc, but overall this LGTM!

@peterwilsoncc
Copy link
Copy Markdown
Contributor

peterwilsoncc commented Mar 24, 2024

Acknowledging I've seen this but I'm ignoring anything that isn't going to hit WordPress 6.5 until after the release.

peterwilsoncc
peterwilsoncc reviewed Apr 21, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@peterwilsoncc peterwilsoncc left a comment

Choose a reason for hiding this comment

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

This looks good to me folks, just a minor note about a self referential deprecation notice.

Once that's fixed, this is good to merge.

lib/block-supports/elements.php Outdated
* @return string Filtered block content.
*/
function gutenberg_render_elements_support( $block_content ) {
_deprecated_function( __FUNCTION__, '6.6.0', 'gutenberg_render_elements_support' );
Copy link
Copy Markdown
Contributor

@peterwilsoncc peterwilsoncc Apr 21, 2024

Choose a reason for hiding this comment

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

This refers to itself as the replacement in the third param.

Copy link
Copy Markdown
Contributor Author

@aaronrobertshaw aaronrobertshaw Apr 21, 2024

Choose a reason for hiding this comment

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

Thanks for catching that @peterwilsoncc! 🙈

I've fixed it and the docblock in 92ebee5

@aaronrobertshaw aaronrobertshaw merged commit c817886 into trunk Apr 22, 2024
@aaronrobertshaw aaronrobertshaw deleted the fix/element-block-support-filters-clean-up branch April 22, 2024 00:30
@github-actions github-actions bot added this to the Gutenberg 18.3 milestone Apr 22, 2024
@ellatrix ellatrix mentioned this pull request Apr 30, 2024
Closed
@aaronrobertshaw
Copy link
Copy Markdown
Contributor Author

aaronrobertshaw commented May 1, 2024

The changes from this PR and #59535 are combined in a single backport available in WordPress/wordpress-develop#6214.

@ryelle ryelle mentioned this pull request May 6, 2024
Closed
@aaronrobertshaw aaronrobertshaw added the Backported to WP Core Pull request that has been successfully merged into WP Core label May 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@peterwilsoncc peterwilsoncc peterwilsoncc left review comments

@andrewserong andrewserong andrewserong approved these changes

@spacedmonkey spacedmonkey Awaiting requested review from spacedmonkey spacedmonkey is a code owner

@tellthemachines tellthemachines Awaiting requested review from tellthemachines

Assignees

@aaronrobertshaw aaronrobertshaw

Labels

Backported to WP Core Pull request that has been successfully merged into WP Core [Feature] Colors Color management [Feature] Design Tools Tools that impact the appearance of blocks both to expand the number of tools and improve the experi [Type] Code Quality Issues or PRs that relate to code quality

Projects

None yet

Milestone

Gutenberg 18.3

Development

Successfully merging this pull request may close these issues.

3 participants

@aaronrobertshaw @peterwilsoncc @andrewserong