get_comment_ID(): string

Retrieves the comment ID of the current comment.

Contents

Return

string The comment ID as a numeric string.

Top ↑

Source

File: wp-includes/comment-template.php. View all references 

function get_comment_ID() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
	$comment = get_comment();

	$comment_id = ! empty( $comment->comment_ID ) ? $comment->comment_ID : '0';

	/**
	 * Filters the returned comment ID.
	 *
	 * @since 1.5.0
	 * @since 4.1.0 The `$comment` parameter was added.
	 *
	 * @param string     $comment_id The current comment ID as a numeric string.
	 * @param WP_Comment $comment    The comment object.
	 */
	return apply_filters( 'get_comment_ID', $comment_id, $comment );  // phpcs:ignore WordPress.NamingConventions.ValidHookName.NotLowercase
}

View on Trac View on GitHub

Top ↑

Hooks

Top ↑

Top ↑

Uses

Uses
Uses Description
apply_filters() wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.
get_comment() wp-includes/comment.php

Retrieves comment data given a comment ID or comment object.

Top ↑

Used By

Used By
Used By Description
comment_form_title() wp-includes/comment-template.php

Displays text based on comment reply status.
comment_ID() wp-includes/comment-template.php

Displays the comment ID of the current comment.

Top ↑

Changelog

Changelog
Version Description
1.5.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    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
    Contributed by Steven Lin —

    Example migrated from Codex:

    Uses the comment ID as an anchor id for a comment.

    <?php $comment_id = get_comment_ID(); ?>

<div id="comment-<?php echo esc_attr( $comment_id ); ?>">Comment by 
<?php comment_author() ?>: </div>
<div class="comment-text"><?php comment_text() ?></div>

You must log in before being able to contribute a note or feedback.