Changeset 12353

Timestamp:

03/06/2019 04:31:35 PM (8 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.

Location:

trunk/src

Files:

• bp-core/classes/class-bp-email-address.php (added)
• bp-core/classes/class-bp-email-participant.php (added)
• bp-core/classes/class-bp-email-recipient.php (modified) (8 diffs)
• bp-core/classes/class-bp-email-sender.php (added)
• bp-core/classes/class-bp-email.php (modified) (5 diffs)
• class-buddypress.php (modified) (1 diff)

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 );
         }
 

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

@@ -66 +66 @@
          * @since 2.5.0
          *
-         * @var BP_Email_Recipient Sender details.
+         * @var BP_Email_Sender Sender details.
          */
         protected $from = null;
@@ -102 +102 @@
          * @since 2.5.0
          *
-         * @var BP_Email_Recipient "Reply to" details.
+         * @var BP_Email_Sender "Reply to" details.
          */
         protected $reply_to = null;
@@ -431 +431 @@
          * @param string $transform Optional. How to transform the return value.
          *                          Accepts 'raw' (default) or 'replace-tokens'.
-         * @return BP_Email_Recipient "From" recipient.
+         * @return BP_Email_Sender "From" recipient.
          */
         public function get_from( $transform = 'raw' ) {
@@ -739 +739 @@
          */
         public function set_from( $email_address, $name = '' ) {
-                $from = new BP_Email_Recipient( $email_address, $name );
+                $from = new BP_Email_Sender();
+
+                $from->set_address( $email_address );
+                $from->set_name( $name );
 
                 /**
@@ -811 +814 @@
          */
         public function set_reply_to( $email_address, $name = '' ) {
-                $reply_to = new BP_Email_Recipient( $email_address, $name );
+                $reply_to = new BP_Email_Sender();
+
+                $reply_to->set_address( $email_address );
+                $reply_to->set_name( $name );
 
                 /**

trunk/src/class-buddypress.php

@@ -556 +556 @@
                         'BP_Date_Query'                => 'core',
                         'BP_Email_Delivery'            => 'core',
+                        'BP_Email_Address'             => 'core',
                         'BP_Email_Recipient'           => 'core',
+                        'BP_Email_Sender'              => 'core',
+                        'BP_Email_Participant'         => 'core',
                         'BP_Email'                     => 'core',
                         'BP_Embed'                     => 'core',