get_role_list

Filter Hook

Description

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

Hook Information

File Location	`wp-admin/includes/class-wp-users-list-table.php` View on GitHub
Hook Type	Filter
Line Number	`681`

Hook Parameters

Type	Name	Description
`string[]`	`$role_list`	An array of translated user role names keyed by role.
`WP_User`	`$user_object`	A WP_User object.

Usage Examples

Basic Usage

<?php
// Hook into get_role_list
add_filter('get_role_list', 'my_custom_filter', 10, 2);

function my_custom_filter($role_list, $user_object) {
    // Your custom filtering logic here
    return $role_list;
}

Source Code Context

wp-admin/includes/class-wp-users-list-table.php:681 - How this hook is used in WordPress core

<?php
 676  		 * @since 4.4.0
 677  		 *
 678  		 * @param string[] $role_list   An array of translated user role names keyed by role.
 679  		 * @param WP_User  $user_object A WP_User object.
 680  		 */
 681  		return apply_filters( 'get_role_list', $role_list, $user_object );
 682  	}
 683  }

PHP Documentation

<?php
/**
		 * Filters the returned array of translated role names for a user.
		 *
		 * @since 4.4.0
		 *
		 * @param string[] $role_list   An array of translated user role names keyed by role.
		 * @param WP_User  $user_object A WP_User object.
		 */

Quick Info

Hook Type: Filter
Parameters: 2
File: wp-admin/includes/class-wp-users-list-table.php

Links

WordPress Docs View Source Code Search Examples

Related Hooks

Related hooks will be displayed here in future updates.