Contents

Code Reference Functions bbp_get_user_role()

bbp_get_user_role( int $user_id )

Return a user’s forums role

Description

Parameters

$user_id

(Required)

Return

(string)

Source

File: bp-forums/users/capabilities.php

109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
function bbp_get_user_role( $user_id = 0 ) {
 
    // Validate user id
    $user_id = bbp_get_user_id( $user_id );
    $user    = get_userdata( $user_id );
    $role    = false;
 
    // User has roles so look for a Forums one
    if ( ! empty( $user->roles ) ) {
 
        // Look for a Forums role
        $roles = array_intersect(
            array_values( $user->roles ),
            array_keys( bbp_get_dynamic_roles() )
        );
 
        // If there's a role in the array, use the first one. This isn't very
        // smart, but since roles aren't exactly hierarchical, and Forums
        // does not yet have a UI for multiple user roles, it's fine for now.
        if ( !empty( $roles ) ) {
            $role = array_shift( $roles );
        }
    }
 
    return apply_filters( 'bbp_get_user_role', $role, $user_id, $user );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
bbPress (r3860) Introduced.

Uses

Uses
Uses Description
bp-forums/core/capabilities.php: bbp_get_dynamic_roles()

Fetch a filtered list of forum roles that the current user is allowed to have.
bp-forums/users/template.php: bbp_get_user_id()

Return a validated user id
Used By
Used By Description
bp-forums/core/update.php: bbp_make_current_user_keymaster()

Hooked to the ‘bbp_activate’ action, this helper function automatically makes the current user a Key Master in the forums if they just activated Forums, regardless of the bbp_allow_global_access() setting.
bp-forums/users/capabilities.php: bbp_set_user_role()

Return a user’s main role
bp-forums/users/capabilities.php: bbp_profile_update_role()

Helper function hooked to ‘bbp_profile_update’ action to save or update user roles and capabilities.
bp-forums/users/capabilities.php: bbp_set_current_user_default_role()

Add the default role to the current user if needed
bp-forums/users/template.php: bbp_edit_user_forums_role()

Output forum role selector (for user edit)
bp-forums/users/template.php: bbp_get_user_display_role()

Return a user’s main role for display
Show 1 more used by Hide more used by

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.