get_role_list

Filters the returned array of roles for a user.

Description

apply_filters( 'get_role_list', (array) $role_list, (WP_User) $user_object ); 

Parameters (2)

0. $role_list (array)
An array of user roles.
1. $user_object (WP_User)
A WP_User object.

Usage

To run the hook, copy the example below.
  1. $role_list = apply_filters( 'get_role_list', $role_list, $user_object ); 
  2.  
  3. if ( !empty( $role_list ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the get_role_list callback 
  2. function filter_get_role_list( $role_list, $user_object ) { 
  3. // make filter magic happen here... 
  4. return $role_list
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'get_role_list', 'filter_get_role_list', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'get_role_list', 'filter_get_role_list', 10, 2 ); 

Defined (1)

The filter is defined in the following location(s).

/wp-admin/includes/class-wp-users-list-table.php  
  1. return apply_filters( 'get_role_list', $role_list, $user_object );