Changeset 49693 for trunk/src/wp-includes/comment-template.php

Timestamp:

11/24/2020 09:25:46 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Upgrade more parameters in docblocks to used typed array notation.

See #51800, #41756

File:

• trunk/src/wp-includes/comment-template.php (modified) (3 diffs)

trunk/src/wp-includes/comment-template.php

@@ -423 +423 @@
  * @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object.
  *
- * @param string|array   $class    Optional. One or more classes to add to the class list.
- *                                 Default empty.
- * @param int|WP_Comment $comment  Comment ID or WP_Comment object. Default current comment.
- * @param int|WP_Post    $post_id  Post ID or WP_Post object. Default current post.
- * @param bool           $echo     Optional. Whether to echo or return the output.
- *                                 Default true.
+ * @param string|string[] $class    Optional. One or more classes to add to the class list.
+ *                                  Default empty.
+ * @param int|WP_Comment  $comment  Comment ID or WP_Comment object. Default current comment.
+ * @param int|WP_Post     $post_id  Post ID or WP_Post object. Default current post.
+ * @param bool            $echo     Optional. Whether to echo or return the output.
+ *                                  Default true.
  * @return void|string Void if `$echo` argument is true, comment classes if `$echo` is false.
  */
@@ -452 +452 @@
  * @global int $comment_thread_alt
  *
- * @param string|array   $class      Optional. One or more classes to add to the class list. Default empty.
- * @param int|WP_Comment $comment_id Comment ID or WP_Comment object. Default current comment.
- * @param int|WP_Post    $post_id    Post ID or WP_Post object. Default current post.
+ * @param string|string[] $class      Optional. One or more classes to add to the class list. Default empty.
+ * @param int|WP_Comment  $comment_id Comment ID or WP_Comment object. Default current comment.
+ * @param int|WP_Post     $post_id    Post ID or WP_Post object. Default current post.
  * @return string[] An array of classes.
  */
@@ -531 +531 @@
      *
      * @param string[]    $classes    An array of comment classes.
-     * @param string      $class      A comma-separated list of additional classes added to the list.
+     * @param string[]    $class      An array of additional classes added to the list.
      * @param int         $comment_id The comment ID.
      * @param WP_Comment  $comment    The comment object.