bp_has_groups

Filters whether or not there are groups to iterate over for the groups loop.

Description

apply_filters( 'bp_has_groups', (bool) $groups_template_has_groups, (BP_Groups_Template) $groups_template, (array) $r ); 

Parameters (3)

0. $groups_template_has_groups (bool)
Whether or not there are groups to iterate over.
1. $groups_template (BP_Groups_Template)
BP_Groups_Template object based on parsed arguments.
2. $r (array)
Array of parsed arguments for the query.

Usage

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

Defined (1)

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

/bp-groups/bp-groups-template.php  
  1. return apply_filters( 'bp_has_groups', $groups_template->has_groups(), $groups_template, $r );