Users

Type: Class
Namespace: craft\services
Inherits: craft\services\Users » yii\base\Component » yii\base\BaseObject
Implements: yii\base\Configurable
Since: 3.0.0

The Users service provides APIs for managing users.

An instance of the service is available via Craft::$app->users.

Public Properties

Property	Description
behaviors	yii\base\Behavior – List of behaviors attached to this component.
verificationCodeOnUser	craft\elements\User – The user.

`verificationCodeOnUser`

Type: craft\elements\User
Default value: null
Access: Write-only

The user.

View source

Public Methods

Method	Description
__call()	Calls the named method which is not a class method.
__clone()	This method is called after the object is created by cloning an existing one.
__construct()	Constructor.
__get()	Returns the value of a component property.
__isset()	Checks if a property is set, i.e. defined and not null.
__set()	Sets the value of a component property.
__unset()	Sets a component property to be null.
activateUser()	Activates a user, bypassing email verification.
assignUserToDefaultGroup()	Assigns a user to the default user group(s).
assignUserToGroups()	Assigns a user to a given list of user groups.
attachBehavior()	Attaches a behavior to this component.
attachBehaviors()	Attaches a list of behaviors to the component.
behaviors()	Returns a list of behaviors that this component should behave as.
canCreateUsers()	Returns whether new users can be added to the system.
canGetProperty()	Returns a value indicating whether a property can be read.
canImpersonate()	Returns whether a user is allowed to impersonate another user.
canSetProperty()	Returns a value indicating whether a property can be set.
canSuspend()	Returns whether the user can suspend the given user
className()	Returns the fully qualified name of this class.
deactivateUser()	Deactivates a user.
deleteUserPhoto()	Deletes a user’s photo.
detachBehavior()	Detaches a behavior from the component.
detachBehaviors()	Detaches all behaviors from the component.
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.
ensureUserByEmail()	Returns a user by an email address, creating one if none already exists.
getActivationUrl()	Sets a new verification code on a user, and returns their activation URL.
getBehavior()	Returns the named behavior object.
getBehaviors()	Returns all behaviors attached to this component.
getDefaultUserGroups()	Returns the default user groups that the given user should belong to.
getEmailVerifyUrl()	Sets a new verification code on a user, and returns their new Email Verification URL.
getMaxUsers()	Returns the maximum number of users the system can have, for the given Craft edition.
getPasswordResetUrl()	Sets a new verification code on a user, and returns their new Password Reset URL.
getUserById()	Returns a user by their ID.
getUserByUid()	Returns a user by their UID.
getUserByUsernameOrEmail()	Returns a user by their username or email.
getUserPreference()	Returns one of a user’s preferences by its key.
getUserPreferences()	Returns a user’s preferences.
handleChangedUserFieldLayout()	Handle user field layout changes.
handleInvalidLogin()	Handles an invalid login for a user.
handleValidLogin()	Handles a valid login for a user.
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.
hasMethod()	Returns a value indicating whether a method is defined.
hasProperty()	Returns a value indicating whether a property is defined for this component.
hasUserShunnedMessage()	Returns whether a message is shunned for a user.
init()	Initializes the object.
isVerificationCodeValidForUser()	Returns whether a verification code is valid for the given user.
off()	Detaches an existing event handler from this component.
on()	Attaches an event handler to an event.
pruneDeletedField()
purgeExpiredPendingUsers()	Deletes any pending users that have shown zero sense of urgency and are just taking up space.
relocateUserPhoto()	Updates the location of a user’s photo.
removeCredentials()	Removes credentials for a user.
saveLayout()	Save the user field layout
saveUserPhoto()	Crops and saves a user’s photo.
saveUserPreferences()	Saves a user’s preferences.
sendActivationEmail()	Sends a new account activation email for a user, regardless of their status.
sendNewEmailVerifyEmail()	Sends a new email verification email to a user, regardless of their status.
sendPasswordResetEmail()	Sends a password reset email to a user.
setVerificationCodeOnUser()	Sets a new verification code on the user’s record.
shunMessageForUser()	Shuns a message for a user.
suspendUser()	Suspends a user.
trigger()	Triggers an event.
unlockUser()	Unlocks a user, bypassing the cooldown phase.
unshunMessageForUser()	Un-shuns a message for a user.
unsuspendUser()	Unsuspends a user.
verifyEmailForUser()	If 'unverifiedEmail' is set on the User, then this method will transfer it to the official email property and clear the unverified one.

