bp_xprofile_get_groups

Filters a set of field groups, populated with fields and field data.

Description

apply_filters( 'bp_xprofile_get_groups', (array) $groups, (array) $args ); 

Parameters (2)

0. $groups (array)
Array of field groups and field data.
1. $args (array)
Array of arguments used to query for groups.

Usage

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

Defined (1)

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

/bp-xprofile/bp-xprofile-functions.php  
  1. return apply_filters( 'bp_xprofile_get_groups', $groups, $args );