wppaste
WordPress

apply_filters( 'get_comment_author_IP', string $comment_author_ip, string $comment_id, WP_Comment $comment )

Since
1.5.0, 4.1.0
Filters the comment author's returned IP address.

Compatibility

WordPress
since 4.1.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$comment_author_ipstring
The comment author's IP address, or an empty string if it's not available.
$comment_idstring
The comment ID as a numeric string.
$commentWP_Comment
The comment object.

Where this hook fires · 1

  • wp-includes/comment-template.php:332get_comment_author_IP()

Source code

View on Trac View on GitHub 

	 * @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} /** * Displays the IP address of the author of the current comment. * * @since 0.71

Changelog

Introduced in 1.5.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

4.1.0
The $comment_id and $comment parameters were added.from the docblock
1.5.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.9.7 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.