Elgg
Version 4.3
|
Go to the source code of this file.
Functions | |
get_user ($guid) | |
Get a user object from a GUID. More... | |
get_user_by_username ($username) | |
Get user by username. More... | |
get_user_by_email ($email) | |
Get an array of users from an email address. More... | |
elgg_request_new_password (\ElggUser $user) | |
Generate and send a password request email to a given user's registered email address. More... | |
elgg_save_new_password (\ElggUser $user, string $conf_code, string $password=null) | |
Validate and change password for a user. More... | |
elgg_generate_password () | |
Generate a random 12 character clear text password. More... | |
elgg_register_user (array $params=[]) | |
Registers a user. More... | |
elgg_validate_registration_data ($username, $password, $name, $email, $allow_multiple_emails=false) | |
Assert that given registration details are valid and can be used to register the user. More... | |
elgg_generate_invite_code (string $username) | |
Generates a unique invite code for a user. More... | |
elgg_validate_invite_code ($username, $code) | |
Validate a user's invite code. More... | |
elgg_get_registration_url (array $parameters=[], $fragment= '') | |
Returns site's registration URL Triggers a 'registration_url', 'site' plugin hook that can be used by plugins to alter the default registration URL and append query elements, such as an invitation code and inviting user's guid. More... | |
elgg_get_login_url (array $query=[], $fragment= '') | |
Returns site's login URL Triggers a 'login_url', 'site' plugin hook that can be used by plugins to alter the default login URL. More... | |
elgg_get_user_by_persistent_token (string $token) | |
Get a user based on a persistent login token. More... | |
elgg_generate_invite_code | ( | string | $username | ) |
Generates a unique invite code for a user.
string | $username | The username of the user sending the invitation |
elgg_generate_password | ( | ) |
elgg_get_login_url | ( | array | $query = [] , |
$fragment = '' |
|||
) |
elgg_get_registration_url | ( | array | $parameters = [] , |
$fragment = '' |
|||
) |
Returns site's registration URL Triggers a 'registration_url', 'site' plugin hook that can be used by plugins to alter the default registration URL and append query elements, such as an invitation code and inviting user's guid.
array | $parameters | An array of query elements |
string | $fragment | Fragment identifier |
elgg_get_user_by_persistent_token | ( | string | $token | ) |
elgg_register_user | ( | array | $params = [] | ) |
Registers a user.
array | $params | Array of options with keys: (string) username => The username of the new user (string) password => The password (string) name => The user's display name (string) email => The user's email address (string) subtype => (optional) Subtype of the user entity (string) language => (optional) user language (defaults to current language) (bool) allow_multiple_emails => (optional) Allow the same email address to be registered multiple times (default false) (bool) validated => (optional) Is the user validated (default true) |
RegistrationException |
elgg_request_new_password | ( | \ElggUser | $user | ) |
elgg_save_new_password | ( | \ElggUser | $user, |
string | $conf_code, | ||
string | $password = null |
||
) |
elgg_validate_invite_code | ( | $username, | |
$code | |||
) |
Validate a user's invite code.
string | $username | The username |
string | $code | The invite code |
elgg_validate_registration_data | ( | $username, | |
$password, | |||
$name, | |||
$email, | |||
$allow_multiple_emails = false |
|||
) |
Assert that given registration details are valid and can be used to register the user.
string | $username | The username of the new user |
string | array | $password | The password Can be an array [$password, $confirm_password] |
string | $name | The user's display name |
string | The user's email address | |
bool | $allow_multiple_emails | Allow the same email address to be registered multiple times? |
get_user | ( | $guid | ) |
get_user_by_email | ( | ) |