Changeset 11401

Timestamp:

01/28/2017 11:48:41 AM (8 years ago)

Author:

djpaul

Message:

Emails: add action before email is validated and sent.

Allows third-party plugins to customise the email after BuddyPress has built it.

Fixes #7427

Props mahype

File:

• trunk/src/bp-core/bp-core-functions.php (modified) (2 diffs)

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

@@ -3090 +3090 @@
  *                                             or an array containg the address and name.
  * @param array                    $args {
- *     Optional. Array of extra. parameters.
+ *     Optional. Array of extra parameters.
  *
  *     @type array $tokens Optional. Assocative arrays of string replacements for the email.
@@ -3135 +3135 @@
     $email->set_to( $to );
     $email->set_tokens( $args['tokens'] );
+
+    /**
+     * Gives access to an email before it is sent.
+     *
+     * @since 2.8.0
+     *
+     * @param BP_Email                 $email      The email (object) about to be sent.
+     * @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.
+     * }
+     */
+    do_action_ref_array( 'bp_send_email', array( &$email, $email_type, $to, $args ) );
 
     $status = $email->validate();