function hook_user_categories

7.x user.api.php hook_user_categories()

Retrieve a list of user setting or profile information categories.

Return value

An array of associative arrays. Each inner array has elements:

  • "name": The internal name of the category.
  • "title": The human-readable, localized name of the category.
  • "weight": An integer specifying the category's sort ordering.
  • "access callback": Name of the access callback function to use to determine whether the user can edit the category. Defaults to using user_edit_access(). See hook_menu() for more information on access callbacks.
  • "access arguments": Arguments for the access callback function. Defaults to array(1).

Related topics

2 functions implement hook_user_categories()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

profile_user_categories in drupal/modules/profile/profile.module
Implements hook_user_categories().
user_user_categories in drupal/modules/user/user.module
Implements hook_user_categories().
1 invocation of hook_user_categories()
_user_categories in drupal/modules/user/user.module
Retrieve a list of all user setting/information categories and sort them by weight.

File

drupal/modules/user/user.api.php, line 200
Hooks provided by the User module.

Code

function hook_user_categories() {
  return array(array(
    'name' => 'account',
    'title' => t('Account settings'),
    'weight' => 1,
  ));
}