LoginFailureEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\LoginFailureEvent » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.0

LoginFailureEvent class.

View source

Public Properties

PropertyDescription
authErrorstring, null – The authentication error key, if the reason is known.
datamixed – The data that is passed to \craft\events\Component::on() when attaching an event handler.
handledboolean – Whether the event is handled.
messagestring – The error message that will be presented to the user.
namestring – The event name.
senderobject – The sender of this event.
usercraft\elements\User, null – The user that the login was attempted for, if there was a username/email match

authError

Type
string, null

The authentication error key, if the reason is known.

See also craft\elements\User

View source

message

Type
string

The error message that will be presented to the user.

View source

user

Type
craft\elements\User, null

The user that the login was attempted for, if there was a username/email match

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.