bp_get_new_group_invite_friend_list

Filters the array of friends who can be invited to a group.

Description

apply_filters( 'bp_get_new_group_invite_friend_list', (array) $items, (array) $r, (array) $args ); 

Parameters (3)

0. $items (array)
Array of friends.
1. $r (array)
Parsed arguments from bp_get_new_group_invite_friend_list()
2. $args (array)
Unparsed arguments from bp_get_new_group_invite_friend_list()

Usage

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

Defined (1)

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

/bp-groups/bp-groups-template.php  
  1. $invitable_friends = apply_filters( 'bp_get_new_group_invite_friend_list', $items, $r, $args );