comments_template( string $file = '/comments.php', bool $separate_comments = false )

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$filestringoptional

The file to load. Default '/comments.php'.Default: '/comments.php'

$separate_commentsbooloptional

Whether to separate the comments by comment type.
Default false.Default: false

Performance profile

How much work a call to comments_template() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reads or writes the filesystem via file_exists().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

121–225

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 278.

Plugin surface

4 hooks

Third-party callbacks on 'comments_template_top_level_query_args', 'comments_template_query_args', 'comments_array' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• optionoption read or writeget_option()called directly
• hookthird-party callbacksapply_filters()called directly
• filesystemfilesystem accessfile_exists()called directly
• sqldatabase query->query()called directly
• cacheobject cachewp_cache_get()one call below comments_template()
• serializeserialisationmaybe_unserialize()one call below comments_template()

Further down the call graph this can also reach transient and query. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 162 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost comments_template() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 4

4 hooks fire while comments_template() runs, in this order:

1. 1
   apply_filters( comments_template_top_level_query_args )filterline 1524 (+107 into the body)

   Filters the arguments used in the top level comments query.

2. 2
   apply_filters( comments_template_query_args )filterline 1555 (+138 into the body)

   Filters the arguments used to query comments in comments_template().

3. 3
   apply_filters( comments_array )filterline 1589 (+172 into the body)

   Filters the comments array.

4. 4
   apply_filters( comments_template )filterline 1622 (+205 into the body)

   Filters the path to the theme template file used for the comments template.

Uses · 15

• is_single()Determines whether the query is for an existing single post.
• is_page()Determines whether the query is for an existing single page.
• get_option()Retrieves an option value based on an option name.
• wp_get_current_commenter()Gets current commenter's name, email, and URL.
• esc_url()Checks and cleans a URL.
• is_user_logged_in()Determines whether the current visitor is a logged in user.
• get_current_user_id()Gets the current user's ID.
• wp_get_unapproved_comment_author_email()Gets unapproved comment author's email.
• get_query_var()Retrieves the value of a query variable in the WP_Query class.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• separate_comments()Separates an array of comments into an array keyed by comment_type.
• set_query_var()Sets the value of a query variable in the WP_Query class.

Used by · 1

• render_block_core_comments()Renders the `core/comments` block on the server.

Source code

View on Trac ↗View on GitHub ↗

1417function comments_template( $file = '/comments.php', $separate_comments = false ) {1418	global $wp_query, $withcomments, $post, $wpdb, $id, $comment, $user_login, $user_identity, $overridden_cpage, $wp_stylesheet_path, $wp_template_path;1419 1420	if ( ! ( is_single() || is_page() || $withcomments ) || empty( $post ) ) {1421		return;1422	}1423 1424	if ( empty( $file ) ) {1425		$file = '/comments.php';1426	}1427 1428	$req = get_option( 'require_name_email' );1429 1430	/*1431	 * Comment author information fetched from the comment cookies.1432	 */1433	$commenter = wp_get_current_commenter();1434 1435	/*1436	 * The name of the current comment author escaped for use in attributes.1437	 * Escaped by sanitize_comment_cookies().1438	 */1439	$comment_author = $commenter['comment_author'];1440 1441	/*1442	 * The email address of the current comment author escaped for use in attributes.1443	 * Escaped by sanitize_comment_cookies().1444	 */1445	$comment_author_email = $commenter['comment_author_email'];1446 1447	/*1448	 * The URL of the current comment author escaped for use in attributes.1449	 */1450	$comment_author_url = esc_url( $commenter['comment_author_url'] );1451 1452	$comment_args = array(1453		'orderby'       => 'comment_date_gmt',1454		'order'         => 'ASC',1455		'status'        => 'approve',1456		'post_id'       => $post->ID,1457		'no_found_rows' => false,1458	);1459 1460	if ( get_option( 'thread_comments' ) ) {1461		$comment_args['hierarchical'] = 'threaded';1462	} else {1463		$comment_args['hierarchical'] = false;1464	}1465 1466	if ( is_user_logged_in() ) {1467		$comment_args['include_unapproved'] = array( get_current_user_id() );1468	} else {1469		$unapproved_email = wp_get_unapproved_comment_author_email();1470 1471		if ( $unapproved_email ) {1472			$comment_args['include_unapproved'] = array( $unapproved_email );1473		}1474	}1475 1476	$per_page = 0;1477	if ( get_option( 'page_comments' ) ) {1478		$per_page = (int) get_query_var( 'comments_per_page' );1479		if ( 0 === $per_page ) {1480			$per_page = (int) get_option( 'comments_per_page' );1481		}1482 1483		$comment_args['number'] = $per_page;1484		$page                   = (int) get_query_var( 'cpage' );1485 1486		if ( $page ) {1487			$comment_args['offset'] = ( $page - 1 ) * $per_page;1488		} elseif ( 'oldest' === get_option( 'default_comments_page' ) ) {1489			$comment_args['offset'] = 0;1490		} else {1491			// If fetching the first page of 'newest', we need a top-level comment count.1492			$top_level_query = new WP_Comment_Query();1493			$top_level_args  = array(1494				'count'   => true,1495				'orderby' => false,1496				'post_id' => $post->ID,

Changelog

Introduced in 1.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/comment-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.