Changeset 10477

Timestamp:

01/27/2016 09:05:41 PM (9 years ago)

Author:

djpaul

Message:

Emails: add default filters for email headers and tokens.

See #6592. Props timersys, mercime, boonebgorges, hnla, DJPaul.

File:

• trunk/src/bp-core/bp-core-filters.php (modified) (1 diff)

trunk/src/bp-core/bp-core-filters.php

@@ -1089 +1089 @@
 
 /**
+ * Add custom headers to outgoing emails.
+ *
+ * @since 2.5.0
+ *
+ * @param array $headers
+ * @param string $property Name of property. Unused.
+ * @param string $transform Return value transformation. Unused.
+ * @param BP_Email $email Email object reference.
+ * @return array
+ */
+function bp_email_set_default_headers( $headers, $property, $transform, $email ) {
+    $headers['X-BuddyPress']      = bp_get_version();
+    $headers['X-BuddyPress-Type'] = $email->get( 'type' );
+
+    return $headers;
+}
+add_filter( 'bp_email_get_headers', 'bp_email_set_default_headers', 6, 4 );
+
+/**
+ * Add default email tokens.
+ *
+ * @since 2.5.0
+ *
+ * @param array $tokens Email tokens.
+ * @param string $property_name Unused.
+ * @param string $transform Unused.
+ * @param BP_Email $email Email being sent.
+ * @return array
+ */
+function bp_email_set_default_tokens( $tokens, $property_name, $transform, $email ) {
+    $tokens['site.admin-email'] = bp_get_option( 'admin_email' );
+    $tokens['site.url']         = home_url();
+
+    // These options are escaped with esc_html on the way into the database in sanitize_option().
+    $tokens['site.description'] = wp_specialchars_decode( bp_get_option( 'blogdescription' ), ENT_QUOTES );
+    $tokens['site.name']        = wp_specialchars_decode( bp_get_option( 'blogname' ), ENT_QUOTES );
+
+    // Default values for tokens set conditionally below.
+    $tokens['email.preheader'] = '';
+    $tokens['recipient.email'] = '';
+    $tokens['recipient.name']  = '';
+    $tokens['unsubscribe']     = '';
+
+
+    // Who is the email going to?
+    $recipient = $email->get( 'to' );
+    if ( $recipient ) {
+        $recipient = array_shift( $recipient );
+        $user_obj  = $recipient->get_user( 'search-email' );
+
+        $tokens['recipient.address'] = $recipient->get_address();
+        $tokens['recipient.name']    = $recipient->get_name();
+
+        if ( $user_obj ) {
+            // Unsubscribe link.
+            $tokens['unsubscribe'] = esc_url( sprintf(
+                '%s%s/notifications/',
+                bp_core_get_user_domain( $user_obj->ID ),
+                function_exists( 'bp_get_settings_slug' ) ? bp_get_settings_slug() : 'settings'
+            ) );
+        }
+    }
+
+    // Email preheader.
+    $post = $email->get_post_object();
+    if ( $post ) {
+        $tokens['email.preheader'] = sanitize_text_field( get_post_meta( $post->ID, 'bp_email_preheader', true ) );
+    }
+
+    return $tokens;
+}
+add_filter( 'bp_email_get_tokens', 'bp_email_set_default_tokens', 6, 4 );
+
+/**
  * Find and render the template for Email posts (the Customizer and admin previews).
  *