bp_email_recipient_get_user
Filters the WP_User object for this recipient before it's returned.
Description
apply_filters( 'bp_email_recipient_get_user', (WP_User) $this_user_object, (string) $transform, (BP_Email) $instance );
Parameters (3)
- 0. $this_user_object (WP_User)
-
WP_User
object for this recipient, or null if not set. - 1. $transform — Optional. (string)
- How the return value was transformed. Accepts raw (default) or search-email..
- 2. $instance (BP_Email)
-
$this
Current instance of the email recipient class.
Usage
- To run the hook, copy the example below.
- $this_user_object = apply_filters( 'bp_email_recipient_get_user', $this_user_object, $transform, $instance );
- if ( !empty( $this_user_object ) ) {
- // everything has led up to this point...
- }
- The following example is for adding a hook callback.
- // define the bp_email_recipient_get_user callback
- function filter_bp_email_recipient_get_user( $this_user_object, $transform, $instance ) {
- // make filter magic happen here...
- return $this_user_object;
- };
- // add the filter
- add_filter( 'bp_email_recipient_get_user', 'filter_bp_email_recipient_get_user', 10, 3 );
- To remove a hook callback, use the example below.
- // remove the filter
- remove_filter( 'bp_email_recipient_get_user', 'filter_bp_email_recipient_get_user', 10, 3 );
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_user', $this->user_object, $transform, $this );