bp_get_thread_recipients_count

Filters the total number of recipients in a thread.

Description

apply_filters( 'bp_get_thread_recipients_count', (number) $count ); 

Parameters (1)

0. $count (number) => count( $thread_template->thread->recipients )
Total recipients number.

Usage

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

Defined (1)

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

/bp-messages/bp-messages-template.php  
  1. return (int) apply_filters( 'bp_get_thread_recipients_count', count( $thread_template->thread->recipients ) );