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

fix: wrong number of $accepted_args on add_filter() calls #66694

Open
wants to merge 2 commits into
base: trunk
Choose a base branch
from

Conversation

justlevine
Copy link
Contributor

@justlevine justlevine commented Nov 2, 2024

What?

This PR fixes several instances of the wrong number of $accepted_args being passed to add_filter(), so the match the correct number of args taken by their callbacks.

As the correct $accepted_args and $priority are the defaults once corrected, the explicit args have been removed entirely.

Why?

While this issue was surfaced by PHPStan (via #66693) it can be remediated independently as part of #66598

How?

Testing Instructions

Testing Instructions for Keyboard

Screenshots or screencast

Copy link

github-actions bot commented Nov 2, 2024

Warning: Type of PR label mismatch

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

  • Type-related labels to choose from: [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Technical Prototype, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core, Gutenberg Plugin.
  • Labels found: Gutenberg Plugin, [Type] Code Quality.

Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task.

Copy link

github-actions bot commented Nov 2, 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.

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: justlevine <[email protected]>
Co-authored-by: gziolo <[email protected]>
Co-authored-by: szepeviktor <[email protected]>
Co-authored-by: Mamaduka <[email protected]>

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

@github-actions github-actions bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label Nov 2, 2024
Copy link

github-actions bot commented Nov 2, 2024

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @justlevine! In case you missed it, we'd love to have you join us in our Slack community.

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.

@szepeviktor
Copy link

Yes, level 0 problems must be fixed.

I consider applications with level 4 problems broken.

@Mamaduka Mamaduka added Gutenberg Plugin Issues or PRs related to Gutenberg Plugin management related efforts [Type] Code Quality Issues or PRs that relate to code quality labels Nov 5, 2024
@Mamaduka
Copy link
Member

Mamaduka commented Nov 5, 2024

I think we can just omit $accepted_args when the value is one. It's the default value for hooks.

@justlevine
Copy link
Contributor Author

I think we can just omit $accepted_args when the value is one. It's the default value for hooks.

Perhaps, but figured I'd match the existing patterns e.g.

add_action( 'wp_enqueue_scripts', 'gutenberg_enqueue_block_style_variation_styles', 1 );

@Mamaduka
Copy link
Member

Mamaduka commented Nov 5, 2024

The 1 in that example is $priority and not the $accepted_args. In any case, it was a minor nitpick, nothing blocker for this PR.

@@ -273,7 +273,7 @@ function gutenberg_enqueue_block_style_variation_styles() {
}

// Add Gutenberg filters and action.
add_filter( 'render_block_data', 'gutenberg_render_block_style_variation_support_styles', 10, 2 );
add_filter( 'render_block_data', 'gutenberg_render_block_style_variation_support_styles', 10, 1 );
Copy link
Member

Choose a reason for hiding this comment

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

Here and in other places 1 can be omitted as it's the default value. The same applies to the priority which also defaults to 10.

@justlevine
Copy link
Contributor Author

@gziolo / @Mamaduka apologies, I thought I pushed this back in november 😅

Updated in 0beec7c

@gziolo gziolo removed the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label Dec 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Gutenberg Plugin Issues or PRs related to Gutenberg Plugin management related efforts [Type] Code Quality Issues or PRs that relate to code quality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants