Changeset 61386

Timestamp:

12/16/2025 11:51:05 AM (8 weeks ago)

Author:

johnbillion

Message:

Mail: Update some docblocks relating to inline email attachments.

See #28059, #64224

File:

• trunk/src/wp-includes/pluggable.php (modified) (6 diffs)

trunk/src/wp-includes/pluggable.php

@@ -174 +174 @@
      * @since 5.5.0 is_email() is used for email validation,
      *              instead of PHPMailer's default validator.
-     * @since 6.9.0 Added $embeds parameter.
+     * @since 6.9.0 The `$embeds` parameter was added.
      * @since 6.9.0 Improved Content-Type header handling for multipart messages.
      *
@@ -194 +194 @@
          *
          * @since 2.2.0
+         * @since 6.9.0 The `$embeds` element was added to the `$args` array.
          *
          * @param array $args {
@@ -216 +217 @@
          *
          * @since 5.7.0
+         * @since 6.9.0 The `$embeds` element was added to the `$atts` array.
          *
          * @param null|bool $return Short-circuit return value.
@@ -574 +576 @@
                  *
                  * @param array $args {
-                 *     An array of arguments for `addEmbeddedImage()`.
+                 *     An array of arguments for PHPMailer's addEmbeddedImage() method.
+                 *
                  *     @type string $path        The path to the file.
                  *     @type string $cid         The Content-ID of the image. Default: The key in the embeds array.
@@ -633 +636 @@
              *
              * @since 5.9.0
+             * @since 6.9.0 The `$embeds` element was added to the `$mail_data` array.
              *
              * @param array $mail_data {
-             *     An array containing the email recipient(s), subject, message, headers, and attachments.
+             *     An array containing the email recipient(s), subject, message, headers, attachments, and embeds.
              *
              *     @type string[] $to          Email addresses to send message.
@@ -657 +661 @@
              *
              * @param WP_Error $error A WP_Error object with the PHPMailer\PHPMailer\Exception message, and an array
-             *                        containing the mail recipient, subject, message, headers, and attachments.
+             *                        containing the mail recipient, subject, message, headers, attachments, and embeds.
              */
             do_action( 'wp_mail_failed', new WP_Error( 'wp_mail_failed', $e->getMessage(), $mail_data ) );