Skip to content

Kirby 4.2.0

$api->user()

Returns the user object for the given id or returns the current authenticated user if no id is passed

$api->user(?string $id = null): Kirby\Cms\User|null

Parameters

Name Type Default Description
$id string|null null User's id

Return type

Kirby\Cms\User|null

Exceptions

Type Description
Kirby\Exception\NotFoundException if the user for the given id cannot be found

Parent class

Kirby\Cms\Api