Skip to content

Docs: Fix @var type for WP_User_Request::$user_id to string#12018

Open
masteradhoc wants to merge 1 commit into
WordPress:trunkfrom
masteradhoc:44723-doc-adjustments-userid
Open

Docs: Fix @var type for WP_User_Request::$user_id to string#12018
masteradhoc wants to merge 1 commit into
WordPress:trunkfrom
masteradhoc:44723-doc-adjustments-userid

Conversation

@masteradhoc
Copy link
Copy Markdown

@masteradhoc masteradhoc commented May 30, 2026

Fix the inline documentation for WP_User_Request::$user_id, which is
documented as int but is actually a string. The value is assigned
directly from $post->post_author in 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 0 in get_user_locale()
evaluated incorrectly because "0" !== 0. The runtime fix was addressed
in #43985; this corrects the documentation to match actual behavior.

Precedent: WP_Post::$post_author is documented as string for the same
reason (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.

@github-actions
Copy link
Copy Markdown

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

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

@github-actions
Copy link
Copy Markdown

Test using WordPress Playground

The 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

  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Copy link
Copy Markdown

@apermo apermo left a comment

Choose a reason for hiding this comment

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

@westonruter your thoughts?

Comment on lines +23 to 25
* @var string
*/
public $user_id = 0;
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

If the phpdoc is updated to string, the actual value is wrong.

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.

2 participants