bpbbpst_list_recipients

The Buddy-bbPress Support Topic bpbbpst list recipients hook.

Description

apply_filters( 'bpbbpst_list_recipients', (unknown) $recipients, (unknown) $context, (unknown) $forum_id ); 

Parameters (3)

0. $recipients (unknown)
The recipients.
1. $context (unknown)
The context.
2. $forum_id (unknown)
The forum id.

Usage

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

Defined (1)

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

/includes/functions.php  
  1. return apply_filters( 'bpbbpst_list_recipients', $recipients, $context, $forum_id );