phpDoc patch for wp-admin/includes/user.php

[tivnet]

@return should start with WP_User

[DrewAPicture]

It's core style to delineate the return type as object, and use the description to specify the kind of object.

[tivnet]

Replying to DrewAPicture:

It's core style to delineate the return type as object, and use the description to specify the kind of object.

First of all, if that's a "core style" then it's time to change this style, because modern IDE's use phpDoc to validate code and provide prompts. "Object" won't help.

Besides, take a look at get_post() - what does it say there? Yes, WP_Post.
wp_insert_post does not say object in @return.
get_page returns WP_Post
Same for get_default_post_to_edit
get_current_screen returns WP_Screen

If you are not convinced, can I ask for a second opinion?
Thank you!

[markoheijnen]

The patch seems totally fine with me.

[DrewAPicture]

Replying to tivnet:

Replying to DrewAPicture:

It's core style to delineate the return type as object, and use the description to specify the kind of object.

First of all, if that's a "core style" then it's time to change this style, because modern IDE's use phpDoc to validate code and provide prompts. "Object" won't help.

I was mistaken, in terms of using named class objects in the phpdoc return tags. This section of the phpdoc standard for WordPress hasn't been written yet ;) I'll add it to my list.

+1 for user.php.patch​

[SergeyBiryukov]

get_userdata() can also return false, we should probably take that into account: 24992.patch​.

[tivnet]

Replying to SergeyBiryukov:
Maybe WP_User|bool ? Generally, it returns WP_User. Bool is an exception.

[SergeyBiryukov]

24992.2.patch​ brings some consistency.

[DrewAPicture]

24992.2.patch​ looks good to me.

[SergeyBiryukov]

In 25204:

Update phpdoc for get_user_to_edit(), get_userdata(), and get_user_by(). props tivnet. fixes #24992.