wp_list_comments( string|array $args = array(), WP_Comment[] $comments = null ): void|string

User Contributed Notes

1. Skip to note 8 content

   Steven Lin 5 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 6You must log in to vote on the helpfulness of this note

   Example migrated from Codex:

   Comments Only With A Custom Comment Display

   Displays just comments (no pingbacks or trackbacks) while using a custom callback function to control the look of the comment. You may want to add a max_depth=X parameter, if the reply links are not appearing.

   <ul class="commentlist">
   <?php wp_list_comments( 'type=comment&callback=mytheme_comment' ); ?>
   </ul>

   You will need to define your custom callback function in your theme’s functions.php file. Here is an example:

   function mytheme_comment($comment, $args, $depth) {
       if ( 'div' === $args['style'] ) {
           $tag       = 'div';
           $add_below = 'comment';
       } else {
           $tag       = 'li';
           $add_below = 'div-comment';
       }?>
       <<?php echo $tag; ?> <?php comment_class( empty( $args['has_children'] ) ? '' : 'parent' ); ?> id="comment-<?php comment_ID() ?>"><?php 
       if ( 'div' != $args['style'] ) { ?>
           <div id="div-comment-<?php comment_ID() ?>" class="comment-body"><?php
       } ?>
           <div class="comment-author vcard"><?php 
               if ( $args['avatar_size'] != 0 ) {
                   echo get_avatar( $comment, $args['avatar_size'] ); 
               } 
               printf( __( '<cite class="fn">%s</cite> <span class="says">says:</span>' ), get_comment_author_link() ); ?>
           </div><?php 
           if ( $comment->comment_approved == '0' ) { ?>
               <em class="comment-awaiting-moderation"><?php _e( 'Your comment is awaiting moderation.' ); ?></em><br/><?php 
           } ?>
           <div class="comment-meta commentmetadata">
               <a href="<?php echo htmlspecialchars( get_comment_link( $comment->comment_ID ) ); ?>"><?php
                   /* translators: 1: date, 2: time */
                   printf( 
                       __('%1$s at %2$s'), 
                       get_comment_date(),  
                       get_comment_time() 
                   ); ?>
               </a><?php 
               edit_comment_link( __( '(Edit)' ), '  ', '' ); ?>
           </div>
   
           <?php comment_text(); ?>
   
           <div class="reply"><?php 
                   comment_reply_link( 
                       array_merge( 
                           $args, 
                           array( 
                               'add_below' => $add_below, 
                               'depth'     => $depth, 
                               'max_depth' => $args['max_depth'] 
                           ) 
                       ) 
                   ); ?>
           </div><?php 
       if ( 'div' != $args['style'] ) : ?>
           </div><?php 
       endif;
   }

   Note the lack of a trailing </li>. In order to accommodate nested replies, WordPress will add the appropriate closing tag after listing any child elements.
2. Skip to note 9 content

   Mustafa KUCUK 6 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

   If you are using WordPress 4.9.6 or higher and not showing “Comment is awaiting moderation” alert.

   You can follow the steps below.

   – ) Settings -> Discussion -> enable “Show comments cookies opt-in checkbox.”
   – ) After activating checkbox will show on comments form like this. “Save my name, email, and website in this browser for the next time I comment.”

   That’s it.

   If you want to customize this checkbox field, you can use this code.

   $comment_form = array(
       'fields' => array(
           'cookies' => '<p class="comment-form-cookies-consent"><input id="wp-comment-cookies-consent" name="wp-comment-cookies-consent" type="checkbox" value="yes"' . $consent . ' />' .
           '<label for="wp-comment-cookies-consent">' . __( 'Save my name, email, and website in this browser for the next time I comment.' ) . '</label></p>',
       ),
   );
   
   comment_form( $comment_form );
3. Skip to note 10 content

   Anonymous User 6 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

   wp_list_comments() will not do anything by itself. It has to be called from inside the comments template file.

   An example:

   The page/post file where you want to insert comments:

   <?php comments_template('/comments.php'); ?>
   <?php /* Calling just comments_template() is also fine */ ?>

   Then, in comments.php:

   <div>
   	<?php /* Add conditional checks, styling and arguments here... */ ?>
   	<?php wp_list_comments(); ?>
   </div>
4. Skip to note 11 content

   Steven Lin 5 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

   Example migrated from Codex:

   Outputs an ordered list of comments for a specific page or post. Things like threading or paging being enabled or disabled are controlled via the Settings Discussion SubPanel.

   <ol class="commentlist">
   	<?php
   		//Gather comments for a specific page/post 
   		$comments = get_comments(array(
   			'post_id' => XXX,
   			'status' => 'approve' //Change this to the type of comments to be displayed
   		));
   
   		//Display the list of comments
   		wp_list_comments(array(
   			'per_page' => 10, //Allow comment pagination
   			'reverse_top_level' => false //Show the oldest comments at the top of the list
   		), $comments);
   	?>
   </ol>
5. Skip to note 12 content

   Mehadi Hasan Juber 7 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

   Customize the default wp_list_comments() ;

   <ol class="comment-list">
   	<?php
   		wp_list_comments( array(
   			'avatar_size' => 60,
   			'max_depth'   => 5,
   			'style'       => 'ol',
   			'short_ping'  => true,
   			'type'        => 'comment',
   		) );
   	?>
   </ol><!-- .comment-list -->
6. Skip to note 13 content

   Steven Lin 5 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

   Example migrated from Codex:

   Default Usage

   Outputs an ordered list of the comments. Things like threading or paging being enabled or disabled are controlled via the Settings Discussion SubPanel.

   <ol class="commentlist">
   <?php wp_list_comments(); ?>
   </ol>

   • This function has a bug if you choose ‘div’ for the style, it will add extra “[/div]” and “[!– #comment-## –]” if you choose “div” as the style. The same/similar bug exists for “li” however that doesn’t cause the same problem and the dot can be removed with CSS (list-style-type: none;). I was trying to display the comments in a html “tab” but the contents was leaking because of this bug.

     Dennis Bareis 1 year ago
7. Skip to note 14 content

   Mehedi Foysal 3 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

   $cpage = get_query_var( 'cpage' ) ? get_query_var( 'cpage' ) : 1;
   wp_list_comments(
       array(
           'avatar_size'       => 60,
           'short_ping'        => true,
           'type'              => 'comment',
           'callback'          => 'ic_comment_list',
           'per_page'          => get_option( 'comments_per_page' ),
           'page'              => $cpage,
           'reverse_top_level' => get_option( 'default_comments_page' ) === 'oldest' ? false : true,
       )
   );