Skip to content

Commit bd48357

Browse files
committed
Mail: Update some docblocks relating to inline email attachments.
See #28059, #64224 git-svn-id: https://develop.svn.wordpress.org/trunk@61386 602fd350-edb4-49c9-b593-d223f7449a82
1 parent dd9a261 commit bd48357

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

src/wp-includes/pluggable.php

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ function cache_users( $user_ids ) {
173173
* @since 1.2.1
174174
* @since 5.5.0 is_email() is used for email validation,
175175
* instead of PHPMailer's default validator.
176-
* @since 6.9.0 Added $embeds parameter.
176+
* @since 6.9.0 The `$embeds` parameter was added.
177177
* @since 6.9.0 Improved Content-Type header handling for multipart messages.
178178
*
179179
* @global PHPMailer\PHPMailer\PHPMailer $phpmailer
@@ -193,6 +193,7 @@ function wp_mail( $to, $subject, $message, $headers = '', $attachments = array()
193193
* Filters the wp_mail() arguments.
194194
*
195195
* @since 2.2.0
196+
* @since 6.9.0 The `$embeds` element was added to the `$args` array.
196197
*
197198
* @param array $args {
198199
* Array of the `wp_mail()` arguments.
@@ -215,6 +216,7 @@ function wp_mail( $to, $subject, $message, $headers = '', $attachments = array()
215216
* the email was successfully sent.
216217
*
217218
* @since 5.7.0
219+
* @since 6.9.0 The `$embeds` element was added to the `$atts` array.
218220
*
219221
* @param null|bool $return Short-circuit return value.
220222
* @param array $atts {
@@ -573,7 +575,8 @@ function wp_mail( $to, $subject, $message, $headers = '', $attachments = array()
573575
* @since 6.9.0
574576
*
575577
* @param array $args {
576-
* An array of arguments for `addEmbeddedImage()`.
578+
* An array of arguments for PHPMailer's addEmbeddedImage() method.
579+
*
577580
* @type string $path The path to the file.
578581
* @type string $cid The Content-ID of the image. Default: The key in the embeds array.
579582
* @type string $name The filename of the image.
@@ -632,9 +635,10 @@ function wp_mail( $to, $subject, $message, $headers = '', $attachments = array()
632635
* process the request without any errors.
633636
*
634637
* @since 5.9.0
638+
* @since 6.9.0 The `$embeds` element was added to the `$mail_data` array.
635639
*
636640
* @param array $mail_data {
637-
* An array containing the email recipient(s), subject, message, headers, and attachments.
641+
* An array containing the email recipient(s), subject, message, headers, attachments, and embeds.
638642
*
639643
* @type string[] $to Email addresses to send message.
640644
* @type string $subject Email subject.
@@ -656,7 +660,7 @@ function wp_mail( $to, $subject, $message, $headers = '', $attachments = array()
656660
* @since 4.4.0
657661
*
658662
* @param WP_Error $error A WP_Error object with the PHPMailer\PHPMailer\Exception message, and an array
659-
* containing the mail recipient, subject, message, headers, and attachments.
663+
* containing the mail recipient, subject, message, headers, attachments, and embeds.
660664
*/
661665
do_action( 'wp_mail_failed', new WP_Error( 'wp_mail_failed', $e->getMessage(), $mail_data ) );
662666

0 commit comments

Comments
 (0)