bp_groups_get_group_type

Filters a groups's group type(s).

Description

apply_filters( 'bp_groups_get_group_type', (string|array) $type, (int) $group_id, (bool) $single ); 

Parameters (3)

0. $type (string|array)
Group type.
1. $group_id (int)
ID of the group.
2. $single (bool)
Whether to return a single type string, or an array.

Usage

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

Defined (1)

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

/bp-groups/bp-groups-functions.php  
  1. return apply_filters( 'bp_groups_get_group_type', $type, $group_id, $single );