bp_groups_get_total_groups_sql

Filters the SQL used to retrieve total group results.

Description

apply_filters( 'bp_groups_get_total_groups_sql', (number) $total_groups_sql, (array) $sql, (array) $r ); 

Parameters (3)

0. $total_groups_sql (number)
Concatenated SQL statement used for retrieving total group results.
1. $sql (array)
Array of SQL parts for the query.
2. $r (array)
Array of parsed arguments for the get method.

Usage

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

Defined (1)

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

/bp-groups/classes/class-bp-groups-group.php  
  1. $total_groups_sql = apply_filters( 'bp_groups_get_total_groups_sql', $total_groups_sql, $sql, $r );