bp_send_email_success

Fires after BuddyPress has succesfully sent an email.

Description

do_action( 'bp_send_email_success', (bool) $status, (BP_Email) $email ); 

Parameters (2)

0. $status (bool)
True if the email was sent successfully.
1. $email (BP_Email)
The email sent.

Usage

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

Defined (1)

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

/bp-core/bp-core-functions.php  
  1. do_action( 'bp_send_email_success', $status, $email );