groups_remove_member

Fires before the removal of a member from a group.

Description

do_action( 'groups_remove_member', (int) $group_id, (int) $user_id ); 

Parameters (2)

0. $group_id (int)
ID of the group being removed from.
1. $user_id (int)
ID of the user being removed.

Usage

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

Defined (1)

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

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