users.php

Go to the documentation of this file.

<?php
use Elgg\Exceptions\InvalidParameterException;
use Elgg\Exceptions\ClassException;
use Elgg\Exceptions\Configuration\RegistrationException;

function get_user($guid) {
    try {
        return _elgg_services()->entityTable->get($guid, 'user');
    } catch (InvalidParameterException $ex) {
        elgg_log($ex, 'ERROR');

        return false;
    } catch (ClassException $ex) {
        elgg_log($ex, 'ERROR');

        return false;
    }
}

function get_user_by_username($username) {
    return _elgg_services()->usersTable->getByUsername($username);
}

function get_user_by_email($email) {
    return _elgg_services()->usersTable->getByEmail($email);
}

function find_active_users(array $options = []) {
    return _elgg_services()->usersTable->findActive($options);
}

function get_online_users(array $options = []) {
    $options = array_merge([
        'seconds' => 600,
    ], $options);

    return elgg_list_entities($options, 'find_active_users');
}

function send_new_password_request($user_guid) {
    return _elgg_services()->passwords->sendNewPasswordRequest($user_guid);
}

function force_user_password_reset($user_guid, $password) {
    return _elgg_services()->passwords->forcePasswordReset($user_guid, $password);
}

function execute_new_password_request($user_guid, $conf_code, $password = null) {
    return _elgg_services()->passwords->executeNewPasswordReset($user_guid, $conf_code, $password);
}

function generate_random_cleartext_password() {
    return _elgg_services()->passwordGenerator->generatePassword();
}

function register_user($username, $password, $name, $email, $allow_multiple_emails = false, $subtype = null, array $params = []) {
    return _elgg_services()->accounts->register($username, $password, $name, $email, $allow_multiple_emails, $subtype, $params);
}

function elgg_validate_registration_data($username, $password, $name, $email, $allow_multiple_emails = false) {
    return _elgg_services()->accounts->validateAccountData($username, $password, $name, $email, $allow_multiple_emails);
}

function generate_invite_code($username) {
    return _elgg_services()->usersTable->generateInviteCode($username);
}

function elgg_validate_invite_code($username, $code) {
    return _elgg_services()->usersTable->validateInviteCode($username, $code);
}

function elgg_get_registration_url(array $query = [], $fragment = '') {
    $url = elgg_generate_url('account:register');
    $url = elgg_http_add_url_query_elements($url, $query) . $fragment;
    return elgg_trigger_plugin_hook('registration_url', 'site', $query, $url);
}

function elgg_get_login_url(array $query = [], $fragment = '') {
    $url = elgg_generate_url('account:login');
    $url = elgg_http_add_url_query_elements($url, $query) . $fragment;
    return elgg_trigger_plugin_hook('login_url', 'site', $query, $url);
}

function elgg_get_user_by_persistent_token(string $token): ?\ElggUser {
    return _elgg_services()->persistentLogin->getUserFromToken($token);
}