Users module includes all functions related to user handling, such as user login, registration forms and etc.
Module functions:
?
|
registration - allows users to register in the system
|
o
|
user_group_id - the optional parameter specifies a user group ID; if it doesn't specify, then this function returns the list of all available user groups to choose.
|
o
|
reg_form_template - registration form template
|
o
|
registration_choose_user_group.tpl
|
o
|
registration_success.tpl
|
o
|
registration_form.tpl or the template specified in the property of the registration form template group.
|
?
|
login - displays login form
|
o
|
username - a name of a user
|
o
|
password - user password
|
o
|
keep - this flag means whether login information should be saved or not.
|
?
|
logout - logs out users and redirects them to the main page
|
?
|
activate_account - activates user account
|
o
|
username - a name of a user
|
o
|
activation_key - activation key
|
?
|
password_recovery - recoveries user password
|
o
|
username - a name of a user
|
o
|
password_change_email_successfully_sent.tpl
|
?
|
change_password - changes user password
|
o
|
username - a name of a user
|
o
|
verification_key - verification key
|
o
|
password - new password
|
o
|
confirm_password - password confirmation
|
o
|
successful_password_change.tpl
|
?
|
edit_profile - edits user profile
|
?
|
user_notifications - user notifications management (turn on / turn off)
|
?
|
delete_uploaded_file - deleting an uploaded file of a current user
|
o
|
field_id - ID of a user field. A file will be deleted from this user field.
|
o
|
delete_uploaded_file.tpl
|
| • | search_users – implements user search functionality |
| • | user_group_id – contains the User Group Id of the group to search within. If left empty, users of all groups are included in the search. |
| • | search_form_template – contain the name of the templates used to display the search form. If left empty, the default template named “user_search_form.tpl” is used. This template displays search form for user profile’s field listed in the “fields” parameter. |
| • | fields – enumerates fields to be used in search criteria. List fields separated by comma. This parameter is used only together with the default search template (“user_search_form.tpl”). |
| • | result_template – contains the name of the templates used to display search results. If left empty, the default “user_search_results.tpl” template is used. |
When setting up a user search page, please keep the following in mind:
| 1. | The list of fields in the “fields” parameter is used inside the default search form template (user_search_form.tpl). If you use a different template for user search form (by setting a value to the search_form_template parameter) the list in “fields” parameter may be disregarded by the creator of the search form template. Creator of the search template has the choice either to disregard the list from the “fields” parameter or use it. |
| 2. | Only those fields that are available in the profile of the user group “user_group_id” make sense as a search criteria. For example if site visitor is looking for the company named “Alpha” in user search, but the group within which search is done does not have the “company name” field no users will be found (empty result). Please take keep this consideration in mind when setting up user search page and creating a custom search form template. |
| • | contact_form - displays contact user form and sends contents of the form to the user after submissions. |
| • | display_template - the optional parameter, the template for contact user form. If left blank, the default “contact_form.tpl” template is used. |
| • | user_details - displays user details from user profile. |
| • | display_template - the optional parameter, the template for the user details. If left blank, the default “user_details” template is used. |
| • | user_details.tpl – default template, used when display_template parameter is left blank. This templates is used for “View User Profile” page. |
|