get_comment_author_IP( int|WP_Comment $comment_id ): string
Retrieves the IP address of the author of the current comment.
Parameters
-
$comment_id
int|WP_Comment Optional -
WP_Comment or the ID of the comment for which to get the author's IP address.
Default current comment.
Return
string Comment author's IP address, or an empty string if it's not available.
Source
File: wp-includes/comment-template.php
.
View all references
function get_comment_author_IP( $comment_id = 0 ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
$comment = get_comment( $comment_id );
/**
* Filters the comment author's returned IP address.
*
* @since 1.5.0
* @since 4.1.0 The `$comment_id` and `$comment` parameters were added.
*
* @param string $comment_author_ip The comment author's IP address, or an empty string if it's not available.
* @param string $comment_id The comment ID as a numeric string.
* @param WP_Comment $comment The comment object.
*/
return apply_filters( 'get_comment_author_IP', $comment->comment_author_IP, $comment->comment_ID, $comment ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.NotLowercase
}
Hooks
-
apply_filters( 'get_comment_author_IP',
string $comment_author_ip ,string $comment_id ,WP_Comment $comment ) -
Filters the comment author’s returned IP address.
Changelog
Version | Description |
---|---|
4.4.0 | Added the ability for $comment_id to also accept a WP_Comment object. |
1.5.0 | Introduced. |