# $user

The `$user` object represents a single Panel or frontend user.

****

- Full class name: `Kirby\Cms\User`
- Alias: `User`
- Source: <https://github.com/getkirby/kirby/tree/5.5.3/src/Cms/User.php#L32>

****

### $user

- [$user->__call()](https://getkirby.com/docs/reference/objects/cms/user/__call.md)
- [new User()](https://getkirby.com/docs/reference/objects/cms/user/__construct.md)
- [$user->__debugInfo()](https://getkirby.com/docs/reference/objects/cms/user/__debug-info.md)
- [$user->__toString()](https://getkirby.com/docs/reference/objects/cms/user/__to-string.md)
- [$user->apiUrl()](https://getkirby.com/docs/reference/objects/cms/user/api-url.md)
- [$user->audio()](https://getkirby.com/docs/reference/objects/cms/user/audio.md)
- [$user->avatar()](https://getkirby.com/docs/reference/objects/cms/user/avatar.md)
- [$user->blueprint()](https://getkirby.com/docs/reference/objects/cms/user/blueprint.md)
- [$user->blueprints()](https://getkirby.com/docs/reference/objects/cms/user/blueprints.md)
- [$user->changeEmail()](https://getkirby.com/docs/reference/objects/cms/user/change-email.md)
- [$user->changeLanguage()](https://getkirby.com/docs/reference/objects/cms/user/change-language.md)
- [$user->changeName()](https://getkirby.com/docs/reference/objects/cms/user/change-name.md)
- [$user->changePassword()](https://getkirby.com/docs/reference/objects/cms/user/change-password.md)
- [$user->changeRole()](https://getkirby.com/docs/reference/objects/cms/user/change-role.md)
- [$user->changeStorage()](https://getkirby.com/docs/reference/objects/cms/user/change-storage.md)
- [$user->changeTotp()](https://getkirby.com/docs/reference/objects/cms/user/change-totp.md)
- [$user->clone()](https://getkirby.com/docs/reference/objects/cms/user/clone.md)
- [$user->code()](https://getkirby.com/docs/reference/objects/cms/user/code.md)
- [$user->content()](https://getkirby.com/docs/reference/objects/cms/user/content.md)
- [$user->contentFileData()](https://getkirby.com/docs/reference/objects/cms/user/content-file-data.md)
- [User::create()](https://getkirby.com/docs/reference/objects/cms/user/create.md)
- [$user->createAvatar()](https://getkirby.com/docs/reference/objects/cms/user/create-avatar.md)
- [$user->createDefaultContent()](https://getkirby.com/docs/reference/objects/cms/user/create-default-content.md)
- [$user->createFile()](https://getkirby.com/docs/reference/objects/cms/user/create-file.md)
- [$user->createId()](https://getkirby.com/docs/reference/objects/cms/user/create-id.md)
- [$user->decrement()](https://getkirby.com/docs/reference/objects/cms/user/decrement.md)
- [$user->delete()](https://getkirby.com/docs/reference/objects/cms/user/delete.md)
- [$user->deleteAvatar()](https://getkirby.com/docs/reference/objects/cms/user/delete-avatar.md)
- [$user->documents()](https://getkirby.com/docs/reference/objects/cms/user/documents.md)
- [$user->email()](https://getkirby.com/docs/reference/objects/cms/user/email.md)
- [$user->errors()](https://getkirby.com/docs/reference/objects/cms/user/errors.md)
- [$user->exists()](https://getkirby.com/docs/reference/objects/cms/user/exists.md)
- [User::extendModels()](https://getkirby.com/docs/reference/objects/cms/user/extend-models.md)
- [User::factory()](https://getkirby.com/docs/reference/objects/cms/user/factory.md)
- [$user->file()](https://getkirby.com/docs/reference/objects/cms/user/file.md)
- [$user->files()](https://getkirby.com/docs/reference/objects/cms/user/files.md)
- [$user->getMethod()](https://getkirby.com/docs/reference/objects/cms/user/get-method.md)
- [$user->hardcopy()](https://getkirby.com/docs/reference/objects/cms/user/hardcopy.md)
- [$user->hasAudio()](https://getkirby.com/docs/reference/objects/cms/user/has-audio.md)
- [$user->hasCode()](https://getkirby.com/docs/reference/objects/cms/user/has-code.md)
- [$user->hasDocuments()](https://getkirby.com/docs/reference/objects/cms/user/has-documents.md)
- [$user->hasFiles()](https://getkirby.com/docs/reference/objects/cms/user/has-files.md)
- [$user->hasImages()](https://getkirby.com/docs/reference/objects/cms/user/has-images.md)
- [$user->hasMethod()](https://getkirby.com/docs/reference/objects/cms/user/has-method.md)
- [$user->hasNext()](https://getkirby.com/docs/reference/objects/cms/user/has-next.md)
- [$user->hasPassword()](https://getkirby.com/docs/reference/objects/cms/user/has-password.md)
- [$user->hasPrev()](https://getkirby.com/docs/reference/objects/cms/user/has-prev.md)
- [$user->hasVideos()](https://getkirby.com/docs/reference/objects/cms/user/has-videos.md)
- [User::hashPassword()](https://getkirby.com/docs/reference/objects/cms/user/hash-password.md)
- [$user->id()](https://getkirby.com/docs/reference/objects/cms/user/id.md)
- [$user->image()](https://getkirby.com/docs/reference/objects/cms/user/image.md)
- [$user->images()](https://getkirby.com/docs/reference/objects/cms/user/images.md)
- [$user->increment()](https://getkirby.com/docs/reference/objects/cms/user/increment.md)
- [$user->indexOf()](https://getkirby.com/docs/reference/objects/cms/user/index-of.md)
- [$user->inventory()](https://getkirby.com/docs/reference/objects/cms/user/inventory.md)
- [$user->is()](https://getkirby.com/docs/reference/objects/cms/user/is.md)
- [$user->isAccessible()](https://getkirby.com/docs/reference/objects/cms/user/is-accessible.md)
- [$user->isAdmin()](https://getkirby.com/docs/reference/objects/cms/user/is-admin.md)
- [$user->isFirst()](https://getkirby.com/docs/reference/objects/cms/user/is-first.md)
- [$user->isKirby()](https://getkirby.com/docs/reference/objects/cms/user/is-kirby.md)
- [$user->isLast()](https://getkirby.com/docs/reference/objects/cms/user/is-last.md)
- [$user->isLastAdmin()](https://getkirby.com/docs/reference/objects/cms/user/is-last-admin.md)
- [$user->isLastUser()](https://getkirby.com/docs/reference/objects/cms/user/is-last-user.md)
- [$user->isListable()](https://getkirby.com/docs/reference/objects/cms/user/is-listable.md)
- [$user->isLocked()](https://getkirby.com/docs/reference/objects/cms/user/is-locked.md)
- [$user->isLoggedIn()](https://getkirby.com/docs/reference/objects/cms/user/is-logged-in.md)
- [$user->isNobody()](https://getkirby.com/docs/reference/objects/cms/user/is-nobody.md)
- [$user->isNth()](https://getkirby.com/docs/reference/objects/cms/user/is-nth.md)
- [$user->isValid()](https://getkirby.com/docs/reference/objects/cms/user/is-valid.md)
- [$user->kirby()](https://getkirby.com/docs/reference/objects/cms/user/kirby.md)
- [$user->language()](https://getkirby.com/docs/reference/objects/cms/user/language.md)
- [$user->lock()](https://getkirby.com/docs/reference/objects/cms/user/lock.md)
- [$user->login()](https://getkirby.com/docs/reference/objects/cms/user/login.md)
- [$user->loginPasswordless()](https://getkirby.com/docs/reference/objects/cms/user/login-passwordless.md)
- [$user->logout()](https://getkirby.com/docs/reference/objects/cms/user/logout.md)
- [$user->mediaDir()](https://getkirby.com/docs/reference/objects/cms/user/media-dir.md)
- [$user->mediaRoot()](https://getkirby.com/docs/reference/objects/cms/user/media-root.md)
- [$user->mediaUrl()](https://getkirby.com/docs/reference/objects/cms/user/media-url.md)
- [User::model()](https://getkirby.com/docs/reference/objects/cms/user/model.md)
- [$user->modified()](https://getkirby.com/docs/reference/objects/cms/user/modified.md)
- [$user->name()](https://getkirby.com/docs/reference/objects/cms/user/name.md)
- [$user->nameOrEmail()](https://getkirby.com/docs/reference/objects/cms/user/name-or-email.md)
- [$user->next()](https://getkirby.com/docs/reference/objects/cms/user/next.md)
- [$user->nextAll()](https://getkirby.com/docs/reference/objects/cms/user/next-all.md)
- [User::nobody()](https://getkirby.com/docs/reference/objects/cms/user/nobody.md)
- [$user->panel()](https://getkirby.com/docs/reference/objects/cms/user/panel.md)
- [$user->password()](https://getkirby.com/docs/reference/objects/cms/user/password.md)
- [$user->passwordTimestamp()](https://getkirby.com/docs/reference/objects/cms/user/password-timestamp.md)
- [$user->permissions()](https://getkirby.com/docs/reference/objects/cms/user/permissions.md)
- [$user->prev()](https://getkirby.com/docs/reference/objects/cms/user/prev.md)
- [$user->prevAll()](https://getkirby.com/docs/reference/objects/cms/user/prev-all.md)
- [$user->purge()](https://getkirby.com/docs/reference/objects/cms/user/purge.md)
- [$user->query()](https://getkirby.com/docs/reference/objects/cms/user/query.md)
- [$user->readContent()](https://getkirby.com/docs/reference/objects/cms/user/read-content.md)
- [$user->replaceAvatar()](https://getkirby.com/docs/reference/objects/cms/user/replace-avatar.md)
- [$user->role()](https://getkirby.com/docs/reference/objects/cms/user/role.md)
- [$user->roles()](https://getkirby.com/docs/reference/objects/cms/user/roles.md)
- [$user->root()](https://getkirby.com/docs/reference/objects/cms/user/root.md)
- [$user->save()](https://getkirby.com/docs/reference/objects/cms/user/save.md)
- [$user->secret()](https://getkirby.com/docs/reference/objects/cms/user/secret.md)
- [$user->siblings()](https://getkirby.com/docs/reference/objects/cms/user/siblings.md)
- [$user->site()](https://getkirby.com/docs/reference/objects/cms/user/site.md)
- [$user->storage()](https://getkirby.com/docs/reference/objects/cms/user/storage.md)
- [$user->toArray()](https://getkirby.com/docs/reference/objects/cms/user/to-array.md)
- [$user->toSafeString()](https://getkirby.com/docs/reference/objects/cms/user/to-safe-string.md)
- [$user->toString()](https://getkirby.com/docs/reference/objects/cms/user/to-string.md)
- [$user->translation()](https://getkirby.com/docs/reference/objects/cms/user/translation.md)
- [$user->translations()](https://getkirby.com/docs/reference/objects/cms/user/translations.md)
- [$user->update()](https://getkirby.com/docs/reference/objects/cms/user/update.md)
- [$user->username()](https://getkirby.com/docs/reference/objects/cms/user/username.md)
- [$user->uuid()](https://getkirby.com/docs/reference/objects/cms/user/uuid.md)
- [$user->validatePassword()](https://getkirby.com/docs/reference/objects/cms/user/validate-password.md)
- [$user->version()](https://getkirby.com/docs/reference/objects/cms/user/version.md)
- [$user->versions()](https://getkirby.com/docs/reference/objects/cms/user/versions.md)
- [$user->videos()](https://getkirby.com/docs/reference/objects/cms/user/videos.md)
- [$user->writeContent()](https://getkirby.com/docs/reference/objects/cms/user/write-content.md)

## How to create a `$user` object

Before you can call the methods of the User class, you need a `$user` object.

The `$user` object is available via the `$kirby` object:

### The current user

```php
$user = $kirby->user();
```

### A specific user by user id or email address
```php
$user = $kirby->user('you@yourdomain.com');
```

### The first user of the users collection
```php
$user = $kirby->users()->first();
```

<info>
Before calling any of the methods of the User class, verify that you have a valid User object.
</info>

## Examples

With the `$user` object in place, you can use the methods of the user class to get information about the user or modify the user object.

### Check if the user is an admin

```php
if ($user->isAdmin()) {
  echo "Hey, great, you can do anything you like!";
}
```

### Convert user object to array

```php
$userData = $user->toArray();
```

### Change the user name programmatically

```php
$user->changeName('new-name');
```

### Fetch all files belonging to the user object

```php
$userFiles = $user->files();
```

<info>
To keep the examples short, we don't [check if the (user) object exists](docs/cookbook/php/php-templates#and-one-last-trick) in the examples above. In your code, you should always do that.
</info>