wp_authenticate

Проверяет данные авторизации зарегистрированного пользователя (логин и пароль) и авторизует его, если проверка прошла успешно.

Функция сама по себе ничего не делает, а передает данные в фильтр ‘authenticate’, через который проверяется переданные логин и пароль, и пользователь авторизуется.

Хуки из функции:
authenticate
wp_login_failed
Возвращает

Объект данных о пользователе (WP_User), если авторизация прошла успешно и объект WP_Error в противном случае.

Использование

wp_authenticate( $username, $password );
$username(строка) (обязательный)
Логин пользователя. С версии 4.5. можно указывать email.
$password(строка) (обязательный)
Пароль пользователя.

Примеры

#1 Авторизуем пользователя

Предположим у нас есть логин и пароль пользователя и нам нужно его авторизовать (залогинить), мы может сделать это так:

$username = 'truegamer';
$password = 'live_is_a_game';

// Авторизуем
$auth = wp_authenticate( $username, $password );

// Проверка ошибок
if ( is_wp_error( $auth ) ) {
	$error_string = $auth->get_error_message();
	echo '<div id="message" class="error"><p>' . $error_string . '</p></div>';
}
else {
	echo "Авторизация прошла успешно!";
}

Код из


wp-includes/pluggable.php

WP 4.7.2

<?php
function wp_authenticate($username, $password) {
	$username = sanitize_user($username);
	$password = trim($password);

	/**
	 * Filters whether a set of user login credentials are valid.
	 *
	 * A WP_User object is returned if the credentials authenticate a user.
	 * WP_Error or null otherwise.
	 *
	 * @since 2.8.0
	 * @since 4.5.0 `$username` now accepts an email address.
	 *
	 * @param null|WP_User|WP_Error $user     WP_User if the user is authenticated.
	 *                                        WP_Error or null otherwise.
	 * @param string                $username Username or email address.
	 * @param string                $password User password
	 */
	$user = apply_filters( 'authenticate', null, $username, $password );

	if ( $user == null ) {
		// TODO what should the error message be? (Or would these even happen?)
		// Only needed if all authentication handlers fail to return anything.
		$user = new WP_Error( 'authentication_failed', __( '<strong>ERROR</strong>: Invalid username, email address or incorrect password.' ) );
	}

	$ignore_codes = array('empty_username', 'empty_password');

	if (is_wp_error($user) && !in_array($user->get_error_code(), $ignore_codes) ) {
		/**
		 * Fires after a user login has failed.
		 *
		 * @since 2.5.0
		 * @since 4.5.0 The value of `$username` can now be an email address.
		 *
		 * @param string $username Username or email address.
		 */
		do_action( 'wp_login_failed', $username );
	}

	return $user;
}

Комментарии:


Оставить комментарий

Your email address will not be published. Required fields are marked *