bbp_get_blog_roles()

Get the available roles minus Forums’ dynamic roles

Description

Return

(array)

Source

function bbp_get_blog_roles() {
 
    // Get WordPress's roles (returns $wp_roles global)
    $wp_roles  = bbp_get_wp_roles();
 
    // Apply the WordPress 'editable_roles' filter to let plugins ride along.
    //
    // We use this internally via bbp_filter_blog_editable_roles() to remove
    // any custom Forums roles that are added to the global.
    $the_roles = isset( $wp_roles->roles ) ? $wp_roles->roles : false;
    $all_roles = apply_filters( 'editable_roles', $the_roles );
 
    return apply_filters( 'bbp_get_blog_roles', $all_roles, $wp_roles );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r5064)	Introduced.

Uses

Uses
Uses	Description
bp-forums/core/capabilities.php: bbp_get_wp_roles()	Get the $wp_roles global without needing to declare it everywhere
bp-core/bp-core-caps.php: editable_roles	Filters the list of editable roles.

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/users/capabilities.php: bbp_get_user_blog_role()	Return a user’s blog role
bp-forums/users/template.php: bbp_edit_user_blog_role()	Output blog role selector (for user edit)

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.

Contents