HOWTO assign a user to a role programatically

Someone with more experience with the user.module may correct me, but how about:

$myuser = user_load($user_uid); 
$myuserroles = $myuser->roles[]; 
$myuserroles[] = 'newrole'; 
user_save($myuser, array('roles' => $myuserroles)); 
 

or, to be more correct, use module_invoke:

$myuser = module_invoke('user', 'load', $user_uid); 
$myuserroles = $myuser->roles[]; 
$myuserroles[]  = 'newrole'; 
module_invoke('user', 'save', $myuser, array('roles' => $myuserroles)); 
 

The user_save function reloads the user's roles into the session. I'm not sure where the core modules would delete a user's roles without explicitly calling the delete (role or user) functions.

Hello,

I don't know if this is any help, but this is how I solved a similar problem.

I wanted to make it so that when users register they basically get to chose a role. I found a way that worked for me.

First you need to install logintoboggan and patch the module using this patch: http://drupal.org/node/58084

I have the patched version if anyone needs it.

I got logintoboggan to forward new users to a page I'd created with a simple form on it:

<?php

   global $user; 

   if ($_POST["UpgradeRole"] == "Upgrade")
      {
         $userid = $user->uid;
         db_query("INSERT INTO {users_roles} (rid, uid) VALUES ('%d','%d')", 5, $userid);
   }
?>

<form method="POST"  action="/node/46">
Click checkbox to upgrade role:

<input name="UpgradeRole" type="checkbox" value="Upgrade">
<input type="submit" name="Go">
</form>

So when the user clicks 'Go' the form will call itself and update the roles. I've set the role id in this example to 5 as you can see on the db_query part, but this could be any role id.

I just did something similar on my site, where I automatically assign new users a "pending" role, and can assign other roles based on information in their "profile" whenever they update their details.

Code looks something like this:

function module_user ($op, &$edit, &$user, $category=null)
{
  if ($op == "insert" || $op == "update")
  {
    // clear first
    db_query( 'DELETE FROM {users_roles} WHERE uid = %d', $user->uid );

    // custom code here based on $user->profile_* settings
    profile_load_profile( $user ); // make sure we load profile data here before continuing
    if ($user->profile_foo == "bar")
    {
      db_query('INSERT INTO {users_roles} (uid, rid) VALUES (%d, %d)', $user->uid, $rid); // $rid = whatever you like
    }

    // special case for new users
    if ($op == "insert")
    {
      db_query('INSERT INTO {users_roles} (uid, rid) VALUES (%d, %d)', $user->uid, $rid); // $rid = whatever you like
    }
  }
}

The profile module has a check for if (empty($user->{$field->name})) in the profile_load_profile function that prevents it from overwriting the current settings with just-submitted ones, just comment that out so you have access to the correct profile data.

Seems to work well. Hope this helps.

-Pauly

how to CREATE new role programatically ? (based on email domain.)

for example i have these roles:

school_com for name@school.com
persianblog_com for name@persianblog.com
yahoo_ir for name@yahoo.ir

when a new user register, create new role if its not available:

new user email: meysam@noavar.ir
then create 'noavar_ir' role programatically

added:
noavar_ir for meysam@noavar.ir

(help me for create new role programatically)

and still no answer. It's often very frustrating when you try to dig deeper into Drupal - especially when you strike a problem like this, that would be simple to code yourself, if you were writing your own system. I can't wait for the "Pro Drupal" book due out in April. Maybe that will solve some of our problems.

If you check out this feature request, you can find the modification I made to the logintobbogan module that does what you want here.

If you examine the code, you may have some of your specific questions answered.

Dave

Hi,
I created a php file with this in it, then navigated ther with my browser, but it doesn't work!

"

<?php
function cache_clear_all('menu:'. $user->uid, TRUE);

"

I got his message :
"Parse error: syntax error, unexpected T_CONSTANT_ENCAPSED_STRING, expecting '&' or T_VARIABLE in PATH/FILE.php on line 2"
PATH/FILE is of course the path on my server and the file's name.

