OnWebAuthentication
Last updated Jun 6th, 2019 | 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.
Backers
Budget
$194 per month—let's make that $500!
Learn moreEvent: OnWebAuthentication¶
Fires right before the user is authenticated or their session is added for any non-mgr context. Use it to allow login without the password check, for example in external authentication.
If the output is true, MODX treats the user as logged in and skips the password check. An array counts as true when at least one of its indexes is true.
- Service: 3 - Web Access Service Events
- Group: Security
Event Parameters¶
| Name | Description |
|---|---|
| & user | A reference to the modUser object. Passed by reference |
| password | The provided password. |
| rememberme | Whether or not to remember the user via cookie. |
| lifetime | The lifetime of the session cookie. |
| & loginContext | The context key this login is occurring in. Passed by reference |
| & addContexts | Additional contexts in which the login also occurs. Passed by reference |
Event Login Workflow¶
-
OnBeforeWebLogin || OnBeforeManagerLogin — a non-
trueoutput aborts the login with that message. -
OnUserNotFound — runs only when the username is missing from the MODX database. A Plugin may supply its own
modUserto continue. -
OnWebAuthentication || OnManagerAuthentication — overrides the default password check. A
trueoutput marks the user as verified and logged in. - OnWebLogin || OnManagerLogin — fires after the login has finished. It does not change the login outcome.
See Also¶
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.
Backers
Budget
$194 per month—let's make that $500!
Learn more