bp_get_total_unread_messages_count

Filters the unread messages count for the current inbox.

Description

apply_filters( 'bp_get_total_unread_messages_count', (number) $bp_messages_thread ); 

Parameters (1)

0. $bp_messages_thread (number) => BP_Messages_Thread::get_inbox_count()
Unread messages count for the current inbox.

Usage

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

Defined (1)

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

/bp-messages/bp-messages-template.php  
  1. return apply_filters( 'bp_get_total_unread_messages_count', BP_Messages_Thread::get_inbox_count() );