Contents

Code Reference Functions bbp_get_dynamic_roles()

bbp_get_dynamic_roles()

Fetch a filtered list of forum roles that the current user is allowed to have.

Description

Simple function who’s main purpose is to allow filtering of the list of forum roles so that plugins can remove inappropriate ones depending on the situation or user making edits.

Specifically because without filtering, anyone with the edit_users capability can edit others to be administrators, even if they are only editors or authors. This filter allows admins to delegate user management.

Return

(array)

Source

File: bp-forums/core/capabilities.php 

function bbp_get_dynamic_roles() {
	return (array) apply_filters( 'bbp_get_dynamic_roles', array(

		// Keymaster
		bbp_get_keymaster_role() => array(
			'name'         => 'Keymaster',
			'capabilities' => bbp_get_caps_for_role( bbp_get_keymaster_role() )
		),

		// Moderator
		bbp_get_moderator_role() => array(
			'name'         => 'Moderator',
			'capabilities' => bbp_get_caps_for_role( bbp_get_moderator_role() )
		),

		// Participant
		bbp_get_participant_role() => array(
			'name'         => 'Participant',
			'capabilities' => bbp_get_caps_for_role( bbp_get_participant_role() )
		),

		// Spectator
		bbp_get_spectator_role() => array(
			'name'         => 'Spectator',
			'capabilities' => bbp_get_caps_for_role( bbp_get_spectator_role() )
		),

		// Blocked
		bbp_get_blocked_role() => array(
			'name'         => 'Blocked',
			'capabilities' => bbp_get_caps_for_role( bbp_get_blocked_role() )
		)
	) );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
bbPress (r4284) Introduced.

Uses

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

The keymaster role for Forums users
bp-forums/core/capabilities.php: bbp_get_moderator_role()

The moderator role for Forums users
bp-forums/core/capabilities.php: bbp_get_participant_role()

The participant role for registered user that can participate in forums
bp-forums/core/capabilities.php: bbp_get_spectator_role()

The spectator role is for registered users without any capabilities
bp-forums/core/capabilities.php: bbp_get_blocked_role()

The blocked role is for registered users that cannot spectate or participate
bp-forums/core/capabilities.php: bbp_get_caps_for_role()

Returns an array of capabilities based on the role that is being requested.
Show 1 more use Hide more uses
Used By
Used By Description
bp-forums/users/capabilities.php: bbp_is_valid_role()

Check if a role ID is valid
bp-forums/admin/users.php: BBP_Users_Admin::remove_forum_roles()

Remove bbPress’s dynamic roles from user role list
bp-forums/core/capabilities.php: bbp_filter_blog_editable_roles()

Removes the Forums roles from the editable roles array
bp-forums/core/capabilities.php: bbp_remove_roles()

Removes Forums-specific user roles.
bp-forums/core/capabilities.php: _bbp_reinit_dynamic_roles()

This is necessary because in a few places (noted below) WordPress initializes a blog’s roles directly from the database option. When this happens, the $wp_roles global gets flushed, causing a user to magically lose any dynamically assigned roles or capabilities when $current_user in refreshed.
bp-forums/core/capabilities.php: bbp_get_dynamic_role_name()

Gets a translated role name from a role ID
bp-forums/core/capabilities.php: bbp_add_forums_roles()

Add the Forums roles to the $wp_roles global.
bp-forums/users/capabilities.php: bbp_get_user_role()

Return a user’s forums role
bp-forums/users/template.php: bbp_edit_user_forums_role()

Output forum role selector (for user edit)
Show 4 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.