$auth->login()
Login a user by email and password
$auth->login(string $email, string $password, bool $long = false): Kirby\Cms\User
Parameters
| Name | Type | Default |
|---|---|---|
| $emailrequired | string |
no default value |
| $passwordrequired | string |
no default value |
| $long | bool |
false
|
Return type
This method modifies the existing $auth object it is applied to and returns it again.
Exceptions
| Type | Description |
|---|---|
Kirby\Exception\PermissionException |
If the rate limit was exceeded or if any other error occurred with debug mode off |
Kirby\Exception\NotFoundException |
If the email was invalid |
Kirby\Exception\InvalidArgumentException |
If the password is not valid (via $user->login()) |