bp_groups_get_group_type
Filters a groups's group type(s).
Description
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.
- $type = apply_filters( 'bp_groups_get_group_type', $type, $group_id, $single );
- if ( !empty( $type ) ) {
- // everything has led up to this point...
- }
- The following example is for adding a hook callback.
- // define the bp_groups_get_group_type callback
- function filter_bp_groups_get_group_type( $type, $group_id, $single ) {
- // make filter magic happen here...
- return $type;
- };
- // add the filter
- add_filter( 'bp_groups_get_group_type', 'filter_bp_groups_get_group_type', 10, 3 );
- To remove a hook callback, use the example below.
- // remove the filter
- 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
- return apply_filters( 'bp_groups_get_group_type', $type, $group_id, $single );