`activateUser()`

Activates a user, bypassing email verification.

View source

Arguments

$user (craft\elements\User) – The user.

Throws

craft\errors\InvalidElementException

`assignUserToDefaultGroup()`

Assigns a user to the default user group(s).

This method is called toward the end of a public registration request.

View source

Arguments

$user (craft\elements\User) – The user that was just registered.

Returns

boolean – Whether the user was assigned to the default group.

`assignUserToGroups()`

Assigns a user to a given list of user groups.

View source

Arguments

$userId (integer) – The user’s ID
$groupIds (integer[]) – The groups’ IDs. Pass an empty array to remove a user from all groups.

Returns

boolean – Whether the users were successfully assigned to the groups.

`canCreateUsers()`

Since: 5.0.0

Returns whether new users can be added to the system.

View source

Returns

boolean

`canImpersonate()`

Since: 3.2.0

Returns whether a user is allowed to impersonate another user.

View source

Arguments

$impersonator (craft\elements\User)
$impersonatee (craft\elements\User)

Returns

boolean

`canSuspend()`

Since: 3.7.32

Returns whether the user can suspend the given user

View source

Arguments

$suspender (craft\elements\User)
$suspendee (craft\elements\User)

Returns

boolean

`deactivateUser()`

Since: 4.0.0

Deactivates a user.

View source

Arguments

$user (craft\elements\User) – The user.

Throws

Throwable
if reasons
craft\errors\InvalidElementException

`deleteUserPhoto()`

Deletes a user’s photo.

View source

Arguments

$user (craft\elements\User) – The user

Returns

boolean – Whether the user’s photo was deleted successfully

`ensureUserByEmail()`

Since: 4.0.0

Returns a user by an email address, creating one if none already exists.

View source

Arguments

$email (string)

Returns

craft\elements\User

Throws

yii\base\InvalidArgumentException
if $email is invalid
yii\base\Exception
if the user couldn’t be saved for some unexpected reason

`getActivationUrl()`

Sets a new verification code on a user, and returns their activation URL.

View source

`getDefaultUserGroups()`

Since: 4.5.4

Returns the default user groups that the given user should belong to.

View source

Arguments

$user (craft\elements\User)

Returns

craft\models\UserGroup[]

`getEmailVerifyUrl()`

Sets a new verification code on a user, and returns their new Email Verification URL.

View source

Arguments

$user (craft\elements\User) – The user that should get the new Email Verification URL.

Returns

string – The new Email Verification URL.

Throws

craft\errors\InvalidElementException
if the user doesn't validate

`getMaxUsers()`

Since: 5.5.0

Returns the maximum number of users the system can have, for the given Craft edition.

View source

Arguments

$edition (\craft\enums\CmsEdition)

Returns

integer, null

`getPasswordResetUrl()`

Sets a new verification code on a user, and returns their new Password Reset URL.

View source

Arguments

$user (craft\elements\User) – The user that should get the new Password Reset URL

Returns

string – The new Password Reset URL.

Throws

craft\errors\InvalidElementException
if the user doesn't validate

`getUserById()`

Returns a user by their ID.

php

$user = Craft::$app->users->getUserById($userId);

View source

Arguments

$userId (integer) – The user’s ID.

Returns

craft\elements\User, null – The user with the given ID, or null if a user could not be found.

`getUserByUid()`

Returns a user by their UID.

php

$user = Craft::$app->users->getUserByUid($userUid);

View source

Arguments

$uid (string) – The user’s UID.

Returns

craft\elements\User, null – The user with the given UID, or null if a user could not be found.

`getUserByUsernameOrEmail()`

Returns a user by their username or email.

php

$user = Craft::$app->users->getUserByUsernameOrEmail($loginName);

View source

Arguments

$usernameOrEmail (string) – The user’s username or email.

Returns

craft\elements\User, null – The user with the given username/email, or null if a user could not be found.

`getUserPreference()`

Returns one of a user’s preferences by its key.

View source

Arguments

$userId (integer) – The user’s ID
$key (string) – The preference’s key
$default (mixed) – The default value, if the preference hasn’t been set

