bp_messages_thread_current_threads

Filters the results of the query for a user's message threads.

Description

apply_filters( 'bp_messages_thread_current_threads', (callback) $array ); 

Parameters (1)

0. $array — Optional. (callback) => array( 'threads' => &$threads, 'total' => (int) $total_threads )

Usage

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

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_current_threads', array(