function user_role_save

7.x user.module user_role_save($role)

Save a user role to the database.

Parameters

$role: A role object to modify or add. If $role->rid is not specified, a new role will be created.

Return value

Status constant indicating if role was created or updated. Failure to write the user role record will return FALSE. Otherwise. SAVED_NEW or SAVED_UPDATED is returned depending on the operation performed.

4 calls to user_role_save()

DrupalWebTestCase::drupalCreateRole in drupal-7.x/modules/simpletest/drupal_web_test_case.php: Internal helper function; Create a role with specified permissions.
standard_install in drupal-7.x/profiles/standard/standard.install: Implements hook_install().
user_admin_roles_order_submit in drupal-7.x/modules/user/user.admin.inc: Form submit function. Update the role weights.
user_admin_role_submit in drupal-7.x/modules/user/user.admin.inc: Form submit handler for the user_admin_role() form.

File

drupal-7.x/modules/user/user.module, line 2956: Enables the user registration and login system.

Code

function user_role_save($role) {
  if ($role->name) {
    // Prevent leading and trailing spaces in role names.
    $role->name = trim($role->name);
  }
  if (!isset($role->weight)) {
    // Set a role weight to make this new role last.
    $query = db_select('role');
    $query->addExpression('MAX(weight)');
    $role->weight = $query->execute()->fetchField() + 1;
  }

  // Let modules modify the user role before it is saved to the database.
  module_invoke_all('user_role_presave', $role);

  if (!empty($role->rid) && $role->name) {
    $status = drupal_write_record('role', $role, 'rid');
    module_invoke_all('user_role_update', $role);
  }
  else {
    $status = drupal_write_record('role', $role);
    module_invoke_all('user_role_insert', $role);
  }

  // Clear the user access cache.
  drupal_static_reset('user_access');
  drupal_static_reset('user_role_permissions');

  return $status;
}