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

Timestamp:

01/11/2020 06:30:58 PM (7 years ago)

Author:

SergeyBiryukov

Message:

Docs: In various @return tags, list the expected type first, instead of false.

Follow-up to [46696].

See #48303.

File:

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

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

@@ -428 +428 @@
  * @param bool           $echo     Optional. Whether to echo or return the output.
  *                                 Default true.
- * @return string If `$echo` is false, the class will be returned. Void otherwise.
+ * @return void|string Void if `$echo` argument is true, comment classes if `$echo` is false.
  */
 function comment_class( $class = '', $comment = null, $post_id = null, $echo = true ) {
         // Separates classes with a single space, collates classes for comment DIV
         $class = 'class="' . join( ' ', get_comment_class( $class, $comment, $post_id ) ) . '"';
+
         if ( $echo ) {
                 echo $class;
@@ -1993 +1994 @@
  * }
  * @param WP_Comment[] $comments Optional. Array of WP_Comment objects.
+ * @return void|string Void if 'echo' argument is true, or no comments to list.
+ *                     Otherwise, HTML list of comments.
  */
 function wp_list_comments( $args = array(), $comments = null ) {