function user_roles

7.x user.module user_roles($membersonly = FALSE, $permission = NULL)

Retrieve an array of roles matching specified conditions.

Parameters

$membersonly: Set this to TRUE to exclude the 'anonymous' role.

$permission: A string containing a permission. If set, only roles containing that permission are returned.

Return value

An associative array with the role id as the key and the role name as value.

18 calls to user_roles()
block_admin_configure in drupal/modules/block/block.admin.inc
Form constructor for the block configuration form.
FilterFormatAccessTestCase::testFormatRoles in drupal/modules/filter/filter.test
Tests if text format is available to a role.
filter_admin_format_form in drupal/modules/filter/filter.admin.inc
Form constructor for the text format add/edit form.
filter_get_roles_by_format in drupal/modules/filter/filter.module
Retrieves a list of roles that are allowed to use a given text format.
filter_update_7005 in drupal/modules/filter/filter.install
Integrate text formats with the user permissions system.

... See full list

File

drupal/modules/user/user.module, line 2843
Enables the user registration and login system.

Code

function user_roles($membersonly = FALSE, $permission = NULL) {
  $query = db_select('role', 'r');
  $query->addTag('translatable');
  $query->fields('r', array('rid', 'name'));
  $query->orderBy('weight');
  $query->orderBy('name');
  if (!empty($permission)) {
    $query->innerJoin('role_permission', 'p', 'r.rid = p.rid');
    $query->condition('p.permission', $permission);
  }
  $result = $query->execute();

  $roles = array();
  foreach ($result as $role) {
    switch ($role->rid) {
      // We only translate the built in role names
      case DRUPAL_ANONYMOUS_RID:
        if (!$membersonly) {
          $roles[$role->rid] = t($role->name);
        }
        break;
      case DRUPAL_AUTHENTICATED_RID:
        $roles[$role->rid] = t($role->name);
        break;
      default:
        $roles[$role->rid] = $role->name;
    }
  }

  return $roles;
}