get_comment_author_IP( int|WP_Comment $comment_ID )

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


Description Description


Parameters 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.


Top ↑

Return Return

(string) Comment author's IP address.


Top ↑

Source Source

File: wp-includes/comment-template.php

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.
	 * @param int        $comment_ID        The comment ID.
	 * @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
}

Top ↑

Changelog Changelog

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


Top ↑

User Contributed Notes User Contributed Notes

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