OnBeforeWebLogin

Event: OnBeforeWebLogin¶

Fires before a user logs in via a non-Manager Context. By default the login continues. To deny it, the Plugin must set a non-empty event output other than true, usually an error message:

// block the login and pass the reason
$modx->event->output('Login is not allowed.');

The login aborts and shows that message. If no Plugin sets the output, or the output is true, the login proceeds. A value returned from Plugin code does not block the login; it goes to the error log.

• Service: 3 - Web Access Service Events
• Group: Security

Event Parameters¶

Event Login Workflow¶

1. OnBeforeWebLogin || OnBeforeManagerLogin — block the login here (see above).
2. OnUserNotFound — runs only if the username is not found in the MODX database. Provide your own modUser in the event output to continue the login.
3. OnWebAuthentication || OnManagerAuthentication — override the default password check here. A Plugin returning true marks the user as verified and logged in.
4. OnWebLogin || OnManagerLogin — fires after the login finishes; it does not change login behavior.

See Also¶

• System Events
• Plugins