Craft 4 Class Reference

Appearance

UsersController ​

Type
Class
Namespace
craft\controllers
Inherits
craft\controllers\UsersController » craft\web\Controller » yii\web\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable, yii\base\ViewContextInterface
Since
3.0.0

The UsersController class is a controller that handles various user account related tasks such as logging-in, impersonating a user, logging out, forgetting passwords, setting passwords, validating accounts, activating accounts, creating users, saving users, processing user avatars, deleting, suspending and unsuspending users.

Note that all actions in the controller, except actionLogin(), actionLogout(), \craft\controllers\actionGetRemainingSessionTime, actionSendPasswordResetEmail(), actionSetPassword(), actionVerifyEmail() and actionSaveUser() require an authenticated Craft session via allowAnonymous.

View source

Public Properties ​

PropertyDescription
actionyii\base\Action, null – The action that is currently being executed.
actionParamsarray – The parameters bound to the current action.
behaviorsyii\base\Behavior – List of behaviors attached to this component.
defaultActionstring – The ID of the action that is used when the action ID is not specified in the request.
enableCsrfValidationboolean – Whether to enable CSRF validation for the actions in this controller.
idstring – The ID of this controller.
layoutstring, null, false – The name of the layout to be applied to this controller's views.
moduleyii\base\Module – The module that this controller belongs to.
modulesyii\base\Module – All ancestor modules that this controller is located within.
requestcraft\web\Request
responsecraft\web\Response
routestring – The route (module ID, controller ID and action ID) of the current request.
uniqueIdstring – The controller ID that is prefixed with the module ID (if any).
viewcraft\web\View – The view object that can be used to render views or view files
viewPathstring – The directory containing the view files for this controller.

Protected Properties ​

PropertyDescription
allowAnonymousinteger, boolean, integer[], string[] – Whether this controller’s actions can be accessed anonymously.

allowAnonymous ​

Type
integer, boolean, integer[], string[]
Default value
[ 'get-remaining-session-time' => self::ALLOW_ANONYMOUS_LIVE | self::ALLOW_ANONYMOUS_OFFLINE, 'session-info' => self::ALLOW_ANONYMOUS_LIVE | self::ALLOW_ANONYMOUS_OFFLINE, 'login' => self::ALLOW_ANONYMOUS_LIVE | self::ALLOW_ANONYMOUS_OFFLINE, 'logout' => self::ALLOW_ANONYMOUS_LIVE | self::ALLOW_ANONYMOUS_OFFLINE, 'impersonate-with-token' => self::ALLOW_ANONYMOUS_LIVE | self::ALLOW_ANONYMOUS_OFFLINE, 'save-user' => self::ALLOW_ANONYMOUS_LIVE, 'send-activation-email' => self::ALLOW_ANONYMOUS_LIVE | self::ALLOW_ANONYMOUS_OFFLINE, 'send-password-reset-email' => self::ALLOW_ANONYMOUS_LIVE | self::ALLOW_ANONYMOUS_OFFLINE, 'set-password' => self::ALLOW_ANONYMOUS_LIVE | self::ALLOW_ANONYMOUS_OFFLINE, 'verify-email' => self::ALLOW_ANONYMOUS_LIVE | self::ALLOW_ANONYMOUS_OFFLINE, ]

Whether this controller’s actions can be accessed anonymously.

