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 elgg_request_new_password(\ElggUser $user): void {
    _elgg_services()->passwords->requestNewPassword($user);
}

function elgg_save_new_password(\ElggUser $user, string $conf_code, string $password = null): bool {
    return _elgg_services()->passwords->saveNewPassword($user, $conf_code, $password);
}

function elgg_generate_password(): string {
    return _elgg_services()->passwordGenerator->generatePassword();
}

function elgg_register_user(array $params = []): \ElggUser {
    return _elgg_services()->accounts->register($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 elgg_generate_invite_code(string $username): string {
    return _elgg_services()->usersTable->generateInviteCode($username);
}

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

function elgg_get_registration_url(array $parameters = [], $fragment = ''): string {
    $url = elgg_generate_url('account:register', $parameters) . $fragment;
    
    return (string) elgg_trigger_plugin_hook('registration_url', 'site', $parameters, $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);
}