get_comment_author_IP() WordPress Function

The get_comment_author_IP() function retrieves the IP address of the author of a given comment. This function is useful for making sure that a comment is coming from the author's actual IP address, and not a spoofed one.

get_comment_author_IP( int|WP_Comment $comment_ID ) #

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.


Top ↑

Return

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


Top ↑

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, 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
}


Top ↑

Changelog

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

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More