Returns

mixed – The user’s preference

`getUserPreferences()`

Returns a user’s preferences.

View source

Arguments

$userId (integer) – The user’s ID

Returns

array – The user’s preferences

`handleChangedUserFieldLayout()`

Handle user field layout changes.

View source

Arguments

$event (craft\events\ConfigEvent)

`handleInvalidLogin()`

Handles an invalid login for a user.

View source

Arguments

$user (craft\elements\User) – The user

`handleValidLogin()`

Handles a valid login for a user.

View source

Arguments

$user (craft\elements\User) – The user

`hasUserShunnedMessage()`

Returns whether a message is shunned for a user.

View source

Arguments

$userId (integer) – The user’s ID.
$message (string) – The message to check.

Returns

boolean – Whether the user has shunned the message.

`isVerificationCodeValidForUser()`

Returns whether a verification code is valid for the given user.

This method first checks if the code has expired past the config5:verificationCodeDuration config setting. If it is still valid, then, the checks the validity of the contents of the code.

View source

Arguments

$user (craft\elements\User) – The user to check the code for.
$code (string) – The verification code to check for.

Returns

boolean – Whether the code is still valid.

`pruneDeletedField()`

DEPRECATED

Deprecated in 4.0.5. Unused fields will be pruned automatically as field layouts are resaved.

View source

`purgeExpiredPendingUsers()`

Deletes any pending users that have shown zero sense of urgency and are just taking up space.

This method will check the config5:purgePendingUsersDuration config setting, and if it is set to a valid duration, it will delete any user accounts that were created that duration ago, and have still not activated their account.

View source

`relocateUserPhoto()`

Since: 3.5.14

Updates the location of a user’s photo.

View source

Arguments

$user (craft\elements\User)

`removeCredentials()`

Since: 4.0.0

Removes credentials for a user.

View source

Arguments

$user (craft\elements\User) – The user that should have credentials removed.

Throws

craft\errors\InvalidElementException

`saveLayout()`

Save the user field layout

View source

Arguments

$layout (craft\models\FieldLayout)
$runValidation (boolean) – Whether the layout should be validated

Returns

boolean

`saveUserPhoto()`

Crops and saves a user’s photo.

View source

Arguments

$fileLocation (string) – The local image path on server
$user (craft\elements\User) – The user.
$filename (string, null) – Name of the file to use, defaults to filename of $fileLocation

Throws

craft\errors\ImageException
if the file provided is not a manipulatable image
craft\errors\VolumeException
if the user photo volume is not provided or is invalid

`saveUserPreferences()`

Saves a user’s preferences.

View source

Arguments

$user (craft\elements\User) – The user
$preferences (array) – The user’s new preferences

`sendActivationEmail()`

Sends a new account activation email for a user, regardless of their status.

A new verification code will generated for the user overwriting any existing one.

View source

Arguments

$user (craft\elements\User) – The user to send the activation email to.

Returns

boolean – Whether the email was sent successfully.

Throws

craft\errors\InvalidElementException
if the user doesn't validate

`sendNewEmailVerifyEmail()`

Sends a new email verification email to a user, regardless of their status.

A new verification code will generated for the user overwriting any existing one.

View source

Arguments

$user (craft\elements\User) – The user to send the activation email to.

Returns

boolean – Whether the email was sent successfully.

Throws

craft\errors\InvalidElementException
if the user doesn't validate

`sendPasswordResetEmail()`

Sends a password reset email to a user.

A new verification code be will generated for the user, overwriting any existing one.

View source

Arguments

$user (craft\elements\User) – The user to send the forgot password email to.

Returns

boolean – Whether the email was sent successfully.

Throws

craft\errors\InvalidElementException
if the user doesn't validate

`setVerificationCodeOnUser()`

Sets a new verification code on the user’s record.

View source

Arguments

$user (craft\elements\User) – The user.

Returns

string – The user’s brand new verification code.

Throws

craft\errors\InvalidElementException
if the user doesn't validate

`shunMessageForUser()`

Shuns a message for a user.

View source

Arguments

$userId (integer) – The user’s ID.
$message (string) – The message to be shunned.
$expiryDate (DateTime, null) – When the message should be un-shunned. Defaults to null (never un-shun).