Load Drupal Organic Group Role By Name

23rd January 2013 - 3 minutes read time

I have been developing a site with the Drupal 7 Organic Groups (OG) module today and I found the need to grab a bunch of users from a group depending on their group role. The first parameter here is the group GID (not the node ID) and the second is an array of role ID's to use.

$administrators = og_get_users_by_roles($group->gid, array(4));

This is fine, but as I couldn't be sure that the role would have the same ID on my production server I needed to use a function that loaded the role ID based on the name of the role I wanted. The result of which could be fed back into the above module. It turns out that OG doesn't have a function like this (that I could find) so I wrote the following.

function mymodule_og_roles_by_name($name) {
  $roles = db_query("SELECT rid, name FROM {og_role} WHERE gid = :gid and name = :name ORDER BY rid", array(':gid' => 0, 'name' => $name))->fetchAssoc();
  return $roles;
}

I could now use this function to load the OG roles without having to rely on the role ID. This is much more robust and easy to read than the previous version.

$administrators = og_get_users_by_roles($group->gid, mymodule_og_roles_by_name('group leader'));
OG
Drupal
Drupal 7

Add new comment

The content of this field is kept private and will not be shown publicly.
CAPTCHA
2 + 8 =
Solve this simple math problem and enter the result. E.g. for 1+3, enter 4.
This question is for testing whether or not you are a human visitor and to prevent automated spam submissions.

Related Content

Drupal 11: The Queues API

22nd December 2024

I've talked a lot about the Batch API in Drupal recently, and I've mentioned that it is built upon the Queue API, but I haven't gone any deeper than that. I wrote about the Queues API in Drupal 7, but thought I would bring my understanding up to date.

Read more

Drupal 11: Batch Operations Built Into Drupal

27th October 2024

This is the sixth article in a series of articles about the Batch API in Drupal. The Batch API is a system in Drupal that allows data to be processed in small chunks in order to prevent timeout errors or memory problems.

Read more

Drupal 11: Adding Operations To Running Batches

13th October 2024

This is the fifth article in a series of articles about the Batch API in Drupal. The Batch API is a system in Drupal that allows data to be processed in small chunks in order to prevent timeout errors or memory problems.

Read more

Drupal 11: Using The Batch API To Process CSV Files

29th September 2024

This is the fourth article in a series of articles about the Batch API in Drupal. The Batch API is a system in Drupal that allows data to be processed in small chunks in order to prevent timeout errors or memory problems.

Read more