bp_email_get_salutation

Filters The Recipient Salutation inside the Email Template.

Description

apply_filters( 'bp_email_get_salutation', (string) $sprintf, (array) $settings, (string) $token ); 

Parameters (3)

0. $sprintf (string) => sprintf( _x( 'Hi %s, ', 'recipient salutation', 'buddypress' ), $token )
The Recipient Salutation.
1. $settings (array)
Email Settings.
2. $token (string)
The Recipient token.

Usage

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

Defined (1)

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

/bp-core/bp-core-template.php  
  1. return apply_filters( 'bp_email_get_salutation', sprintf( _x( 'Hi %s, ', 'recipient salutation', 'buddypress' ), $token ), $settings, $token );