Contents

Code Reference Classes BP_Email_Recipient

BP_Email_Recipient

Represents a recipient that an email will be sent to.

Description

Source

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

16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
class BP_Email_Recipient {
 
    /**
     * Recipient's email address.
     *
     * @since BuddyPress 2.5.0
     *
     * @var string
     */
    protected $address = '';
 
    /**
     * Recipient's name.
     *
     * @since BuddyPress 2.5.0
     *
     * @var string
     */
    protected $name = '';
 
    /**
     * Recipient's avatar.
     *
     * @since BuddyBoss 1.0.0
     *
     * @var string
     */
    protected $avatar = '';
 
    /**
     * Optional. A `WP_User` object relating to this recipient.
     *
     * @since BuddyPress 2.5.0
     *
     * @var WP_User
     */
    protected $user_object = null;
 
    /**
     * Constructor.
     *
     * @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 Optional. If $email_or_user is a string, this is the recipient's name.
     */
    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 );
    }
 
    /**
     * Get recipient's address.
     *
     * @since BuddyPress 2.5.0
     *
     * @return string
     */
    public function get_address() {
 
        /**
         * Filters the recipient's address before it's returned.
         *
         * @since BuddyPress 2.5.0
         *
         * @param string $address Recipient's address.
         * @param BP_Email $recipient $this Current instance of the email recipient class.
         */
        return apply_filters( 'bp_email_recipient_get_address', $this->address, $this );
    }
 
    /**
     * Get recipient's name.
     *
     * @since BuddyPress 2.5.0
     *
     * @return string
     */
    public function get_name() {
 
        /**
         * Filters the recipient's name before it's returned.
         *
         * @since BuddyPress 2.5.0
         *
         * @param string $name Recipient's name.
         * @param BP_Email $recipient $this Current instance of the email recipient class.
         */
        return apply_filters( 'bp_email_recipient_get_name', $this->name, $this );
    }
 
    /**
     * Get recipient's avatar.
     *
     * @since BuddyBoss 1.0.0
     *
     * @return string
     */
    public function get_avatar() {
 
        /**
         * Filters the recipient's avatar before it's returned.
         *
         * @since BuddyBoss 1.0.0
         *
         * @param string $name Recipient's avatar.
         * @param BP_Email $recipient $this Current instance of the email recipient class.
         */
        return apply_filters( 'bp_email_recipient_get_avatar', $this->avatar, $this );
    }
 
    /**
     * Get WP_User object for this recipient.
     *
     * @since BuddyPress 2.5.0
     *
     * @param string $transform Optional. How to transform the return value.
     *                          Accepts 'raw' (default) or 'search-email'.
     * @return WP_User|null WP_User object, or null if not set.
     */
    public function get_user( $transform = 'raw' ) {
 
        // If transform "search-email", find the WP_User if not already set.
        if ( $transform === 'search-email' && ! $this->user_object && $this->address ) {
            $this->user_object = get_user_by( 'email', $this->address );
        }
 
        /**
         * Filters the WP_User object for this recipient before it's returned.
         *
         * @since BuddyPress 2.5.0
         *
         * @param WP_User $name WP_User object for this recipient, or null if not set.
         * @param string $transform Optional. How the return value was transformed.
         *                          Accepts 'raw' (default) or 'search-email'.
         * @param BP_Email $recipient $this Current instance of the email recipient class.
         */
        return apply_filters( 'bp_email_recipient_get_user', $this->user_object, $transform, $this );
    }
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 2.5.0 Introduced.

Methods

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.