bbp_get_user_subscribed_forum_ids

The bbPress bbp get user subscribed forum ids hook.

Description

apply_filters( 'bbp_get_user_subscribed_forum_ids', (unknown) $subscriptions, (unknown) $user_id ); 

Parameters (2)

0. $subscriptions (unknown)
The subscriptions.
1. $user_id (unknown)
The user id.

Usage

To run the hook, copy the example below.
  1. $subscriptions = apply_filters( 'bbp_get_user_subscribed_forum_ids', $subscriptions, $user_id ); 
  2.  
  3. if ( !empty( $subscriptions ) ) { 
  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_subscribed_forum_ids callback 
  2. function filter_bbp_get_user_subscribed_forum_ids( $subscriptions, $user_id ) { 
  3. // make filter magic happen here... 
  4. return $subscriptions
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'bbp_get_user_subscribed_forum_ids', 'filter_bbp_get_user_subscribed_forum_ids', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'bbp_get_user_subscribed_forum_ids', 'filter_bbp_get_user_subscribed_forum_ids', 10, 2 ); 

Defined (1)

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

/includes/users/functions.php  
  1. return (array) apply_filters( 'bbp_get_user_subscribed_forum_ids', $subscriptions, $user_id );