wp_login( string $username, string $password, string $deprecated = '' ): bool

Description

Parameters

$usernamestring

User's username

$passwordstring

User's password

$deprecatedstringoptional

Not usedDefault: ''

Return

bool

True on successful check, false on login failure.

Uses · 3

• _deprecated_function()Marks a function as deprecated and inform when it has been used.
• wp_authenticate()Authenticates a user, confirming the login credentials are valid.
• is_wp_error()Checks whether the given variable is a WordPress Error.

Source

View on Trac ↗View on GitHub ↗

179function wp_login(180	$username,181	#[\SensitiveParameter]182	$password,183	$deprecated = ''184) {185	_deprecated_function( __FUNCTION__, '2.5.0', 'wp_signon()' );186	global $error;187 188	$user = wp_authenticate($username, $password);189 190	if ( ! is_wp_error($user) )191		return true;192 193	$error = $user->get_error_message();194	return false;195}

History

Introduced in 1.2.2. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/pluggable-deprecated.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.