OnWebLogout

Last updated Sep 18th, 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.

Backers

Budget

$311 per month—let's make that $500!

Learn more

Event: OnWebLogout¶

Fires right after the user logs out of a context and their context session is removed.

Service: 3 - Web Access Events
Group: None

Event Parameters¶

Name	Description
& user	A reference to the modUser object of the user. Passed by reference
userid	The user ID of the user. (deprecated)
username	The username of the user. (deprecated)
& loginContext	The context key this logout is occurring in. Passed by reference
& addContexts	Additional contexts in which the logout is also occuring in. Passed by reference

Example¶

Such a plugin will display in the "Error log" who logged out and where:

<?php
$eventName = $modx->event->name;
switch($eventName) {
    case 'OnWebLogout':
        $id = $user->get('id');
        $modx->log(modX::LOG_LEVEL_ERROR, 'User with id logged out '.$id.' out of context '.$loginContext.' and these more '.print_r($addContexts));
        break;
}

OnWebLogout

Event: OnWebLogout¶

Event Parameters¶

Example¶

See Also¶