groups_send_invites

Fires after the sending of invites for a group.

Description

do_action( 'groups_send_invites', (int) $group_id, (array) $invited_users, (int) $user_id ); 

Parameters (3)

0. $group_id (int)
ID of the group who's being invited to.
1. $invited_users (array)
Array of users being invited to the group.
2. $user_id (int)
ID of the inviting user.

Usage

To run the hook, copy the example below.
  1. // run the action 
  2. do_action( 'groups_send_invites', $group_id, $invited_users, $user_id ); 
The following example is for adding a hook callback.
  1. // define the groups_send_invites callback 
  2. function action_groups_send_invites( $group_id, $invited_users, $user_id ) { 
  3. // make action magic happen here... 
  4. }; 
  5.  
  6. // add the action 
  7. add_action( 'groups_send_invites', 'action_groups_send_invites', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the action 
  2. remove_action( 'groups_send_invites', 'action_groups_send_invites', 10, 3 ); 

Defined (1)

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

/bp-groups/bp-groups-functions.php  
  1. do_action( 'groups_send_invites', $group_id, $invited_users, $user_id );