bbp_get_user_display_role( int $user_id )
Return a user’s main role for display
Description Description
Parameters Parameters
- $user_id
-
(Required)
Return Return
(string)
Source Source
File: includes/users/template.php
function bbp_get_user_display_role( $user_id = 0 ) {
// Validate user id
$user_id = bbp_get_user_id( $user_id );
// User is not registered
if ( empty( $user_id ) ) {
$role = esc_html__( 'Guest', 'bbpress' );
// User is not active
} elseif ( bbp_is_user_inactive( $user_id ) ) {
$role = esc_html__( 'Inactive', 'bbpress' );
// User have a role
} else {
$role_id = bbp_get_user_role( $user_id );
$role = bbp_get_dynamic_role_name( $role_id );
}
// No role found so default to generic "Member"
if ( empty( $role ) ) {
$role = esc_html__( 'Member', 'bbpress' );
}
// Filter & return
return apply_filters( 'bbp_get_user_display_role', $role, $user_id );
}
Changelog Changelog
| Version | Description |
|---|---|
| 2.1.0 | Introduced. |