Contents

Code Reference Classes BP_Email_Recipient BP_Email_Recipient::__construct()

BP_Email_Recipient::__construct( string|array|int|WP_User $email_or_user, string $name = '' )

Constructor.

Description

Parameters

$email_or_user

(Required) Either an email address, user ID, WP_User object, or an array containing any combination of the above.

$name

(Optional) If $email_or_user is a string, this is the recipient's name.

Default value: ''

Source

File: bp-core/classes/class-bp-email-recipient.php

63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
public function __construct( $email_or_user, $name = '' ) {
    $name = sanitize_text_field( $name );
 
    // User ID, email address or WP_User object.
    if ( is_int( $email_or_user ) || ( is_string( $email_or_user ) && is_email( $email_or_user ) ) || is_object( $email_or_user ) ) {
        // We already have a WP user.
        if ( is_object( $email_or_user ) ) {
            $this->user_object = $email_or_user;
 
        // Query for WP user by user ID.
        } elseif ( is_int( $email_or_user ) ) {
            $this->user_object = get_user_by( 'id', $email_or_user );
        }
 
        // Set email address.
        if ( empty( $this->user_object ) && is_email( $email_or_user ) ) {
            $address = $email_or_user;
        }
 
    // Array or miscellaneous string.
    } else {
        if ( ! is_array( $email_or_user ) ) {
            $email_or_user = array( $email_or_user => $name );
        }
 
        // Handle numeric arrays.
        if ( is_int( key( $email_or_user ) ) ) {
            $address = current( $email_or_user );
        } else {
            $address = key( $email_or_user );
            $name    = current( $email_or_user );
        }
    }
 
    // Set address if we have one.
    if ( ! empty( $address ) ) {
        $this->address = sanitize_email( $address );
    }
 
    // Still no user object; try to query user by email address.
    if ( empty( $this->user_object ) ) {
        $this->get_user( 'search-email' );
    }
 
    // We have a user object; so set address and name from DB.
    if ( $this->user_object ) {
        // This is escaped with esc_html in bp_core_get_user_displayname()
        $wp_name = wp_specialchars_decode( bp_core_get_user_displayname( $this->user_object->ID ), ENT_QUOTES );
 
        $this->address = $this->user_object->user_email;
        $this->name    = sanitize_text_field( $wp_name );
        $this->avatar  = bp_core_fetch_avatar( array(
            'item_id' => $this->user_object->ID,
            'html'    => false
        ) );
    }
 
    // Custom name override.
    if ( $name ) {
        $this->name = $name;
    }
 
    /**
     * Fires inside __construct() method for BP_Email_Recipient class.
     *
     * @since BuddyPress 2.5.0
     *
     * @param string|array|int|WP_User $email_or_user Either an email address, user ID, WP_User object,
     *                                                or an array containing any combination of the above.
     * @param string $name If $email_or_user is a string, this is the recipient's name.
     * @param BP_Email_Recipient $this Current instance of the email type class.
     */
    do_action( 'bp_email_recipient', $email_or_user, $name, $this );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 2.5.0 Introduced.
Used By
Used By Description
bp-core/deprecated/buddypress/2.5.php: bp_core_deprecated_email_filters()

Add support for pre-2.5 email filters.
bp-core/classes/class-bp-email.php: BP_Email::set_to()

Set the email’s “to” address and name.
bp-core/classes/class-bp-email.php: BP_Email::set_from()

Set the email’s “from” address and name.
bp-core/classes/class-bp-email.php: BP_Email::set_reply_to()

Set the email’s “reply to” address and name.
bp-core/classes/class-bp-email.php: BP_Email::set_bcc()

Set the email’s “bcc” address and name.
bp-core/classes/class-bp-email.php: BP_Email::set_cc()

Set the email’s “cc” address and name.
Show 1 more used by Hide more used by

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.