bbp_get_user_blog_role

The bbPress bbp get user blog role hook.

Description

apply_filters( 'bbp_get_user_blog_role', (unknown) $role, (unknown) $user_id, (unknown) $user ); 

Parameters (3)

0. $role (unknown)
The role.
1. $user_id (unknown)
The user id.
2. $user (unknown)
The user.

Usage

To run the hook, copy the example below.
  1. $role = apply_filters( 'bbp_get_user_blog_role', $role, $user_id, $user ); 
  2.  
  3. if ( !empty( $role ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the bbp_get_user_blog_role callback 
  2. function filter_bbp_get_user_blog_role( $role, $user_id, $user ) { 
  3. // make filter magic happen here... 
  4. return $role
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'bbp_get_user_blog_role', 'filter_bbp_get_user_blog_role', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'bbp_get_user_blog_role', 'filter_bbp_get_user_blog_role', 10, 3 ); 

Defined (1)

The filter is defined in the following location(s).

/includes/users/capabilities.php  
  1. return apply_filters( 'bbp_get_user_blog_role', $role, $user_id, $user );