get_comment_author_IP()WP 1.5.0

Retrieves the IP address of the author of the current comment.

Hooks from the function

Return

String. Comment author's IP address, or an empty string if it's not available.

Usage

get_comment_author_IP( $comment_ID ) // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid;
$comment_ID(int|WP_Comment)
WP_Comment or the ID of the comment for which to get the author's IP address.
Default: current comment

Changelog

Since 1.5.0 Introduced.
Since 4.4.0 Added the ability for $comment_ID to also accept a WP_Comment object.

Code of get_comment_author_IP() WP 6.0

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
}