bbp_set_user_role( int $user_id, $new_role = '' )
Set a user’s role in the forums
Description Description
Parameters Parameters
- $user_id
-
(Required)
Return Return
(mixed) False if no change. String of new role if changed.
Source Source
File: includes/users/capabilities.php
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 ) ) { $user->add_role( $new_role ); } } // User does don exist so return false } else { $new_role = false; } // Filter & return return apply_filters( 'bbp_set_user_role', $new_role, $user_id, $user ); }
Changelog Changelog
Version | Description |
---|---|
2.1.0 | Introduced. |