Contents

Code Reference Functions bbp_set_user_role()

bbp_set_user_role( int $user_id,  $new_role = '' )

Return a user’s main role

Description

Parameters

$user_id

(Required)

Return

(string)

Source

File: bp-forums/users/capabilities.php

56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
function bbp_set_user_role( $user_id = 0, $new_role = '' ) {
 
    // Validate user id
    $user_id = bbp_get_user_id( $user_id, false, false );
    $user    = get_userdata( $user_id );
 
    // User exists
    if ( !empty( $user ) ) {
 
        // Get users forum role
        $role = bbp_get_user_role( $user_id );
 
        // User already has this role so no new role is set
        if ( $new_role === $role ) {
            $new_role = false;
 
        // Users role is different than the new role
        } else {
 
            // Remove the old role
            if ( ! empty( $role ) ) {
                $user->remove_role( $role );
            }
 
            // Add the new role
            if ( !empty( $new_role ) ) {
 
                // Make sure Forums roles are added
                bbp_add_forums_roles();
 
                $user->add_role( $new_role );
            }
        }
 
    // User does don exist so return false
    } else {
        $new_role = false;
    }
 
    return apply_filters( 'bbp_set_user_role', $new_role, $user_id, $user );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
bbPress (r3860) Introduced.
Used By
Used By Description
bp-forums/admin/tools.php: bbp_admin_repair_user_roles()

This repair tool will map each user of the current site to their respective forums role. By default, Admins will be Key Masters, and every other role will be the default role defined in Settings > Forums (Participant).
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_profile_update_role()

Helper function hooked to ‘bbp_profile_update’ action to save or update user roles and capabilities.

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.