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 Flipper Code, 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 modify_get_role_list_defaults which takes 2 parameters and we registered using add_filter. The first parameter get_role_list is name of the hook, The second parameter modify_get_role_list_defaults is name of the function which need to be called, third parameter is the priority of calling the hook if same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.
Sometime, you have to remove a registered hook so you can use remove_filter to remove get_role_list filter.
Parameters
- $role_list : (string[]) An array of translated user role names keyed by role.
- $user_object : (WP_User) A WP_User object.
Below are the 2 parameters are required to use this hook.
Live Example
apply_filters( 'get_role_list', string[] $role_list, WP_User $user_object )
Below is an example how you can use this hook.
function modify_get_role_list_defaults($role_list, $user_object) {
// Update the $role_list variable according to your website requirements and return this variable. You can modify the $role_list variable conditionally too if you want.
return $role_list;
}
// add the filter
add_filter( "get_role_list", "modify_get_role_list_defaults", 10, 2 );
To remove a hook callback, use the example below.
remove_filter( "get_role_list", "modify_get_role_list_defaults", 10, 2 );
Please make sure provide the same callback function name, priority and number of arguments while removing the hook callback.
Flipper Code is a Premium WordPress Plugins development company and integrating new functionalites into WordPress sites in form of custom WordPress Plugins since 2012. If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.
