user_roles

5 user.module	`user_roles($membersonly = 0, $permission = 0)`
6 user.module	`user_roles($membersonly = FALSE, $permission = NULL)`
7 user.module	`user_roles($membersonly = FALSE, $permission = NULL)`
8 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.

▸ 12 functions call user_roles()

▾ 12 functions call user_roles()

blogapi_admin_settings in modules/blogapi/blogapi.module
blogapi_metaweblog_new_media_object in modules/blogapi/blogapi.module: Blogging API callback. Inserts a file into Drupal.
filter_admin_format_form in modules/filter/filter.module: Generate a filter format form.
filter_admin_format_form_submit in modules/filter/filter.module: Process filter format form submissions.
filter_admin_overview in modules/filter/filter.module: Displays a list of all input formats and which one is the default
theme_comment_post_forbidden in modules/comment/comment.module
theme_user_admin_new_role in modules/user/user.module
upload_admin_settings in modules/upload/upload.module: Menu callback for the upload settings form.
user_admin_account in modules/user/user.module
user_edit_form in modules/user/user.module
user_filters in modules/user/user.module: List user administration filters that can be applied.
user_user_operations in modules/user/user.module: Implementation of hook_user_operations().

File

modules/user/user.module, line 1797: Enables the user registration and login system.

Code

<?php
function user_roles($membersonly = 0, $permission = 0) {
  $roles = array();

  if ($permission) {
    $result = db_query("SELECT r.* FROM {role} r INNER JOIN {permission} p ON r.rid = p.rid WHERE p.perm LIKE '%%%s%%' ORDER BY r.name", $permission);
  }
  else {
    $result = db_query('SELECT * FROM {role} ORDER BY name');
  }
  while ($role = db_fetch_object($result)) {
    if (!$membersonly || ($membersonly && $role->rid != DRUPAL_ANONYMOUS_RID)) {
      $roles[$role->rid] = $role->name;
    }
  }
  return $roles;
}
?>