WordPress.org

Make WordPress Core

Changeset 49692


Ignore:
Timestamp:
11/24/2020 09:20:36 PM (11 months ago)
Author:
johnbillion
Message:

Docs: Various docblock corrections relating to parameter types.

See #51800

Location:
trunk/src
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/class-wp-site-icon.php

    r47122 r49692  
    217217     * @param int               $post_id  Post ID.
    218218     * @param string            $meta_key Meta key.
    219      * @param string|array      $single   Meta value, or an array of values.
     219     * @param bool              $single   Whether to return only the first value of the specified `$meta_key`.
    220220     * @return array|null|string The attachment metadata value, array of values, or null.
    221221     */
  • trunk/src/wp-includes/class-wp-object-cache.php

    r48104 r49692  
    171171     * @since 3.0.0
    172172     *
    173      * @param array $groups List of groups that are global.
     173     * @param string|string[] $groups List of groups that are global.
    174174     */
    175175    public function add_global_groups( $groups ) {
  • 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' ) );
  • trunk/src/wp-includes/post.php

    r49673 r49692  
    27442744     * @since 3.7.0
    27452745     *
    2746      * @param object $counts    An object containing the attachment counts by
    2747      *                          mime type.
    2748      * @param string $mime_type The mime type pattern used to filter the attachments
    2749      *                          counted.
     2746     * @param object          $counts    An object containing the attachment counts by
     2747     *                                   mime type.
     2748     * @param string|string[] $mime_type Array or comma-separated list of MIME patterns.
    27502749     */
    27512750    return apply_filters( 'wp_count_attachments', (object) $counts, $mime_type );
Note: See TracChangeset for help on using the changeset viewer.