bp_email_get_<property_name>

Filters the value of the specified email property before transformation.

Description

apply_filters( 'bp_email_get_<property_name>', (string) $this_property_name, (string) $property_name, (string) $transform, (BP_Email) $instance ); 

This is a dynamic filter dependent on the specified key.

Parameters (4)

0. $this_property_name (string)
The this property name.
1. $property_name (string)
The property name.
2. $transform (string)
How to transform the return value. Accepts raw (default) or replace-tokens..
3. $instance (BP_Email)
Current instance of the email type class.

Usage

To run the hook, copy the example below.
  1. $this_property_name = apply_filters( 'bp_email_get_{$property_name}', $this_property_name, $property_name, $transform, $instance ); 
  2.  
  3. if ( !empty( $this_property_name ) ) { 
  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_<property_name> callback 
  2. function filter_bp_email_get_property_name( $this_property_name, $property_name, $transform, $instance ) { 
  3. // make filter magic happen here... 
  4. return $this_property_name
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( "bp_email_get_{$property_name}", 'filter_bp_email_get_property_name', 10, 4 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( "bp_email_get_{$property_name}", 'filter_bp_email_get_property_name', 10, 4 ); 

Defined (1)

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

/bp-core/classes/class-bp-email.php  
  1. $retval = apply_filters( "bp_email_get_{$property_name}", $this->$property_name, $property_name, $transform, $this );