W3cubDocs

/WordPress

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

This function has been deprecated. Use wp_signon() instead.

Checks a users login information and logs them in if it checks out. This function is deprecated.

Description

Use the global $error to get the reason why the login failed. If the username is blank, no error will be set, so assume blank username on that case.

Plugins extending this function should also provide the global $error and set what the error is, so that those checking the global for why there was a failure can utilize it later.

See also

Parameters

$username

(string) (Required) User's username

$password

(string) (Required) User's password

$deprecated

(string) (Optional) Not used

Default value: ''

Return

(bool) True on successful check, false on login failure.

Source

File: wp-includes/pluggable-deprecated.php 

function wp_login($username, $password, $deprecated = '') {
	_deprecated_function( __FUNCTION__, '2.5.0', 'wp_signon()' );
	global $error;

	$user = wp_authenticate($username, $password);

	if ( ! is_wp_error($user) )
		return true;

	$error = $user->get_error_message();
	return false;
}

Uses

Uses Description
wp-includes/pluggable.php: wp_authenticate()

Authenticate a user, confirming the login credentials are valid.
wp-includes/functions.php: _deprecated_function()

Mark a function as deprecated and inform when it has been used.
wp-includes/load.php: is_wp_error()

Check whether variable is a WordPress Error.

Changelog

Version Description
2.5.0 Use wp_signon()
1.2.2 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_login