sessions.php

Go to the documentation of this file.

<?php
use Elgg\Exceptions\LoginException;

function elgg_get_session() {
    return _elgg_services()->session;
}

function elgg_get_logged_in_user_entity() {
    return _elgg_services()->session->getLoggedInUser();
}

function elgg_get_logged_in_user_guid() {
    return _elgg_services()->session->getLoggedInUserGuid();
}

function elgg_is_logged_in() {
    return _elgg_services()->session->isLoggedIn();
}

function elgg_is_admin_logged_in() {
    return _elgg_services()->session->isAdminLoggedIn();
}

function elgg_set_cookie(\ElggCookie $cookie) {
    return _elgg_services()->responseFactory->setCookie($cookie);
}

function elgg_login(\ElggUser $user, bool $persistent = false): void {
    _elgg_services()->session->login($user, $persistent);
}

function elgg_logout(): bool {
    return _elgg_services()->session->logout();
}

function elgg_register_authentication_failure(\ElggUser $user): void {
    _elgg_services()->accounts->registerAuthenticationFailure($user);
}

function elgg_reset_authentication_failures(\ElggUser $user): void {
    _elgg_services()->accounts->resetAuthenticationFailures($user);
}

function elgg_is_authentication_failure_limit_reached(\ElggUser $user, int $limit = null, int $lifetime = null) {
    return _elgg_services()->accounts->isAuthenticationFailureLimitReached($user, $limit, $lifetime);
}

function elgg_get_login_forward_url(\ElggUser $user) {
    $session = _elgg_services()->session;
    if ($session->has('last_forward_from')) {
        $forward_url = $session->get('last_forward_from');
        $session->remove('last_forward_from');
        $forward_source = 'last_forward_from';
    } elseif (get_input('returntoreferer')) {
        $forward_url = REFERER;
        $forward_source = 'return_to_referer';
    } else {
        // forward to main index page
        $forward_url = '';
        $forward_source = null;
    }

    $params = [
        'user' => $user,
        'source' => $forward_source,
    ];

    return elgg_trigger_plugin_hook('login:forward', 'user', $params, $forward_url);
}