Retrieves the comment ID of the current comment.
Source
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
}
Hooks
- apply_filters( ‘get_comment_ID’,
string $comment_id ,WP_Comment $comment ) Filters the returned comment ID.
Changelog
Version | Description |
---|---|
1.5.0 | Introduced. |
Example migrated from Codex:
Uses the comment ID as an anchor id for a comment.