This can be set to any of the following:

  • false or self::ALLOW_ANONYMOUS_NEVER (default) – indicates that all controller actions should never be accessed anonymously
  • true or self::ALLOW_ANONYMOUS_LIVE – indicates that all controller actions can be accessed anonymously when the system is live
  • self::ALLOW_ANONYMOUS_OFFLINE – indicates that all controller actions can be accessed anonymously when the system is offline
  • self::ALLOW_ANONYMOUS_LIVE | self::ALLOW_ANONYMOUS_OFFLINE – indicates that all controller actions can be accessed anonymously when the system is live or offline
  • An array of action IDs (e.g. ['save-guest-entry', 'edit-guest-entry']) – indicates that the listed action IDs can be accessed anonymously when the system is live
  • An array of action ID/bitwise pairs (e.g. ['save-guest-entry' => self::ALLOW_ANONYMOUS_OFFLINE] – indicates that the listed action IDs can be accessed anonymously per the bitwise int assigned to it.

View source

Public Methods ​

MethodDescription
__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()
__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.
actionActivateUser()Manually activates a user account. Only admins have access.
actionDeactivateUser()Deactivates a user.
actionDeleteAddress()Deletes a user’s address.
actionDeleteUser()Deletes a user.
actionDeleteUserPhoto()Delete all the photos for current user.
actionEditUser()Edit a user account.
actionEnableUser()Enables a user that is currently disabled or archived.
actionGetElevatedSessionTimeout()Returns how many seconds are left in the current elevated user session.
actionGetImpersonationUrl()Generates and returns a new impersonation URL
actionGetPasswordResetUrl()Generates a new verification code for a given user, and returns its URL.
actionImpersonate()Logs a user in for impersonation.
actionImpersonateWithToken()Logs a user in for impersonation via an impersonation token.
actionLogin()Displays the login template, and handles login post requests.
actionLogout()
actionMarkAnnouncementsAsRead()Marks the user’s feature announcements as read.
actionSaveAddress()Saves a user’s address.
actionSaveFieldLayout()Saves the user field layout.
actionSaveUser()Provides an endpoint for saving a user account.
actionSendActivationEmail()Sends a new activation email to a user.
actionSendPasswordResetEmail()Sends a password reset email.
actionSessionInfo()Returns information about the current user session, if any.
actionSetPassword()Sets a user’s password once they’ve verified they have access to their email.
actionStartElevatedSession()Starts an elevated user session.
actionSuspendUser()Suspends a user.
actionUnlockUser()Unlocks a user, bypassing the cooldown phase.
actionUnsuspendUser()Unsuspends a user.
actionUploadUserPhoto()Upload a user photo.
actionUserContentSummary()Returns a summary of the content that is owned by a given user ID(s).
actionVerifyEmail()Verifies that a user has access to an email address.
actionVerifyPassword()Verifies a password for a user.
actions()Declares external actions for the controller.
afterAction()This method is invoked right after an action is executed.
asCpScreen()Sends a control panel screen response.
asErrorJson()Responds to the request with a JSON error message.
asFailure()Sends a failure response.
asJson()Send data formatted as JSON.
asJsonP()Sets the response format of the given data as JSONP.
asModelFailure()
asModelSuccess()
asRaw()Sets the response format of the given data as RAW.
asSuccess()Sends a success response.
asXml()Send data formatted as XML.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
beforeAction()This method is invoked right before an action is executed.
behaviors()Returns a list of behaviors that this component should behave as.
bindActionParams()Binds the parameters to the action.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
createAction()Creates an action based on the given action ID.
currentUser()Returns the currently logged-in user.
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.
findLayoutFile()Finds the applicable layout file.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getModules()Returns all ancestor modules of this controller.
getRoute()Returns the route of the current request.
getUniqueId()Returns the unique ID of the controller.
getView()Returns the view object that can be used to render views or view files
getViewPath()Returns the directory containing view files for this controller.
goBack()Redirects the browser to the last visited page.
goHome()Redirects the browser to the home page.
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.
init()Initializes the object.
off()Detaches an existing event handler from this component.
on()Attaches an event handler to an event.
redirect()Redirects the browser to the specified URL.
redirectToPostedUrl()Redirects to the URI specified in the POST.
refresh()Refreshes the current page.
render()Renders a view and applies layout if available.
renderAjax()Renders a view in response to an AJAX request.
renderContent()Renders a static string by applying a layout.
renderFile()Renders a view file.
renderPartial()Renders a view without applying layout.
renderTemplate()Sends a rendered template response.
requireAcceptsJson()Throws a 400 error if the request doesn't accept JSON.
requireAdmin()Throws a 403 error if the current user is not an admin.
requireAuthorization()Checks whether the current user can perform a given action, and ends the request with a 403 error if they don’t.
requireCpRequest()Throws a 400 error if the current request isn’t a control panel request.
requireElevatedSession()Requires that the user has an elevated session.
requireGuest()Redirects the user to the account template if they are logged in.
requireLogin()Redirects the user to the login template if they're not logged in.
requirePermission()Checks whether the current user has a given permission, and ends the request with a 403 error if they don’t.
requirePostRequest()Throws a 400 error if this isn’t a POST request
requireSiteRequest()Throws a 400 error if the current request isn’t a site request.
requireToken()Throws a 400 error if the current request doesn’t have a valid Craft token.
run()Runs a request specified in terms of a route.
runAction()Runs an action within this controller with the specified action ID and parameters.
setFailFlash()Sets an error flash message on the user session.
setSuccessFlash()Sets a success flash message on the user session.
setView()Sets the view object to be used by this controller.
setViewPath()Sets the directory that contains the view files.
trigger()Triggers an event.

actionActivateUser() ​

Manually activates a user account. Only admins have access.

View source

Returns ​

yii\web\Response

actionDeactivateUser() ​

Since
4.0.0

Deactivates a user.

View source

Returns ​

yii\web\Response, null

actionDeleteAddress() ​

Since
4.0.0

Deletes a user’s address.

View source

Returns ​

yii\web\Response, null

actionDeleteUser() ​

Deletes a user.

View source

Returns ​

yii\web\Response, null

actionDeleteUserPhoto() ​

Delete all the photos for current user.

View source

Returns ​

yii\web\Response

Throws ​

actionEditUser() ​

Edit a user account.

View source

Arguments ​

  • $userId (integer, string, null) – The user’s ID, if any, or a string that indicates the user to be edited ('current' or 'client').
  • $user (craft\elements\User, null) – The user being edited, if there were any validation errors.
  • $errors (array, null) – Any errors that occurred as a result of the previous action.

Returns ​

yii\web\Response

Throws ​

actionEnableUser() ​

Since
4.3.2

Enables a user that is currently disabled or archived.

View source

Returns ​

yii\web\Response, null

actionGetElevatedSessionTimeout() ​

Returns how many seconds are left in the current elevated user session.

View source

Returns ​

yii\web\Response

actionGetImpersonationUrl() ​

Since
3.6.0

Generates and returns a new impersonation URL

View source

Returns ​

yii\web\Response

Throws ​

actionGetPasswordResetUrl() ​

Generates a new verification code for a given user, and returns its URL.

View source

Returns ​

yii\web\Response

Throws ​

actionImpersonate() ​

Logs a user in for impersonation.

View source

Returns ​

yii\web\Response, null

Throws ​

actionImpersonateWithToken() ​

Since
3.6.0

Logs a user in for impersonation via an impersonation token.

View source

Arguments ​

Returns ​

yii\web\Response, null

Throws ​

actionLogin() ​

Displays the login template, and handles login post requests.

View source

Returns ​

yii\web\Response, null

Throws ​

actionLogout() ​

View source

Returns ​

yii\web\Response

actionMarkAnnouncementsAsRead() ​

Marks the user’s feature announcements as read.

View source

Returns ​

yii\web\Response

actionSaveAddress() ​

Since
4.0.0

Saves a user’s address.

View source

Returns ​

yii\web\Response, null

Throws ​

actionSaveFieldLayout() ​

Saves the user field layout.

View source

Returns ​

yii\web\Response, null

actionSaveUser() ​

Provides an endpoint for saving a user account.

This action accounts for the following scenarios:

  • An admin registering a new user account.
  • An admin editing an existing user account.
  • A normal user with user-administration permissions registering a new user account.
  • A normal user with user-administration permissions editing an existing user account.
  • A guest registering a new user account ("public registration"). This action behaves the same regardless of whether it was requested from the control panel or the front-end site.

View source

Returns ​

yii\web\Response, null

Throws ​

actionSendActivationEmail() ​

Sends a new activation email to a user.

View source

Returns ​

yii\web\Response, null

Throws ​

actionSendPasswordResetEmail() ​

Sends a password reset email.

View source

Returns ​

yii\web\Response, null

Throws ​

actionSessionInfo() ​

Since
3.4.0

Returns information about the current user session, if any.

View source

Returns ​

yii\web\Response

actionSetPassword() ​

Sets a user’s password once they’ve verified they have access to their email.

View source

Returns ​

yii\web\Response

actionStartElevatedSession() ​

Starts an elevated user session.

View source

Returns ​

yii\web\Response, null

actionSuspendUser() ​

Suspends a user.

View source

Returns ​

yii\web\Response, null

Throws ​

actionUnlockUser() ​

Unlocks a user, bypassing the cooldown phase.

View source

Returns ​

yii\web\Response

Throws ​

actionUnsuspendUser() ​

Unsuspends a user.

View source

Returns ​

yii\web\Response, null

Throws ​

actionUploadUserPhoto() ​

Upload a user photo.

View source

Returns ​

yii\web\Response, null

Throws ​

actionUserContentSummary() ​

Since
3.0.13

Returns a summary of the content that is owned by a given user ID(s).

View source

Returns ​

yii\web\Response

actionVerifyEmail() ​

Verifies that a user has access to an email address.

View source

Returns ​

yii\web\Response

actionVerifyPassword() ​

Verifies a password for a user.

View source

Returns ​

yii\web\Response, null

asModelFailure() ​

View source

Arguments ​

  • $model
  • $message
  • $modelName
  • $data
  • $routeParams

asModelSuccess() ​

View source

Arguments ​

  • $model
  • $message
  • $modelName
  • $data
  • $redirect

beforeAction() ​

This method is invoked right before an action is executed.

The method will trigger the EVENT_BEFORE_ACTION event. The return value of the method will determine whether the action should continue to run.

In case the action should not run, the request should be handled inside of the beforeAction code by either providing the necessary output or redirecting the request. Otherwise the response will be empty.

If you override this method, your code should look like the following:

php
public function beforeAction($action): bool
{
    // your custom code here, if you want the code to run before action filters,
    // which are triggered on the [EVENT_BEFORE_ACTION](https://www.yiiframework.com/doc/api/2.0/yii-base-controller#EVENT_BEFORE_ACTION-detail) event, e.g. PageCache or AccessControl

    if (!parent::beforeAction($action)) {
        return false;
    }

    // other custom code here

    return true; // or false to not run the action
}

View source

Arguments ​

Returns ​

boolean – Whether the action should continue to run.

Throws ​

Protected Methods ​

MethodDescription
bindInjectedParams()Fills parameters based on types and names in action method signature.
defineBehaviors()Returns the behaviors to attach to this class.
getPostedRedirectUrl()Gets the redirect param specified in the POST data.

Constants ​

ConstantDescription
ALLOW_ANONYMOUS_LIVE
ALLOW_ANONYMOUS_NEVER
ALLOW_ANONYMOUS_OFFLINE

Events ​

EVENT_AFTER_ASSIGN_GROUPS_AND_PERMISSIONS ​

Type
craft\events\UserEvent
Since
3.5.13

The event that is triggered after user groups and permissions have been assigned to the user getting saved

EVENT_AFTER_FIND_LOGIN_USER ​

Type
craft\events\FindLoginUserEvent
Since
4.2.0

The event that is triggered after attempting to find a user to sign in

EVENT_BEFORE_ASSIGN_GROUPS_AND_PERMISSIONS ​

Type
craft\events\UserEvent
Since
3.5.13

The event that is triggered BEFORE user groups and permissions ARE assigned to the user getting saved

EVENT_BEFORE_FIND_LOGIN_USER ​

Type
craft\events\FindLoginUserEvent
Since
4.2.0

The event that is triggered before attempting to find a user to sign in

php
use Craft;
use craft\controllers\UsersController;
use craft\elements\User;
use craft\events\FindLoginUserEvent;
use yii\base\Event;

Event::on(
    UsersController::class,
    UsersController::EVENT_BEFORE_FIND_LOGIN_USER,
    function(FindLoginUserEvent $event) {
        // force username-based login
        $event->user = User::find()
            ->username($event->loginName)
            ->addSelect(['users.password', 'users.passwordResetRequired'])
            ->one();
    }
);



---



### EVENT_DEFINE_CONTENT_SUMMARY



Type
:  [craft\events\DefineUserContentSummaryEvent](craft-events-defineusercontentsummaryevent.md)

Since
:  3.0.13



The event that is triggered when defining a summary of content owned by a user(s), before they are deleted





---

#### Example

::: code
```php
use craft\controllers\UsersController;
use craft\events\DefineUserContentSummaryEvent;
use yii\base\Event;

Event::on(UsersController::class, UsersController::EVENT_DEFINE_CONTENT_SUMMARY, function(DefineUserContentSummaryEvent $e) {
    $e->contentSummary[] = 'A pair of sneakers';
});

:::

EVENT_INVALID_USER_TOKEN ​

Type
craft\events\InvalidUserTokenEvent
Since
3.6.5

The event that is triggered when an invalid user token is sent.

EVENT_LOGIN_FAILURE ​

Type
craft\events\LoginFailureEvent

The event that is triggered when a failed login attempt was made

EVENT_REGISTER_USER_ACTIONS ​

Type
craft\events\RegisterUserActionsEvent

The event that is triggered when a user’s available actions are being registered