groups_get_groups

Filters the collection of groups based on parsed parameters.

Description

apply_filters( 'groups_get_groups', (array) $array ); 

Parameters (1)

0. $array (array) => array( &$groups, &$r )
The array.

Usage

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

Defined (1)

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

/bp-groups/bp-groups-functions.php  
  1. return apply_filters_ref_array( 'groups_get_groups', array( &$groups, &$r ) );