My new admin accounts can't admin after i make new roles and assign them...
where and how do i execute this code?
please be very specific.. thank you so much!

[making my first drupal based community.]

subscribing

www.MyResearchFunds.com
The World's Fastest Growing Network of Researchers

user_multiple_role_edit(array($node->uid), 'add_role', 5);

In Drupal 5, be sure to clear the menu cache afterwards:

cache_clear_all('*', 'cache_menu', TRUE);

i think that this is a drupal bug.
find at user.module

// Save user roles (delete just to be safe).
    if (isset($array['roles']) && is_array($array['roles']) ))

modify it to

// Save user roles (delete just to be safe).
    if (isset($array['roles']) && is_array($array['roles']) && !empty($array['roles']))

I fixed this by hacking user.module around line 2320 where it calls

$account = user_save(...
I set my role in $merge_date and voila!

It was SO tempting to hack user.module as others have done to make it easy to add roles during registration...

After all, you can create a custom form _validate function for your module, and adjust other fields in the $form_state array before it gets saved.

However, it seems that there is a potential security vulnerability if roles were allowed to be assigned via $form_state['values']['roles'], and so doing that is specifically disallowed in user_register_submit().

Finally, after studying the user.module functions user_register_submit and user_save, I discovered a way to fairly easily assign roles without breaking any security rules that I know of:

Here it is again as code fragments, assuming your module is called "MyModule":

/**
 * Implementation of hook_form_alter
 */
function MyModule_form_alter(&$form, $form_state, $form_id) {
  if ( $form_id == 'user_profile_form' || $form_id == 'user_edit' || $form_id == 'user_register' ) {
    $form['#validate'][] = 'MyModule_profile_validate';
  }
}
function MyModule_profile_validate( $form, &$form_state ) {
  if (... this user should be auto-assigned to a role... ) {
    $role_name = 'role to auto-assign';
    $rid = MyModule_get_rid($role_name);
    if (!is_null($rid)) { // make sure we found the role
      $form_state['values']['MyModule_user role-to-add'] = array($rid => $role_name);
    };
  };
}
function MyModule_get_rid($role) {
  $result = db_query("SELECT rid FROM {role} WHERE name = '%s'",$role);
  $ret = NULL;
  if ($obj_role = db_fetch_object($result)) {
    $ret = $obj_role->rid;
  };
  return $ret;
}
/**
 * Implementation of hook_user('insert')
 */
function MyModule_user( $op, &$edit, &$account, $category=NULL ) {
/**
 * Implementation of hook_user('insert')
 */
  switch ($op) {
    case 'insert':
      // The user account is being added. 
      // The module should save its custom additions to the user object into the database 
      //   and set the saved fields to NULL in $edit.

      if (isset($edit['MyModule_user role-to-add'])
          && is_array($edit['MyModule_user role-to-add']) ) {
// This would show you immediately that your code is working:
//drupal_set_message("Automatically adding custom role!", 'status');
          $edit['roles'] = $edit['MyModule_user role-to-add'] + $edit['roles'];
          $edit['MyModule_user role-to-add'] = NULL;
      };
  };
}

... Initially, I used the $form_status['values'] / $edit array as described above. But, this might actually leave a security hole where, if a visitor knew your 'secret' field value, then they could assign themselves to an arbitrary role.

So, it might be better if a value were used like $_SESSION['MyModule_user role-to-add'] instead.

check this module's implementation of hook_user().
https://drupal.org/project/registration_role
something like this

   if ($op == "insert" ){
    $edit['roles'][$rid] = $roles[$rid];
  }

I created a function to review the form role options in the registration form which takes two parameters: the role name you are looking for and the form where the options live. The function could use a little cleanup, but it works for now.

function get_role_array($role_name, $form)
{
	$roles = array();

	foreach($form['account']['roles']['#options'] as $key => $value) {
		if($value == $role_name) {
			$roles[] = $key;
			break;
		}
	}

	return $roles;
}

Example call and how to apply it to the form:

$roles = get_role_array('Content Editor', $form);
$form['account']['roles']['#default_value'] = $roles;

$roles needs to be an array when applied back to the default value for the form.

Hi I created a shorter hand method of adding roles with a homegrown function

function morroni_add_role(&$user, $role_name) {
	$success = false;
	// jwatson load roles and get key of our desired role (if it exists)
	$roles = user_roles();
	$key = ($k = array_search($role_name, $roles)) > 0 ? $k : 0;

	if ($k > 0) {
		// add role to existing roles
		$user->roles[$key] = $role_name;
		// build array for user_save data
		$array = array('roles' => $user->roles);
		// save
		user_save($user, $array);
		$success = true;
	}
	return $success;
}

//usage
$user = user_load(3);
$result = (bool) morroni_add_role(&$user, 'role_name_goes_here');

...can be done with this:

$uid = 123;// User ID of user that you want to add remove role from.
$role_name = 'customer'; // The name of the role to remove.
if ($role = user_role_load_by_name($role_name)) {
  user_multiple_role_edit(array($uid), 'remove_role', $role->rid);
}

Inspiration from this page: http://www.computerminds.co.uk/articles/quick-tips-adding-role-user-drup...
Drupal API: http://api.drupal.org/api/drupal/modules!user!user.module/function/user_...

Hi guys,

This code worked for me:

<?php
  $key = array_search('role name', $user->roles);
	if (!$key) {
		$roles = user_roles(TRUE);
		$rid = array_search('role name', $roles);
		if ($rid) {
			$user_roles = $user->roles;
			if (is_array($user_roles)) {
				$user_roles [$rid] = 'role name';
				user_save($user, array('roles' => $user_roles));
			}
		}
	}
?>

You need insert new key after load all user roles, if you do it before you'll subscribe another roles.

Thank's

Not need modify bbdd for user roles changes?

I realize this post is very old.

But I was looking to do something similar and while searching I found it.

This code is almost correct:

$myuser = user_load($user_uid);
$myuserroles = $myuser->roles[];
$myuserroles[] = 'newrole';
user_save($myuser, array('roles' => $myuserroles));

It should look more like this.

$myuser = user_load($user_uid);
$myuserroles = $myuser->roles[$rid];
$myuserroles[$rid] = 'newrole';
$myuser->roles =$myuserroles;
user_save($myuser, array('roles' => $myuserroles));

Where $rid is the rid of new role in the roles table.

Why? It appears that the array contains NULL values to form switches for permissions. Most-likely due to optimization.
This may also work.

$myuser = user_load($user_uid);
$myuser->roles[$rid] = 'newrole';
user_save($myuser);

$role_name = 'MY_ROLE_NAME'
$roles_flipped = array_flip(user_roles());

// add role.
$account->roles[$roles_flipped[$role_name]] = $role_name;

// remove role.
unset($account->roles[$roles_flipped[$role_name]]);

Don't forget to user_save($account) !

How to add:

  $role = user_role_load_by_name('Role-name');
  user_save($account, array('roles' => $account->roles + array($role->rid => $role->name)));

How to delete:

  $role = user_role_load_by_name('Role-name');
  user_save($account, array('roles' => array_filter($account->roles, function($item) use ($role) {
    return $item != $role->name;
  })));

Mix:

  $role = user_role_load_by_name('Role-name');

  $roles = $some_logic_here
    ? $account->roles + array($role->rid => $role->name)
    : array_filter($account->roles, function($role_name) use ($role) {
      return $role_name != $role->name;
    });

  user_save($account, array('roles' => $roles));

I think Rules module can help you lot, please have a look on it https://www.drupal.org/project/rules.

// use hook_ENTITY_ID_presave

function modulename_user_presave(Drupal\Core\Entity\EntityInterface $entity) {
    $entity->addRole('rolename');
}

as mentioned in http://monkpal.com/add-role-user-account-when-register-or-create-drupal-8

The given below example is for Drupal 8

  //load current user or pass user id	
  $user = \Drupal\user\Entity\User::load(\Drupal::currentUser()->id());

  //add particular role  	  
  $user->addRole('role_name');
  
  //OR

  //remove particular role
  $user->removeRole('role_name');

  //save user
  $user->save();