Changeset 12353 for trunk/src/bp-core/classes/class-bp-email-recipient.php

Timestamp:

03/06/2019 04:31:35 PM (7 years ago)

Author:

boonebgorges

Message:

Emails: Improve performance when setting Reply-To and From headers.

The new BP_Email_Participant framework allows the Reply-To and From email
headers to be set without requiring an empty and potentially expensive WP
user lookup.

Fixes #8003.

File:

• trunk/src/bp-core/classes/class-bp-email-recipient.php (modified) (8 diffs)

trunk/src/bp-core/classes/class-bp-email-recipient.php

@@ -15 +15 @@
  * @since 2.5.0
  */
-class BP_Email_Recipient {
-
-    /**
-     * Recipient's email address.
-     *
-     * @since 2.5.0
-     *
-     * @var string
-     */
-    protected $address = '';
-
-    /**
-     * Recipient's name.
-     *
-     * @since 2.5.0
-     *
-     * @var string
-     */
-    protected $name = '';
+class BP_Email_Recipient extends BP_Email_Participant {
 
     /**
@@ -89 +71 @@
         // Set address if we have one.
         if ( ! empty( $address ) ) {
-            $this->address = sanitize_email( $address );
+            $this->set_address( sanitize_email( $address ) );
         }
 
@@ -102 +84 @@
             $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->set_address( $this->user_object->user_email );
+            $this->set_name( $wp_name );
 
         }
@@ -109 +91 @@
         // Custom name override.
         if ( $name ) {
-            $this->name = $name;
+            $this->set_name( $name );
         }
 
@@ -133 +115 @@
      */
     public function get_address() {
+        $address = parent::get_address();
 
         /**
@@ -139 +122 @@
          * @since 2.5.0
          *
-         * @param string $address Recipient's address.
-         * @param BP_Email $recipient $this Current instance of the email recipient class.
+         * @param string             $address   Recipient's address.
+         * @param BP_Email_Recipient $recipient Current instance of the email recipient class.
          */
-        return apply_filters( 'bp_email_recipient_get_address', $this->address, $this );
+        return apply_filters( 'bp_email_recipient_get_address', $address, $this );
     }
 
@@ -153 +136 @@
      */
     public function get_name() {
+        $name = parent::get_name();
 
         /**
@@ -159 +143 @@
          * @since 2.5.0
          *
-         * @param string $name Recipient's name.
-         * @param BP_Email $recipient $this Current instance of the email recipient class.
+         * @param string             $name      Recipient's name.
+         * @param BP_Email_Recipient $recipient Current instance of the email recipient class.
          */
-        return apply_filters( 'bp_email_recipient_get_name', $this->name, $this );
+        return apply_filters( 'bp_email_recipient_get_name', $name, $this );
     }