authenticate

SummerySummery

Filters whether a set of user login credentials are valid.

Syntax

apply_filters( 'authenticate', null|WP_User|WP_Error $user, string $username, string $password )

DescriptionDescription

A WP_User object is returned if the credentials authenticate a user. WP_Error or null otherwise.

ParametersParameters

$user

(null|WP_User|WP_Error) WP_User if the user is authenticated. WP_Error or null otherwise.

$username

(string) Username or email address.

$password

(string) User password

SourceSource

File: wp-includes/pluggable.php

ChangelogChangelog

Changelog
Version Description
4.5.0 $username now accepts an email address.
2.8.0 Introduced.
Scroll to Top