How to use get_role_list filter in WordPress

get_role_list filter

Filters the returned array of translated role names for a user.

To use get_role_list filter, first you have to register it using add_filter. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.

We at WePlugins always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function weplugins_modify_get_role_list_defaults which takes 2 parameters and we registered using add_filter. The first parameter get_role_list is the name of the hook, The second parameter weplugins_modify_get_role_list_defaults is the name of the function which needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook so you can use remove_filter to remove get_role_list filter.

Parameters

Below are the 2 parameters required to use this hook.

• $role_list : (string[]) An array of translated user role names keyed by role.
• $user_object : (WP_User) A WP_User object.

Live Examples

Example 1: Basic Usage

This example demonstrates how to modify the role list.

  function weplugins_modify_get_role_list_defaults($role_list, $user_object) { 
      // Update the $role_list variable according to your website requirements and return this variable.
      return $role_list; 
  }
  // add the filter
  add_filter("get_role_list", "weplugins_modify_get_role_list_defaults", 10, 2);
  

Example 2: Conditional Modification

Here’s how you can conditionally modify the role list based on user roles.

  function weplugins_conditionally_modify_role_list($role_list, $user_object) { 
      if (in_array('administrator', $user_object->roles)) {
          $role_list['custom_role'] = 'Custom Role';
      }
      return $role_list; 
  }
  // add the filter
  add_filter("get_role_list", "weplugins_conditionally_modify_role_list", 10, 2);
  

Example 3: Removing the Hook

To remove a hook callback, use the example below.

  // remove the filter
  remove_filter("get_role_list", "weplugins_modify_get_role_list_defaults", 10, 2);
  

Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.