Skip to content

$auth->validatePassword()

Validates the user credentials and returns the user object on success; otherwise logs the failed attempt

$auth->validatePassword(string $email, string $password): Kirby\Cms\User

Parameters

Name Type Default
$email * string
$password * string

Return type

Kirby\Cms\User

Exceptions

Type Description
Kirby\Exception\PermissionException If the rate limit was exceeded or if any other error occured with debug mode off
Kirby\Exception\NotFoundException If the email was invalid
Kirby\Exception\InvalidArgumentException If the password is not valid (via $user->login())

Parent class

Kirby\Cms\Auth