bp_email

Fires inside __construct() method for BP_Email class.

Description

do_action( 'bp_email', (string) $email_type, (BP_Email) $instance ); 

Parameters (2)

0. $email_type (string)
Unique identifier for this type of email.
1. $instance (BP_Email)
Current instance of the email type class.

Usage

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

Defined (1)

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

/bp-core/classes/class-bp-email.php  
  1. do_action( 'bp_email', $email_type, $this );