|
Elgg
Version 4.x
|
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... | |
| find_active_users (array $options=[]) | |
| Return users (or the number of them) who have been active within a recent period. More... | |
| get_online_users (array $options=[]) | |
| Render a list of currently online users. More... | |
| send_new_password_request ($user_guid) | |
| Generate and send a password request email to a given user's registered email address. More... | |
| force_user_password_reset ($user_guid, $password) | |
| Low level function to reset a given user's password. More... | |
| execute_new_password_request ($user_guid, $conf_code, $password=null) | |
| Validate and change password for a user. More... | |
| generate_random_cleartext_password () | |
| Generate a random 12 character clear text password. More... | |
| register_user ($username, $password, $name, $email, $allow_multiple_emails=false, $subtype=null, array $params=[]) | |
| Registers a user, returning false if the username already exists. 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... | |
| generate_invite_code ($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 $query=[], $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_get_login_url | ( | array | $query = [], |
$fragment = '' |
|||
| ) |
| elgg_get_registration_url | ( | array | $query = [], |
$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 | $query | An array of query elements |
| string | $fragment | Fragment identifier |
| elgg_get_user_by_persistent_token | ( | string | $token | ) |
| 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? |
| execute_new_password_request | ( | $user_guid, | |
| $conf_code, | |||
$password = null |
|||
| ) |
| find_active_users | ( | array | $options = [] | ) |
Return users (or the number of them) who have been active within a recent period.
| array | $options | Array of options with keys: seconds (int) => Length of period (default 600 = 10min) limit (int) => Limit (default from settings) offset (int) => Offset (default 0) count (bool) => Return a count instead of users? (default false) |
| force_user_password_reset | ( | $user_guid, | |
| $password | |||
| ) |
Low level function to reset a given user's password.
This can only be called from execute_new_password_request().
| int | $user_guid | The user. |
| string | $password | Text (which will then be converted into a hash and stored) |
| generate_invite_code | ( | $username | ) |
Generates a unique invite code for a user.
| string | $username | The username of the user sending the invitation |
| generate_random_cleartext_password | ( | ) |
| get_online_users | ( | array | $options = [] | ) |
Render a list of currently online users.
This also support options from elgg_list_entities().
| array | $options | Options array with keys: seconds (int) => Number of seconds (default 600 = 10min) |
| get_user | ( | $guid | ) |
| get_user_by_email | ( | ) |
| get_user_by_username | ( | $username | ) |
| register_user | ( | $username, | |
| $password, | |||
| $name, | |||
| $email, | |||
$allow_multiple_emails = false, |
|||
$subtype = null, |
|||
| array | $params = [] |
||
| ) |
Registers a user, returning false if the username already exists.
| string | $username | The username of the new user |
| string | $password | The 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? |
| string | $subtype | Subtype of the user entity |
| array | $params | Additional parameters |
| RegistrationException |
1.8.11
