bbp_is_user_subscribed_to_forum

The bbPress bbp is user subscribed to forum hook.

Description

apply_filters( 'bbp_is_user_subscribed_to_forum', (bool) $bool_retval, (unknown) $user_id, (unknown) $forum_id, (unknown) $subscribed_ids ); 

Parameters (4)

0. $bool_retval (bool) => (bool) $retval
The bool retval.
1. $user_id (unknown)
The user id.
2. $forum_id (unknown)
The forum id.
3. $subscribed_ids (unknown)
The subscribed ids.

Usage

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

Defined (1)

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

/includes/users/functions.php  
  1. return (bool) apply_filters( 'bbp_is_user_subscribed_to_forum', (bool) $retval, $user_id, $forum_id, $subscribed_ids );