Docs: Fix @var type for WP_User_Request::$user_id to string#12018
Docs: Fix @var type for WP_User_Request::$user_id to string#12018masteradhoc wants to merge 1 commit into
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. |
| * @var string | ||
| */ | ||
| public $user_id = 0; |
There was a problem hiding this comment.
If the phpdoc is updated to string, the actual value is wrong.
Fix the inline documentation for
WP_User_Request::$user_id, which isdocumented as
intbut is actually astring. The value is assigneddirectly from
$post->post_authorin the constructor with no type cast,so it reflects the raw database value, which is always a string.
This incorrect type hint was the root cause of the bug described in the
ticket, where a strict comparison against
0inget_user_locale()evaluated incorrectly because
"0" !== 0. The runtime fix was addressedin #43985; this corrects the documentation to match actual behavior.
Precedent:
WP_Post::$post_authoris documented asstringfor the samereason (see #25092).
Trac ticket: https://core.trac.wordpress.org/ticket/44723
Use of AI Tools
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.