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

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

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

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.

Return: (bool) False on login failure, true on successful check

Source file: wp-includes/pluggable-deprecated.php

View source


Parameters

$username

(string) (Required) User's username

$password

(string) (Required) User's password

$deprecated

(string) (Optional) Not used

Default value: ''


Used by


Source

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

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

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

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

Changelog


User Contributed Notes

You must log in before being able to contribute a note.