<!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][10478] trunk/src/bp-core/bp-core-functions.php: Emails: introducing `bp_send_email`, which is our replacement for `wp_mail`.</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/10478">10478</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/10478","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:12:25 +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: introducing `bp_send_email`, which is our replacement for `wp_mail`.
As `wp_mail` is a pluggable function, if we detect it has been re-declared, or if something has filtered to enable HTML emails, BuddyPress will fallback and let `wp_mail` send the email for us. This maintains compatibility for customised sites until mail delivery plugins are updated to work with BuddyPress (or new plugins are written).
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="#trunksrcbpcorebpcorefunctionsphp">trunk/src/bp-core/bp-core-functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcorefunctionsphp"></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-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-functions.php 2016-01-27 21:05:41 UTC (rev 10477)
+++ trunk/src/bp-core/bp-core-functions.php 2016-01-27 21:12:25 UTC (rev 10478)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2746,7 +2746,230 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'view_item' => _x( 'View Email Situation', 'email type taxonomy label', 'buddypress' ),
</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">+
+
+/** Email *****************************************************************/
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Get an BP_Email object for the specified email type.
+ *
+ * This function pre-populates the object with the subject, content, and template from the appropriate
+ * email post type item. It does not replace placeholder tokens in the content with real values.
+ *
+ * @since 2.5.0
+ *
+ * @param string $email_type Unique identifier for a particular type of email.
+ * @return BP_Email|WP_Error BP_Email object, or WP_Error if there was a problem.
+ */
+function bp_get_email( $email_type ) {
+ $args = array(
+ 'no_found_rows' => true,
+ 'numberposts' => 1,
+ 'post_status' => 'publish',
+ 'post_type' => bp_get_email_post_type(),
+ 'suppress_filters' => false,
+
+ 'tax_query' => array(
+ array(
+ 'field' => 'slug',
+ 'taxonomy' => bp_get_email_tax_type(),
+ 'terms' => $email_type,
+ )
+ ),
+ );
+
+ /**
+ * Filters arguments used to find an email post type object.
+ *
+ * @since 2.5.0
+ *
+ * @param array $args Arguments for get_posts() used to fetch a post object.
+ * @param string $email_type Unique identifier for a particular type of email.
+ */
+ $args = apply_filters( 'bp_get_email_args', $args, $email_type );
+ $post = get_posts( $args );
+ if ( ! $post ) {
+ return new WP_Error( 'missing_email', __FUNCTION__, array( $email_type, $args ) );
+ }
+
+ /**
+ * Filters arguments used to create the BP_Email object.
+ *
+ * @since 2.5.0
+ *
+ * @param WP_Post $post Post object containing the contents of the email.
+ * @param string $email_type Unique identifier for a particular type of email.
+ * @param array $args Arguments used with get_posts() to fetch a post object.
+ * @param WP_Post[] All posts retrieved by get_posts( $args ). May only contain $post.
+ */
+ $post = apply_filters( 'bp_get_email_post', $post[0], $email_type, $args, $post );
+ $email = new BP_Email( $email_type );
+
+
+ /*
+ * Set some email properties for convenience.
+ */
+
+ // Post object (sets subject, content, template).
+ $email->set_post_object( $post );
+
+ /**
+ * Filters the BP_Email object returned by bp_get_email().
+ *
+ * @since 2.5.0
+ *
+ * @param BP_Email $email An object representing a single email, ready for mailing.
+ * @param WP_Post $post Post object containing the contents of the email.
+ * @param string $email_type Unique identifier for a particular type of email.
+ * @param array $args Arguments used with get_posts() to fetch a post object.
+ * @param WP_Post[] All posts retrieved by get_posts( $args ). May only contain $post.
+ */
+ return apply_filters( 'bp_get_email', $email, $email_type, $args, $post );
+}
+
+/**
+ * Send email, similar to WordPress' wp_mail().
+ *
+ * A true return value does not automatically mean that the user received the
+ * email successfully. It just only means that the method used was able to
+ * process the request without any errors.
+ *
+ * @since 2.5.0
+ *
+ * @param string $email_type Type of email being sent.
+ * @param string|array|int|WP_User $to Either a email address, user ID, WP_User object,
+ * or an array containg the address and name.
+ * @param array $args {
+ * Optional. Array of extra. parameters.
+ *
+ * @type array $tokens Optional. Assocative arrays of string replacements for the email.
+ * }
+ * @return bool|WP_Error True if the email was sent successfully. Otherwise, a WP_Error object
+ * describing why the email failed to send. The contents will vary based
+ * on the email delivery class you are using.
+ */
+function bp_send_email( $email_type, $to, $args = array() ) {
+ static $is_default_wpmail = null;
+ static $wp_html_emails = null;
+
+ // Has wp_mail() been filtered to send HTML emails?
+ if ( is_null( $wp_html_emails ) ) {
+ /** This filter is documented in wp-includes/pluggable.php */
+ $wp_html_emails = apply_filters( 'wp_mail_content_type', 'text/plain' ) === 'text/html';
+ }
+
+ // wp_mail() is a pluggable function. Has it been re-defined by another plugin?
+ if ( is_null( $is_default_wpmail ) ) {
+ try {
+ $mirror = new ReflectionFunction( 'wp_mail' );
+ $is_default_wpmail = substr( $mirror->getFileName(), -strlen( 'pluggable.php' ) ) === 'pluggable.php';
+ } catch ( Exception $e ) {
+ $is_default_wpmail = true;
+ }
+ }
+
+ $args = bp_parse_args( $args, array(
+ 'tokens' => array(),
+ ), 'send_email' );
+
+
+ /*
+ * Build the email.
+ */
+
+ $email = bp_get_email( $email_type );
+ if ( is_wp_error( $email ) ) {
+ return $email;
+ }
+
+ // From, subject, content are set automatically.
+ $email->set_to( $to );
+ $email->set_tokens( $args['tokens'] );
+
+ $status = $email->validate();
+ if ( is_wp_error( $status ) ) {
+ return $status;
+ }
+
+ /**
+ * Filter this to skip BP's email handling and instead send everything to wp_mail().
+ *
+ * This is done if wp_mail_content_type() has been configured for HTML,
+ * or if wp_mail() has been redeclared (it's a pluggable function).
+ *
+ * @since 2.5.0
+ *
+ * @param bool $use_wp_mail Whether to fallback to the regular wp_mail() function or not.
+ */
+ $must_use_wpmail = apply_filters( 'bp_mail_use_wp_mail', $wp_html_emails || ! $is_default_wpmail );
+
+ if ( $must_use_wpmail ) {
+ $to = $email->get( 'to' );
+
+ return wp_mail(
+ array_shift( $to )->get_address(),
+ $email->get( 'subject', 'replace-tokens' ),
+ $email->get( 'content_plaintext', 'replace-tokens' )
+ );
+ }
+
+
+ /*
+ * Send the email.
+ */
+
+ /**
+ * Filter the email delivery class.
+ *
+ * Defaults to BP_PHPMailer, which as you can guess, implements PHPMailer.
+ *
+ * @since 2.5.0
+ *
+ * @param string $deliver_class The email delivery class name.
+ * @param string $email_type Type of email being sent.
+ * @param string[]|string $to Array or comma-separated list of email addresses to the email to.
+ * @param array $args {
+ * Optional. Array of extra parameters.
+ *
+ * @type array $tokens Optional. Assocative arrays of string replacements for the email.
+ * }
+ */
+ $delivery_class = apply_filters( 'bp_send_email_delivery_class', 'BP_PHPMailer', $email_type, $to, $args );
+ if ( ! class_exists( $delivery_class ) ) {
+ return new WP_Error( 'missing_class', __CLASS__, $this );
+ }
+
+ $delivery = new $delivery_class();
+ $status = $delivery->bp_email( $email );
+
+ if ( is_wp_error( $status ) ) {
+ /**
+ * Fires after BuddyPress has tried - and failed - to send an email.
+ *
+ * @since 2.5.0
+ *
+ * @param WP_Error $status A WP_Error object describing why the email failed to send. The contents
+ * will vary based on the email delivery class you are using.
+ * @param BP_Email $email The email we tried to send.
+ */
+ do_action( 'bp_send_email_failure', $status, $email );
+
+ } else {
+ /**
+ * Fires after BuddyPress has succesfully sent an email.
+ *
+ * @since 2.5.0
+ *
+ * @param bool $status True if the email was sent successfully.
+ * @param BP_Email $email The email sent.
+ */
+ do_action( 'bp_send_email_success', $status, $email );
+ }
+
+ return $status;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Return email appearance settings.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span></span></pre>
</div>
</div>
</body>
</html>