Skip to content

Kirby 5.1.2

$auth->user()

Validates the currently logged in user

$auth->user(Kirby\Session\Session|array|null $session = null, bool $allowImpersonation = true): Kirby\Cms\User|null

Parameters

Name Type Default Description
$session Kirby\Session\Sessionorarrayornull null
$allowImpersonation bool true If set to false, only the actually
logged in user will be returned

Return types

Kirby\Cms\Userornull

This method modifies the existing $auth object it is applied to and returns it again.

Exceptions

Type Description
Throwable If an authentication error occurred

Parent class

Kirby\Cms\Auth