bp_get_blogs_pagination_count

Filters the "Viewing x-y of z blogs" pagination message.

Description

apply_filters( 'bp_get_blogs_pagination_count', (string) $message, (string) $from_num, (string) $to_num, (number) $total ); 

Parameters (4)

0. $message (string)
"Viewing x-y of z blogs" text.
1. $from_num (string)
Total amount for the low value in the range.
2. $to_num (string)
Total amount for the high value in the range.
3. $total (number)
Total amount of blogs found.

Usage

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

Defined (1)

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

/bp-blogs/bp-blogs-template.php  
  1. return apply_filters( 'bp_get_blogs_pagination_count', $message, $from_num, $to_num, $total );