Credentials parameter default in wp_signon() should be an array

[tivnet]

 * @param array $credentials Optional. User info in order to sign on.
 * @param bool $secure_cookie Optional. Whether to use secure cookie.
 * @return object Either WP_Error on failure, or WP_User on success.
 */
function wp_signon( $credentials = '', $secure_cookie = '' ) {

1. @return WP_User|WP_Error Either WP_Error on failure, or WP_User on success.

2. $credentials = '', $secure_cookie = '' probably wrong default values. Or wrong @param

[SergeyBiryukov]

Seems like the default value of $credentials should be an array.

We use strict comparison for $secure_cookie though:
https://core.trac.wordpress.org/browser/tags/3.8.1/src/wp-includes/user.php#L43

Could probably use null instead, but need to be careful with backwards compatibility, so I guess it's safer to keep it a string. The @param description is correct, it's treated as a boolean value.

[DrewAPicture]

@tivnet: Care to make a patch? :)

[tivnet]

Replying to DrewAPicture:

@tivnet: Care to make a patch? :)

I usually do. In this case, there were unclear moments (see Sergey's comments)
If what Sergey wrote is final - I'll make a patch...

...or you can just fix that :-), and I'll lose the "props" this time :-)))

[azizur]

Ticket #26148 has patch addresses this issue.

[DrewAPicture]

Duplicate of #26148.

[DrewAPicture]

#26148 is a documentation-specific patch. Re-opening here in favor of handling the $credentials default change from an empty string to an empty array.

[SergeyBiryukov]

In 27350:

Default value for $credentials parameter in wp_signon() should be an array, not a string.

props tivnet.
fixes #27130.