Docs: Various docblock corrections relating to parameter types.

See #51800


git-svn-id: https://develop.svn.wordpress.org/trunk@49692 602fd350-edb4-49c9-b593-d223f7449a82

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

@@ -216,7 +216,7 @@ class WP_Site_Icon {
 	 *                                    array of values.
 	 * @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.
 	 */
 	public function get_post_metadata( $value, $post_id, $meta_key, $single ) {

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

@@ -170,7 +170,7 @@ class WP_Object_Cache {
 	 *
 	 * @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 ) {
 		$groups = (array) $groups;

src/wp-includes/pluggable.php

@@ -165,7 +165,7 @@ if ( ! function_exists( 'wp_mail' ) ) :
 	 * @param string       $subject     Email subject
 	 * @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.
 	 */
 	function wp_mail( $to, $subject, $message, $headers = '', $attachments = array() ) {
@@ -176,8 +176,15 @@ if ( ! function_exists( 'wp_mail' ) ) :
 		 *
 		 * @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' ) );
 

src/wp-includes/post.php

@@ -2743,10 +2743,9 @@ function wp_count_attachments( $mime_type = '' ) {
 	 *
 	 * @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 );
 }