4.1. Users

Top  Previous  Next

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

•

Parameters:

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    

•

Used templates:

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

•

Parameters:

o

username - a name of a user

o

password -  user password

o

keep - this flag means whether login information should be saved or not.  

•

Used templates:

o

already_logged_in.tpl

o

login.tpl

 

□

logout - logs out users and redirects them to the main page

•

Parameters: no

•

Used templates: no

 

□

activate_account - activates user account

•

Parameters:

o

username - a name of a user

o

activation_key - activation key

•

Used templates:

o

activate_account.tpl

 

□

password_recovery - recoveries user password

•

Parameters:

o

username - a name of a user

•

Used templates:

o

password_recovery.tpl

o

password_change_email_successfully_sent.tpl

 

□

change_password - changes user password

•

Parameters:

o

username - a name of a user

o

verification_key - verification key

o

password  - new password

o

confirm_password - password confirmation

•

Used templates:

o

change_password.tpl

o

successful_password_change.tpl

 

□

edit_profile - edits user profile

•

Parameters: no

•

Used templates:

o

edit_profile.tpl

 

□

user_notifications - user notifications management (turn on / turn off)

•

Parameters: no

•

Used templates:

o

user_notifications.tpl

 

□

delete_uploaded_file - deleting an uploaded file of a current user

•

Parameters:

o

field_id - ID of a user field. A file will be deleted from this user field.

•

Used templates:

o

delete_uploaded_file.tpl