user.module

Version 1.1139 (checked in on 2010/03/20 at 19:06:12 by dries)

Enables the user registration and login system.

Constants

Name	Description
EMAIL_MAX_LENGTH	Maximum length of user e-mail text field.
USERNAME_MAX_LENGTH	Maximum length of username text field.

Functions

Name	Description
template_preprocess_user_picture	Process variables for user-picture.tpl.php.
theme_user_list	Make a list of users.
theme_user_signature	Theme output of user signature.
user_access	Determine whether the user has a given privilege.
user_account_form	Helper function to add default user account fields to user registration and edit form.
user_account_form_validate	Form validation handler for user_account_form().
user_action_info	Implements hook_action_info().
user_authenticate	Try to validate the user's login credentials locally.
user_block_configure	Implements hook_block_configure().
user_block_info	Implements hook_block_info().
user_block_save	Implements hook_block_save().
user_block_user_action	Blocks the current user.
user_block_view	Implements hook_block_view().
user_build_content	Builds a structured array representing the profile content.
user_build_filter_query	Extends a query object for user administration filters based on session.
user_cancel	Cancel a user account.
user_cancel_access	Menu access callback; limit access to account cancellation pages.
user_cancel_url	Generate a URL to confirm an account cancellation request.
user_category_load	Return a user object after checking if any profile category in the path exists.
user_comment_view	Implements hook_comment_view().
user_cookie_save	Saves visitor information as a cookie so it can be reused.
user_delete	Delete a user.
user_delete_multiple	Delete multiple user accounts.
user_edit_access	Access callback for user account editing.
user_element_info	Implements hook_element_info().
user_entity_info	Implements hook_entity_info().
user_external_load
user_external_login_register	Helper function for authentication modules. Either logs in or registers the current user, based on username. Either way, the global $user object is populated and login tasks are performed.
user_field_extra_fields	Implements hook_field_extra_fields().
user_file_delete	Implements hook_file_delete().
user_file_download	Implements hook_file_download().
user_file_references	Implements hook_file_references().
user_filters	List user administration filters that can be applied.
user_forms	Implements hook_forms().
user_form_process_password_confirm	Form element process handler for client-side password validation.
user_get_authmaps	Discover which external authentication module(s) authenticated a username.
user_help	Implement hook_help().
user_image_style_delete	Implements hook_image_style_delete().
user_image_style_save	Implements hook_image_style_save().
user_init	Implements hook_init().
user_is_anonymous
user_is_blocked	Checks for usernames blocked by user administration.
user_is_logged_in
user_load	Fetch a user object.
user_load_by_mail	Fetch a user object by email address.
user_load_by_name	Fetch a user object by account name.
user_load_multiple	Load multiple users based on certain conditions.
user_login	Form builder; the main user login form.
user_login_authenticate_validate	A validate handler on the login form. Check supplied username/password against local users table. If successful, $form_state['uid'] is set to the matching user ID.
user_login_block
user_login_default_validators	Set up a series for validators which check for blocked users, then authenticate against local database, then return an error if authentication fails. Distributed authentication modules are welcome to use hook_form_alter() to change this series in...
user_login_destination	Helper function to rewrite the destination to avoid redirecting to login page after login.
user_login_finalize	Finalize the login process. Must be called when logging in a user.
user_login_final_validate	The final validation handler on the login form.
user_login_name_validate	A FAPI validate handler. Sets an error if supplied username has been blocked.
user_login_submit	Submit handler for the login form. Load $user object and perform standard login tasks. The user is then redirected to the My Account page. Setting the destination in the query string overrides the redirect.
user_mail	Implements hook_mail().
user_mail_tokens	Token callback to add unsafe tokens for user mails.
user_menu	Implements hook_menu().
user_modules_installed	Implements hook_modules_installed().
user_modules_uninstalled	Implements hook_modules_uninstalled().
user_module_invoke	Invokes hook_user() in every module.
user_multiple_cancel_confirm
user_multiple_cancel_confirm_submit	Submit handler for mass-account cancellation form.
user_multiple_role_edit	Callback function for admin mass adding/deleting a user role.
user_node_load	Implements hook_node_load().
user_page_title	Menu item title callback - use the user name.
user_password	Generate a random alphanumeric password.
user_pass_rehash
user_pass_reset_url	Generates a unique URL for a user to login and reset their password.
user_permission	Implements hook_permission().
user_permission_get_modules	Determine the modules that permissions belong to.
user_preferred_language	Get the language object preferred by the user. This user preference can be set on the user account editing page, and is only available if there are more than one languages enabled on the site. If the user did not choose a preferred language, or is the...
user_rdf_mapping	Implements hook_rdf_mapping().
user_register_access
user_register_form	Form builder; the user registration form.
user_register_form_pre_render	Form pre-render callback to clean up the user_register_form.
user_register_submit	Submit handler for the user registration form.
user_roles	Retrieve an array of roles matching specified conditions.
user_role_change_permissions	Change permissions for a user role.
user_role_delete	Delete a user role from database.
user_role_grant_permissions	Grant permissions to a user role.
user_role_load	Fetch a user role from database.
user_role_permissions	Determine the permissions for one or more roles.
user_role_revoke_permissions	Revoke permissions from a user role.
user_role_save	Save a user role to the database.
user_save	Save changes to a user account or add a new user.
user_search_access	Implements hook_search_access().
user_search_execute	Implements hook_search_execute().
user_search_info	Implements hook_search_info().
user_set_authmaps	Save mappings of which external authentication module(s) authenticated a user. Maps external usernames to user ids in the users table.
user_theme	Implements hook_theme().
user_uid_only_optional_to_arg	Returns $arg or the user ID of the current user if $arg is '%' or empty.
user_uid_optional_load	Load either a specified or the current user account.
user_uid_optional_to_arg	Returns $arg or the user ID of the current user if $arg is '%' or empty.
user_uri	Entity uri callback.
user_user_categories	Implements hook_user_categories().
user_user_operations	Implements hook_user_operations().
user_user_operations_block	Callback function for admin mass blocking users.
user_user_operations_unblock	Callback function for admin mass unblocking users.
user_user_presave	Implements hook_user_presave().
user_user_view	Implements hook_user_view().
user_validate_current_pass	Form validation handler for the current password on the user_account_form().
user_validate_mail
user_validate_name	Verify the syntax of the given name.
user_validate_picture
user_view	Generate an array for rendering the given user.
user_view_access	User view access callback.
user_view_page	Page callback wrapper for user_view().
_user_cancel	Last batch processing step for cancelling a user account.
_user_categories	Retrieve a list of all user setting/information categories and sort them by weight.
_user_mail_notify	Conditionally create and send a notification email when a certain operation happens on the given user account.
_user_mail_text	Returns a mail string for a variable name.
_user_sort