Error message

You are browsing documentation for drupal 7.x, which is not supported anymore. Read the updated version of this page for drupal 11.x (the latest version).

function user_admin_role

Form to configure a single role.

See also

user_admin_role_validate()

user_admin_role_submit()

Related topics

Form builder functions
Functions that build an abstract representation of a HTML form.
8 string references to 'user_admin_role'
filter_admin_format_form in modules/filter/filter.admin.inc
Form constructor for the text format add/edit form.
hook_shortcut_default_set in modules/shortcut/shortcut.api.php
Return the name of a default shortcut set for the provided user account.
standard_install in profiles/standard/standard.install
Implements hook_install().
UserRoleAdminTestCase::testRoleAdministration in modules/user/user.test
Test adding, renaming and deleting roles.
user_admin_settings in modules/user/user.admin.inc
Form builder; Configure user settings for this site.

... See full list

File

modules/user/user.admin.inc, line 967

Code

function user_admin_role ($form, $form_state, $role) {
 if ($role->rid  == DRUPAL_ANONYMOUS_RID  || $role->rid  == DRUPAL_AUTHENTICATED_RID ) {
 drupal_goto ('admin/people/permissions/roles');
 }
 // Display the edit role form.
 $form['name'] = array(
 '#type' => 'textfield',
 '#title' => t ('Role name'),
 '#default_value' => $role->name ,
 '#size' => 30,
 '#required' => TRUE,
 '#maxlength' => 64,
 '#description' => t ('The name for this role. Example: "moderator", "editorial board", "site architect".'),
 );
 $form['rid'] = array(
 '#type' => 'value',
 '#value' => $role->rid ,
 );
 $form['weight'] = array(
 '#type' => 'value',
 '#value' => $role->weight,
 );
 $form['actions'] = array(
 '#type' => 'actions',
 );
 $form['actions']['submit'] = array(
 '#type' => 'submit',
 '#value' => t ('Save role'),
 );
 $form['actions']['delete'] = array(
 '#type' => 'submit',
 '#value' => t ('Delete role'),
 '#submit' => array(
 'user_admin_role_delete_submit',
 ),
 );
 return $form;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.