WordPress.org

Make WordPress Core


Ignore:
Timestamp:
01/11/2020 06:30:58 PM (13 months ago)
Author:
SergeyBiryukov
Message:

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

Follow-up to [46696].

See #48303.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/comment-template.php

    r47032 r47060  
    428428 * @param bool           $echo     Optional. Whether to echo or return the output.
    429429 *                                 Default true.
    430  * @return string If `$echo` is false, the class will be returned. Void otherwise.
     430 * @return void|string Void if `$echo` argument is true, comment classes if `$echo` is false.
    431431 */
    432432function comment_class( $class = '', $comment = null, $post_id = null, $echo = true ) {
    433433    // Separates classes with a single space, collates classes for comment DIV
    434434    $class = 'class="' . join( ' ', get_comment_class( $class, $comment, $post_id ) ) . '"';
     435
    435436    if ( $echo ) {
    436437        echo $class;
     
    19931994 * }
    19941995 * @param WP_Comment[] $comments Optional. Array of WP_Comment objects.
     1996 * @return void|string Void if 'echo' argument is true, or no comments to list.
     1997 *                     Otherwise, HTML list of comments.
    19951998 */
    19961999function wp_list_comments( $args = array(), $comments = null ) {
Note: See TracChangeset for help on using the changeset viewer.