bbp_get_user_role_map()

Return a map of WordPress roles to Forums roles. Used to automatically grant appropriate Forums roles to WordPress users that wouldn’t already have a role in the forums. Also guarantees WordPress admins get the Keymaster role.

Description

Return

(array) Filtered array of WordPress roles to Forums roles

Source

File: bp-forums/users/capabilities.php

function bbp_get_user_role_map() {

	// Get the default role once here
	$default_role = bbp_get_default_role();

	// Return filtered results, forcing admins to keymasters.
	return (array) apply_filters( 'bbp_get_user_role_map', array (
		'administrator' => bbp_get_keymaster_role(),
		'editor'        => $default_role,
		'author'        => $default_role,
		'contributor'   => $default_role,
		'subscriber'    => $default_role
	) );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r4334)	Introduced.

Uses

Uses
Uses	Description
bp-forums/core/capabilities.php: bbp_get_keymaster_role()	The keymaster role for Forums users
bp-forums/core/options.php: bbp_get_default_role()	Is this forum available to all users on all sites in this installation?

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_set_current_user_default_role()	Add the default role to the current user if needed

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