users.php

Go to the documentation of this file.

<?php
function get_user(int $guid): ?\ElggUser {
    $result = _elgg_services()->entityTable->get($guid, 'user');
    
    return $result instanceof \ElggUser ? $result : null;
}

function elgg_get_user_by_username(string $username, bool $try_email = false): ?\ElggUser {
    if (empty($username)) {
        return null;
    }
    
    if ($try_email && elgg_is_valid_email($username)) {
        $user = elgg_get_user_by_email($username);
        if ($user instanceof \ElggUser) {
            return $user;
        }
    }
    
    // Fixes #6052. Username is frequently sniffed from the path info, which,
    // unlike $_GET, is not URL decoded. If the username was not URL encoded,
    // this is harmless.
    $username = rawurldecode($username);
    if (empty($username)) {
        return null;
    }
    
    $logged_in_user = elgg_get_logged_in_user_entity();
    if (!empty($logged_in_user) && ($logged_in_user->username === $username)) {
        return $logged_in_user;
    }
    
    $users = elgg_get_entities([
        'types' => 'user',
        'metadata_name_value_pairs' => [
            [
                'name' => 'username',
                'value' => $username,
                'case_sensitive' => false,
            ],
        ],
        'limit' => 1,
    ]);
    
    return $users ? $users[0] : null;
}

function elgg_get_user_by_email(string $email): ?\ElggUser {
    if (empty($email)) {
        return null;
    }
    
    $users = elgg_get_entities([
        'types' => 'user',
        'metadata_name_value_pairs' => [
            [
                'name' => 'email',
                'value' => $email,
                'case_sensitive' => false,
            ],
        ],
        'limit' => 1,
    ]);
    
    return $users ? $users[0] : null;
}

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(string $username, string|array $password, string $name, string $email, bool $allow_multiple_emails = false): \Elgg\Validation\ValidationResults {
    return _elgg_services()->accounts->validateAccountData($username, $password, $name, $email, $allow_multiple_emails);
}

function elgg_generate_invite_code(string $username): string {
    return _elgg_services()->hmac->generateInviteCode($username);
}

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

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

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

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