get_comment_id_fields( int|WP_Post|null $post = null ): string

Compatibility

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

Parameters

$postint|WP_Post|nulloptional

The post the comment is being displayed for.
Defaults to the current global post.Default: null

Return value

string

Hidden input HTML for replying to comments.

Performance profile

How much work a call to get_comment_id_fields() 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

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

7–25

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

Plugin surface

1 hook

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

Called by

2

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

What it touches

• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()called directly

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

What one call costs · 2 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while get_comment_id_fields() runs, in this order:

1. 1
   apply_filters( comment_id_fields )filterline 2067 (+21 into the body)

   Filters the returned comment ID fields.

Uses · 3

• get_post()Retrieves post data given a post ID or post object.
• _get_comment_reply_id()Gets the comment's reply to ID from the $_GET['replytocom'].
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 2

• comment_form()Outputs a complete commenting form for use within a template.
• comment_id_fields()Outputs hidden input HTML for replying to comments.

Source code

View on Trac ↗View on GitHub ↗

2046function get_comment_id_fields( $post = null ) {2047	$post = get_post( $post );2048	if ( ! $post ) {2049		return '';2050	}2051 2052	$post_id     = $post->ID;2053	$reply_to_id = _get_comment_reply_id( $post_id );2054 2055	$comment_id_fields  = "<input type='hidden' name='comment_post_ID' value='$post_id' id='comment_post_ID' />\n";2056	$comment_id_fields .= "<input type='hidden' name='comment_parent' id='comment_parent' value='$reply_to_id' />\n";2057 2058	/**2059	 * Filters the returned comment ID fields.2060	 *2061	 * @since 3.0.02062	 *2063	 * @param string $comment_id_fields The HTML-formatted hidden ID field comment elements.2064	 * @param int    $post_id           The post ID.2065	 * @param int    $reply_to_id       The ID of the comment being replied to.2066	 */2067	return apply_filters( 'comment_id_fields', $comment_id_fields, $post_id, $reply_to_id );2068}

Changelog

Introduced in 3.0.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.0.4 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.