[wp-trac] [WordPress Trac] #35387: Fix incorrect docs for user authentication functions

[WordPress Trac]

#35387: Fix incorrect docs for user authentication functions
--------------------------+-----------------------------
 Reporter:  ericlewis     |      Owner:
     Type:  defect (bug)  |     Status:  new
 Priority:  normal        |  Milestone:  Awaiting Review
Component:  Users         |    Version:
 Severity:  normal        |   Keywords:
  Focuses:  docs          |
--------------------------+-----------------------------
 A few functions are related to logging in a user.

 `wp_signon()` is the big one that extracts POST form data, authenticates
 the user, and logs the user in.

 `wp_authenticate()` is responsible for authenticating the user: confirming
 the credentials actually match to an existing user. It does not "login"
 the user, just confirms credentials.

 `wp_set_auth_cookie()` is where the rubber meets the road, and login
 cookies are set appropriately.

 `get_currentuserinfo()` will consider a user logged in by checking that
 the cookie is set.

 Some of these functions have misleading docs, I'd like to set the record
 straight.

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