Fix: Update return doc to String|False for current_filter() and current_action() #8840
Conversation
|
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 Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Test using WordPress PlaygroundThe 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
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
peterwilsoncc
left a comment
There was a problem hiding this comment.
Thank you, these changes look good to me.
Trac Ticket: Core-63479
Problem
The @return annotations for current_action() and current_filter() are currently defined as string, but both functions can return false when called outside the context of any action or filter. This can occur in specific scenarios such as:
Within an exception handler after a fatal or uncaught exception.
When WordPress is manually loaded (e.g., via wp-load.php) and code is executed before any hooks have been triggered.
This mismatch between the documented return type and actual behavior can lead to incorrect assumptions and potential runtime issues.
Solution
Update the @return annotations for both current_action() and current_filter() to string|false.