Skip to content

AuthenticateUserEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\AuthenticateUserEvent » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.0.0

Authenticate User event class.

View source

Public Properties

PropertyDescription
datamixed – The data that is passed to yii\base\Component::on() when attaching an event handler.
handledboolean – Whether the event is handled.
namestring – The event name.
passwordstring, null – The password that was submitted, or null if a passkey is being used.
performAuthenticationboolean – Whether authentication should continue.
senderobject, null – The sender of this event.

password

Type
string, null
Default value
null

The password that was submitted, or null if a passkey is being used.

View source

performAuthentication

Type
boolean
Default value
true

Whether authentication should continue. If not, and the user doesn’t authenticate, set $event->sender->authError to something, to prevent Craft from considering the user to be authenticated.

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.
trigger()Triggers a class-level event.