wpseek.com
A WordPress-centric search engine for devs and theme authors



get_comment_author_ip › WordPress Function

Since1.5.0
Deprecatedn/a
› get_comment_author_ip ( $comment_id = 0 )
Parameters:
  • (int|WP_Comment) $comment_id Optional. WP_Comment or the ID of the comment for which to get the author's IP address. Default current comment.
    Required: No
    Default: —
Returns:
  • (string) Comment author's IP address, or an empty string if it's not available.
Defined at:
Codex:
Change Log:
  • 4.4.0

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



Related Functions: get_comment_author, get_comment_author_link, get_comment_author_email, comment_author_ip, get_comment_author_url

Source 

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
}