<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][10477] trunk/src/bp-core/bp-core-filters.php: Emails: add default filters for email headers and tokens.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/10477">10477</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/10477","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>djpaul</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-01-27 21:05:41 +0000 (Wed, 27 Jan 2016)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Emails: add default filters for email headers and tokens.
See <a href="http://buddypress.trac.wordpress.org/ticket/6592">#6592</a>. Props timersys, mercime, boonebgorges, hnla, DJPaul.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcorefiltersphp">trunk/src/bp-core/bp-core-filters.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcorefiltersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/bp-core-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-filters.php 2016-01-27 21:03:19 UTC (rev 10476)
+++ trunk/src/bp-core/bp-core-filters.php 2016-01-27 21:05:41 UTC (rev 10477)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1088,6 +1088,80 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'bp_email_get_property', 'bp_email_add_link_color_to_template', 6, 3 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 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 );
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Find and render the template for Email posts (the Customizer and admin previews).
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Misuses the `template_include` filter which expects a string, but as we need to replace
</span></span></pre>
</div>
</div>
</body>
</html>