Reference

Search

Text

KirbyText
Markdown

Templates

Field methods
Helpers

Panel

Blueprints
Presets
Fields
Sections
Icons
Samples

Objects

$asset
$file
$files
$kirby
$language
$languages
$page
$pages
$pagination
$request
$session
$site
$user
$users

Router

Patterns
Response types

System

Options
Urls
Roots
Validators

Plugins

Extensions
Hooks
Core components
UI Kit
Panel internals

API

Authentication
Languages
Pages
Roles
Site
System
Translations
Users

Tools

A
Cookie
Data
Dir
Escape
F
Header
Html
I18n
Mime
$query
Server
Str
Tpl
Url
V
Xml

Advanced

All classes
Aliases

new User()
Creates a new User object
$user->audio()
Filters the Files collection by type audio
$user->avatar()
Returns the File object for the avatar or null
$user->blueprint()
Returns the UserBlueprint object
$user->changeEmail()
Changes the user email address
$user->changeLanguage()
Changes the user language
$user->changeName()
Changes the screen name of the user
$user->changePassword()
Changes the user password
$user->changeRole()
Changes the user role
$user->clone()
Creates an instance with the same initial properties.
$user->code()
Filters the Files collection by type code
$user->content()
Returns the content
$user->contentFiles()
Returns an array with all content files
User::create()
Creates a new User from the given props and returns a new User object
$user->createFile()
Creates a new file
$user->createId()
Returns a random user id
$user->decrement()
Decrement a given field value
$user->delete()
Deletes the user
$user->documents()
Filters the Files collection by type documents
$user->email()
Returns the user email address
$user->errors()
Returns all content validation errors
$user->exists()
Checks if the user exists
$user->file()
Returns a specific file by filename or the first one
$user->files()
Returns the Files collection
$user->hardcopy()
Creates a clone and fetches all lazy-loaded getters to get a full copy
$user->hasAudio()
Checks if the Files collection has any audio files
$user->hasCode()
Checks if the Files collection has any code files
$user->hasDocuments()
Checks if the Files collection has any document files
$user->hasFiles()
Checks if the Files collection has any files
$user->hasImages()
Checks if the Files collection has any images
$user->hasNext()
Checks if there's a next item in the collection
$user->hasPrev()
Checks if there's a previous item in the collection
$user->hasVideos()
Checks if the Files collection has any videos
$user->id()
Returns the user id
$user->image()
Returns a specific image by filename or the first one
$user->images()
Filters the Files collection by type image
$user->increment()
Increment a given field value
$user->indexOf()
Returns the position / index in the collection
$user->inventory()
Returns the inventory of files children and content files
$user->is()
Compares the current object with the given user object
$user->isAdmin()
Checks if this user has the admin role
$user->isFirst()
Checks if the item is the first in the collection
$user->isKirby()
Checks if the current user is the virtual Kirby user
$user->isLast()
Checks if the item is the last in the collection
$user->isLastAdmin()
Checks if the user is the last one with the admin role
$user->isLastUser()
Checks if the user is the last user
$user->isLocked()
Checks if the model is locked for the current user
$user->isLoggedIn()
Checks if the current user is this user
$user->isNth()
Checks if the item is at a certain position
$user->isValid()
Checks if the data has any errors
$user->kirby()
Returns the parent Kirby instance
$user->language()
Returns the user language
$user->lock()
Returns the lock object for this model
$user->login()
Logs the user in
$user->loginPasswordless()
Logs the user in without checking the password
$user->logout()
Logs the user out
$user->modified()
Returns the last modification date of the user
$user->name()
Returns the user's name
$user->next()
Returns the next item in the collection if available
$user->nextAll()
Returns the end of the collection starting after the current item
$user->panelOptions()
Returns an array of all actions that can be performed in the Panel This also checks for the lock status
$user->panelPickerData()
Returns prepared data for the panel user picker
$user->password()
Returns the encrypted user password
$user->permissions()
$user->prev()
Returns the previous item in the collection if available
$user->prevAll()
Returns the beginning of the collection before the current item
$user->role()
Returns the user role
$user->root()
The absolute path to the user directory
$user->siblings()
Returns all sibling elements
$user->site()
Returns the parent Site instance
$user->toArray()
Converts the most important user properties to an array
$user->toString()
String template builder
$user->translation()
Returns a single translation by language code If no code is specified the current translation is returned
$user->translations()
Returns the translations collection
$user->update()
Updates the model data
$user->username()
Returns the username which is the given name or the email as a fallback
$user->validatePassword()
Compares the given password with the stored one
$user->videos()
Filters the Files collection by type videos

$user->name()

Returns the user's name

$user->name(): Kirby\Cms\Field

Return type

Kirby\Cms\Field

Source code

kirby/src/Cms/User.php#L538