bp_messages_thread_get_recipients

Filters the recipients of a message thread.

Description

apply_filters( 'bp_messages_thread_get_recipients', (array) $recipients, (int) $thread_id ); 

Parameters (2)

0. $recipients (array)
Array of recipient objects.
1. $thread_id (int)
ID of the current thread.

Usage

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

Defined (1)

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

/bp-messages/classes/class-bp-messages-thread.php  
  1. return apply_filters( 'bp_messages_thread_get_recipients', $recipients, $thread_id );