bp_messages_recipients

Filters the array of recipients to receive the composed message.

Description

apply_filters( 'bp_messages_recipients', (array) $recipients ); 

Parameters (1)

0. $recipients (array)
Array of recipients to receive message.

Usage

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

Defined (1)

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

/bp-messages/bp-messages-actions.php  
  1. $recipients = apply_filters( 'bp_messages_recipients', $recipients );