bp_email_recipient_get_name
Filters the recipient's name before it's returned.
Description
Parameters (2)
- 0. $this_name (string)
- Recipient's name.
- 1. $instance (BP_Email)
-
$this
Current instance of the email recipient class.
Usage
- To run the hook, copy the example below.
- $this_name = apply_filters( 'bp_email_recipient_get_name', $this_name, $instance );
- if ( !empty( $this_name ) ) {
- // everything has led up to this point...
- }
- The following example is for adding a hook callback.
- // define the bp_email_recipient_get_name callback
- function filter_bp_email_recipient_get_name( $this_name, $instance ) {
- // make filter magic happen here...
- return $this_name;
- };
- // add the filter
- add_filter( 'bp_email_recipient_get_name', 'filter_bp_email_recipient_get_name', 10, 2 );
- To remove a hook callback, use the example below.
- // remove the filter
- remove_filter( 'bp_email_recipient_get_name', 'filter_bp_email_recipient_get_name', 10, 2 );
Defined (1)
The filter is defined in the following location(s).
- /bp-core/classes/class-bp-email-recipient.php
- return apply_filters( 'bp_email_recipient_get_name', $this->name, $this );