bprwg_pending_user_activation_email_message

Filters the message to be sent to user upon activation.

Description

apply_filters( 'bprwg_pending_user_activation_email_message', (string) $filtered_message, (string) $pending_message, (WP_User) $user_info ); 

Parameters (3)

0. $filtered_message (string)
Message to be sent with placeholders changed.
1. $pending_message (string)
Original message before placeholders filtered.
2. $user_info (WP_User)
WP_User object for the newly activated user.

Usage

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

Defined (1)

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

/includes/core.php  
  1. $filtered_message = apply_filters( 'bprwg_pending_user_activation_email_message', $filtered_message, $pending_message, $user_info );