[wp-trac] [WordPress Trac] #27130: wp_signon() wrong PHPDoc

[WordPress Trac]

#27130: wp_signon() wrong PHPDoc
--------------------------+-----------------------------
 Reporter:  tivnet        |      Owner:
     Type:  defect (bug)  |     Status:  new
 Priority:  normal        |  Milestone:  Awaiting Review
Component:  General       |    Version:
 Severity:  normal        |   Keywords:
  Focuses:                |
--------------------------+-----------------------------
 {{{
  * @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`

--
Ticket URL: <https://core.trac.wordpress.org/ticket/27130>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform