#35387 closed defect (bug) (fixed)
Fix incorrect docs for user authentication functions
| Reported by: | ericlewis | Owned by: | ericlewis |
|---|---|---|---|
| Priority: | normal | Milestone: | 4.5 |
| Component: | Users | Version: | |
| Severity: | normal | Keywords: | has-patch |
| Cc: | Focuses: | docs |
Description
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.
Attachments (2)
Change History (6)
Note:
See TracTickets
for help on using tickets.
![(please configure the [header_logo] section in trac.ini)](/chrome/site/your_project_logo.png)
attachment:35387.2.diff drops some tests I had leftover from a previous diff.