Last updated May 4th, 2020 | Page history | Improve this page | Report an issue
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.
$292 per month—let's make that $500!Learn more
Fires before the login process is started for a user when logging in via a non-manager context. This event can be used to DENY the login process. By default it is denying the logging in.
To allow logging in when using this event please use:
$modx->event->output(true); // before Revo 2.3.0 you should use instead: $modx->event->_output = true;
- Service: 3 - Web Access Events
- Group: None
|username||The provided username.|
|password||The provided password.|
|attributes||An array of:|
|- & rememberme - Boolean set if user wants password to be remembered. Passed by reference|
|- & lifetime - The session cookie lifetime for this login. Passed by reference|
|- & loginContext - The context key this login is occurring in. Passed by reference|
|- & addContexts - Additional contexts in which the login is also occuring in. Passed by reference|
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.