Документация для разработчиков
Темная тема

Login

Описание и параметры

mixed
CUser::Login(
	string login,
	string password,
	string remember = "N",
	string password_original = "Y"
)

Метод проверяет логин и пароль и если они корректные, то авторизует пользователя. Если авторизация успешная, то возвращает "true", иначе если логин и пароль некорректные, то возвращает массив с ошибкой для функции ShowMessage. Если было превышено количество попыток подключения метод просто не будет авторизовывать пользователя с ошибкой "Неправильный логин или пароль". Нестатический метод.

Параметры

ПараметрОписание С версии
login Логин пользователя.
password Пароль. Если параметр convert_password_to_md5 = "Y", то в данном параметре необходимо передавать оригинальный пароль, в противном случае необходимо передавать md5 от оригинального пароля.
remember Если значение равно "Y", то авторизация пользователя будет сохранена в куках (при следующем заходе посетитель будет автоматически авторизован), в противном случае - авторизация не будет сохранена в куках. В куках сохраняется специальный хеш получаемый с помощью CUser::GetPasswordHash. Затем когда посетитель снова приходит на сайт, система его автоматически авторизует используя CUser::LoginByHash
Необязательный. По умолчанию "N".
password_original Если значение равно "Y", то это означает что password ещё не сконвертирован в MD5 (т.е. в параметре password передается реальный пароль вводимый пользователем с клавиатуры), если значение равно "N", то это означает что password уже сконвертирован в MD5.
Для текущего авторизованного пользователя MD5 от реального пароля можно получить с помощью метода $USER->GetParam("PASSWORD_HASH"). Для произвольного пользователя MD5 от пароля можно получить с помощью CUser::GetByID (поле "PASSWORD").
Необязательный. По умолчанию "Y". До версии 4.0.6 назывался pass2md5.
3.0.10

Примеры использования

<?
global $USER;
if (!is_object($USER)) $USER = new CUser;
$arAuthResult = $USER->Login("admin", "123456", "Y");
$APPLICATION->arAuthResult = $arAuthResult;
?>


© «Битрикс», 2001-2024, «1С-Битрикс», 2024