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

Chore: Remove invalid @throws WP_Error from register_block_*() doc-blocks #7684

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from

Conversation

justlevine
Copy link

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

This PR removes invalid @throws WP_Error annotations from the doc-blocks of the following functions:

  • register_block_core_home_link()
  • register_block_core_navigation_link()
  • register_block_core_navigation_submenu()

These annotations are invalid for a few reasons:

  • WP_Error is returnable, not Throwable
  • WP_Error is not returned.
  • A review of the functions' internals and render_callbacks doesn't show any attempts to either return a WP_Error or throw anything else.
    ( It's possible I missed something, but I'm pretty confident, as these are the only register_() functions in blocks/ that have any @throws annotation )

While this issue was surfaced via PHPStan in #7619 (trac: https://core.trac.wordpress.org/ticket/61175 ), it can be remediated independently of that ticket.


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

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 justlevine.

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

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.

1 participant