Changeset 49692 for trunk/src/wp-includes/pluggable.php

Timestamp:

11/24/2020 09:20:36 PM (13 months ago)

Author:

johnbillion

Message:

Docs: Various docblock corrections relating to parameter types.

See #51800

File:

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

trunk/src/wp-includes/pluggable.php

@@ -166 +166 @@
      * @param string       $message     Message contents
      * @param string|array $headers     Optional. Additional headers.
-     * @param string|array $attachments Optional. Files to attach.
+     * @param string|array $attachments Optional. Paths to files to attach.
      * @return bool Whether the email contents were sent successfully.
      */
@@ -177 +177 @@
          * @since 2.2.0
          *
-         * @param array $args A compacted array of wp_mail() arguments, including the "to" email,
-         *                    subject, message, headers, and attachments values.
+         * @param array $args {
+         *     Array of the `wp_mail()` arguments.
+         *
+         *     @type string|string[] $to          Array or comma-separated list of email addresses to send message.
+         *     @type string          $subject     Email subject.
+         *     @type string          $message     Message contents.
+         *     @type string|string[] $headers     Additional headers.
+         *     @type string|string[] $attachments Paths to files to attach.
+         * }
          */
         $atts = apply_filters( 'wp_mail', compact( 'to', 'subject', 'message', 'headers', 'attachments' ) );