Skip to content

DefineEditUserScreensEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\DefineEditUserScreensEvent » craft\base\Event » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Since
4.0.0

Class DefineEditUserScreensEvent

View source

Public Properties

PropertyDescription
currentUsercraft\elements\User – The currently logged-in user
datamixed – The data that is passed to yii\base\Component::on() when attaching an event handler.
editedUsercraft\elements\User – The user being edited.
handledboolean – Whether the event is handled.
namestring – The event name.
screensarray<string,array> – The screens that should be shown for the user being edited.
senderobject, null – The sender of this event.

currentUser

Type
craft\elements\User
Default value
null

The currently logged-in user

View source

editedUser

Type
craft\elements\User
Default value
null

The user being edited.

View source

screens

Type
array<string,array>
Default value
null

The screens that should be shown for the user being edited.

Each screen should be represented by a sub-array whose key is the screen ID, and which has the following keys:

  • label – The screen’s nav item label.
  • url – The screen’s URL (optional; a URL like myaccount/screen-key or users/x/screen-key will be used by default).

View source

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to null.
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.
hasHandlers()Returns a value indicating whether there is any handler attached to the specified class-level event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the object.
off()Detaches an event handler from a class-level event.
offAll()Detaches all registered class-level event handlers.
on()Attaches an event handler to a class-level event.
once()Attaches an event handler to a class-level event, which will be triggered at most one time.
trigger()Triggers a class-level event.