WordPress.org

Make WordPress Core


Ignore:
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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/pluggable.php

    r49193 r49692  
    166166     * @param string       $message     Message contents
    167167     * @param string|array $headers     Optional. Additional headers.
    168      * @param string|array $attachments Optional. Files to attach.
     168     * @param string|array $attachments Optional. Paths to files to attach.
    169169     * @return bool Whether the email contents were sent successfully.
    170170     */
     
    177177         * @since 2.2.0
    178178         *
    179          * @param array $args A compacted array of wp_mail() arguments, including the "to" email,
    180          *                    subject, message, headers, and attachments values.
     179         * @param array $args {
     180         *     Array of the `wp_mail()` arguments.
     181         *
     182         *     @type string|string[] $to          Array or comma-separated list of email addresses to send message.
     183         *     @type string          $subject     Email subject.
     184         *     @type string          $message     Message contents.
     185         *     @type string|string[] $headers     Additional headers.
     186         *     @type string|string[] $attachments Paths to files to attach.
     187         * }
    181188         */
    182189        $atts = apply_filters( 'wp_mail', compact( 'to', 'subject', 'message', 'headers', 'attachments' ) );
Note: See TracChangeset for help on using the changeset viewer.