Changeset 49692

Timestamp:

11/24/2020 09:20:36 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Various docblock corrections relating to parameter types.

See #51800

Location:

trunk/src

Files:

• wp-admin/includes/class-wp-site-icon.php (modified) (1 diff)
• wp-includes/class-wp-object-cache.php (modified) (1 diff)
• wp-includes/pluggable.php (modified) (2 diffs)
• wp-includes/post.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-wp-site-icon.php

@@ -217 +217 @@
      * @param int               $post_id  Post ID.
      * @param string            $meta_key Meta key.
-     * @param string|array      $single   Meta value, or an array of values.
+     * @param bool              $single   Whether to return only the first value of the specified `$meta_key`.
      * @return array|null|string The attachment metadata value, array of values, or null.
      */

trunk/src/wp-includes/class-wp-object-cache.php

@@ -171 +171 @@
      * @since 3.0.0
      *
-     * @param array $groups List of groups that are global.
+     * @param string|string[] $groups List of groups that are global.
      */
     public function add_global_groups( $groups ) {

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' ) );

trunk/src/wp-includes/post.php

@@ -2744 +2744 @@
      * @since 3.7.0
      *
-     * @param object $counts    An object containing the attachment counts by
-     *                          mime type.
-     * @param string $mime_type The mime type pattern used to filter the attachments
-     *                          counted.
+     * @param object          $counts    An object containing the attachment counts by
+     *                                   mime type.
+     * @param string|string[] $mime_type Array or comma-separated list of MIME patterns.
      */
     return apply_filters( 'wp_count_attachments', (object) $counts, $mime_type );