OnWebLogin

Event: OnWebLogin¶

Fires after a user passes authentication for a non-mgr context and session contexts are added. Plugins cannot change whether the login succeeds.

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

Event Parameters¶

$modx->getUser() during OnWebLogin¶

The login processor adds session contexts before it invokes OnWebLogin. The user is logged in at the session level.

For web contexts it does not refresh $modx->user before the event. $modx->getUser() often still returns the previous user object from the request (anonymous / id 0, or whatever was already cached). That is why $modx->getUser() looks “wrong” here even though login succeeded.

Use the event $user parameter (or $scriptProperties['user']) for the authenticated user. If you need $modx->getUser() to match, clear and reload after the session exists:

$modx->user = null;
$modx->getUser($attributes['loginContext'], true);

On manager login the processor does refresh $modx->user before OnManagerLogin. That refresh does not run for web/OnWebLogin.

Event Login Workflow¶

1. OnBeforeWebLogin || OnBeforeManagerLogin — plugins can abort login by returning a value other than true.
2. OnUserNotFound — runs only when the username is missing from the MODX database. A plugin may supply its own modUser to continue.
3. OnWebAuthentication || OnManagerAuthentication — plugins can override the default password check. Returning true marks the user as authenticated.
4. OnWebLogin || OnManagerLogin — runs after session contexts are added. Does not change login success or failure. On web, prefer the $user event parameter over $modx->getUser() (see above).

Example¶

Log who logged in and with which attributes:

<?php
$eventName = $modx->event->name;
switch ($eventName) {
    case 'OnWebLogin':
        $name = $user->get('username');
        $modx->log(modX::LOG_LEVEL_ERROR, 'User logged in: ' . $name . ' ' . print_r($attributes, true));
        break;
}

See Also¶

• System Events
• Plugins
• OnManagerLogin