groups_get_current_group

Filters the BP_Groups_Group object corresponding to the current group.

Description

apply_filters( 'groups_get_current_group', (BP_Groups_Group) $current_group ); 

Parameters (1)

0. $current_group (BP_Groups_Group)
Current BP_Groups_Group object.

Usage

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

Defined (1)

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

/bp-groups/bp-groups-functions.php  
  1. return apply_filters( 'groups_get_current_group', $current_group );