WordPress.org

Make WordPress Core

Opened 5 years ago

Closed 5 years ago

Last modified 5 years ago

#35387 closed defect (bug) (fixed)

Fix incorrect docs for user authentication functions

Reported by: ericlewis Owned by: ericlewis
Milestone: 4.5 Priority: normal
Severity: normal Version:
Component: Users Keywords: has-patch
Focuses: docs Cc:

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)

35387.diff (3.7 KB) - added by ericlewis 5 years ago.
35387.2.diff (2.8 KB) - added by ericlewis 5 years ago.

Download all attachments as: .zip

Change History (6)

@ericlewis
5 years ago

@ericlewis
5 years ago

#1 @ericlewis
5 years ago

attachment:35387.2.diff drops some tests I had leftover from a previous diff.

#2 @ericlewis
5 years ago

  • Keywords has-patch added
  • Milestone changed from Awaiting Review to 4.5

#3 @ericlewis
5 years ago

  • Owner set to ericlewis
  • Resolution set to fixed
  • Status changed from new to closed

In 36245:

Users: Fix incorrect docs for user authentication and login functions.

Fixes #35387

#4 @ericlewis
5 years ago

In 36246:

Login is not a verb, change "login" to "log in".

See #35387

Note: See TracTickets for help on using tickets.