WordPress.org

Ready to get started?Download WordPress

Codex

Attention Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

Function Reference/comments template

Contents

Description

Loads the comment template. For use in single Post and Page displays. Will not work outside of single displays unless $withcomments is set to "1".

Usage

<?php comments_template$file$separate_comments ); ?>

Parameters

$file
(string) (optional) The file to load
Default: /comments.php
$separate_comments
(boolean) (optional) Whether to separate the comments by comment type.
Default: false

Examples

Default Usage

<?php comments_template(); ?> 

Alternative Comment Template

On some occasions you may want display your comments differently within your Theme. For this you would build an alternate file (ex. short-comments.php) and call it as follows:

<?php comments_template( '/short-comments.php' ); ?> 

Notes

  • Uses global: (array) $comment List of comment objects for the current post
  • Uses: $wpdb
  • Uses: $id
  • Uses: $post
  • Uses: $withcomments Will not try to get the comments if the post has none.

Changelog

Since: 1.5.0

Source File

comments_template() is located in wp-includes/comment-template.php.

Available Filters and Actions

List of comment filters and actions

Related

Include Tags


See also index of Function Reference and index of Template Tags.