Support the team building MODX with a monthly donation.
The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.
$305 per month—let's make that $500!Learn more
Fires when a user is not found during login.
Can be used to provide external authentication by returning an array, where one of the indexes in the array is an instance of (or extending) a modUser object.
- Service: 6 - User Defined Events
- Group: modUser
|username||The specified username.|
|password||The specified password.|
|attributes||An array of: - rememberme - Boolean set if user wants password to be remembered.|
|lifetime }||The session cookie lifetime for this login.|
|loginContext||The context key this login is occurring in.|
|addContexts||Additional contexts in which the login is also occuring in.|
Event Login Workflow¶
- OnBeforeWebLogin || OnBeforeManagerLogin - Inside this event the developer can check for erroneous parameters which will disallow further logging in process. If plugins executed by this event return something except true, the logging in will be aborted with the specified error.
- OnUserNotFound - This event is executed only if the provided username is not found inside MODX database. The developer can provide it's own modUser object in the event output to continue the login process.
- OnWebAuthentication || OnManagerAuthentication - Inside this event the developer can check for parameters which will override the default checking by password and allow further logging in process. If one of the plugins executed from this event return true, the user is considered verified and logged in.
- OnWebLogin || OnManagerLogin - This event is fired after the logging in process has finished and the user is considered logged in. It doesn't change the logging in process behaviour.