Roles and Permission creation programatically inside module

Question

I am trying to create drupal 8 roles and permissions programatically. My current approach is to have a module that when install it will generate those set of roles and permissions defined by the module. It would be more like a background Module, where no form is needed or anything. My problem lies that I really don't know where to start the the roles creations since no form is needed, I mean should I create them inside a hook?, if so which hook?, any other place?

I really don't know if this is the best approach, still a newby on drupal 8. Any suggestions will be greatly appreciate it.

Thanks in advance

Answer 1

Create the roles on your development site and grab the configuration for them and place them in:

<modulename>/config/install 

When the module is installed it will import that configuration. hook_install is deprecated for installing configuration with a module.

Remove any uuid information from the export as it won't be applicable in most sites.

If you are unaware how to export/import configuration in drupal 8, you should read: D8 Configuration Management

edit: Just as an aside fact, you can in theory write your own config.yml files however until you are very familiar it's easier to just create the role, and export it.

Answer 2

If it's during install, I would say you put it in the install hook. When the module gets uninstalled, you can remove the roles again with hook_uninstall().

Answer 3

I prefer the programatically way instead of config way:

put into the YOUR_MODULE.install

/**
* Implements hook_install().
*/
function YOUR_MODULE_install() {
  $role = \Drupal\user\Entity\Role::create([
  'id' => 'your_role_name',
  'label' => 'YOUR Role Name',
  ]);
  $role->save();
}

/**
* Implements hook_uninstall().
*
* @throws \Drupal\Core\Entity\EntityStorageException
*/
function YOUR_MODULE_uninstall() {
  $role = \Drupal\user\Entity\Role::load('your_role_name')->delete();
}