bp_email_get_salutation

Gets the Recipient Salutation.

Description

(string) bp_email_get_salutation( (array) $settings = array() ); 

Returns (string)

The Recipient Salutation.

Parameters (1)

0. $settings — Optional. (array) => array()
Email Settings.

Usage

  1. if ( !function_exists( 'bp_email_get_salutation' ) ) { 
  2. require_once ABSPATH . PLUGINDIR . 'buddypress/bp-core/bp-core-template.php'; 
  3.  
  4. // Email Settings. 
  5. $settings = array(); 
  6.  
  7. // NOTICE! Understand what this does before running. 
  8. $result = bp_email_get_salutation($settings); 
  9.  

Defined (1)

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

/bp-core/bp-core-template.php  
  1. function bp_email_get_salutation( $settings = array() ) { 
  2. $token = '{{recipient.name}}'; 
  3.  
  4. /** 
  5. * Filters The Recipient Salutation inside the Email Template. 
  6. * @since 2.5.0 
  7. * @param string $value The Recipient Salutation. 
  8. * @param array $settings Email Settings. 
  9. * @param string $token The Recipient token. 
  10. */ 
  11. return apply_filters( 'bp_email_get_salutation', sprintf( _x( 'Hi %s, ', 'recipient salutation', buddypress ), $token ), $settings, $token );