Question

wp_authenticate_email_password( WP_User|WP_Error|null $user,  string $email,  string $password )

Authenticates a user using the email and password.

---

description

---

参数

$user

(WP_User|WP_Error|null) (Required) WP_User or WP_Error object if a previous callback failed authentication.

$email

(string) (Required) Email address for authentication.

$password

(string) (Required) Password for authentication.

---

返回值

(WP_User|WP_Error) WP_User on success, WP_Error on failure.

---

源代码

File: wp-includes/user.php

function wp_authenticate_email_password( $user, $email, $password ) {
	if ( $user instanceof WP_User ) {
		return $user;
	}

	if ( empty( $email ) || empty( $password ) ) {
		if ( is_wp_error( $user ) ) {
			return $user;
		}

		$error = new WP_Error();

		if ( empty( $email ) ) {
			$error->add( 'empty_username', __( '<strong>ERROR</strong>: The email field is empty.' ) ); // Uses 'empty_username' for back-compat with wp_signon()
		}

		if ( empty( $password ) ) {
			$error->add( 'empty_password', __( '<strong>ERROR</strong>: The password field is empty.' ) );
		}

		return $error;
	}

	if ( ! is_email( $email ) ) {
		return $user;
	}

	$user = get_user_by( 'email', $email );

	if ( ! $user ) {
		return new WP_Error( 'invalid_email',
			__( '<strong>ERROR</strong>: Invalid email address.' ) .
			' <a href="' . wp_lostpassword_url() . '">' .
			__( 'Lost your password?' ) .
			'</a>'
		);
	}

	/** This filter is documented in wp-includes/user.php */
	$user = apply_filters( 'wp_authenticate_user', $user, $password );

	if ( is_wp_error( $user ) ) {
		return $user;
	}

	if ( ! wp_check_password( $password, $user->user_pass, $user->ID ) ) {
		return new WP_Error( 'incorrect_password',
			sprintf(
				/* translators: %s: email address */
				__( '<strong>ERROR</strong>: The password you entered for the email address %s is incorrect.' ),
				'<strong>' . $email . '</strong>'
			) .
			' <a href="' . wp_lostpassword_url() . '">' .
			__( 'Lost your password?' ) .
			'</a>'
		);
	}

	return $user;
}

---

更新日志

Version	description
4.5.0	Introduced.

---

相关函数

Uses

• wp-includes/l10n.php: __()
• wp-includes/formatting.php: is_email()
• wp-includes/pluggable.php: wp_check_password()
• wp-includes/pluggable.php: get_user_by()
• wp-includes/general-template.php: wp_lostpassword_url()
• wp-includes/plugin.php: apply_filters()
• wp-includes/user.php: wp_authenticate_user
• wp-includes/load.php: is_wp_error()
• wp-includes/class-wp-error.php: WP_Error::__construct()
Show 4 more uses Hide more uses

---

User Contributed Notes