Menu Adam R Brown

WP hooks navigation: Home/browseActions indexFilters index

Source View: get_comment_author_IP

To save our bandwidth, we show only a snippet of code around each occurence of the hook. View complete file in SVN (without highlighting).

Understanding Source Code

The best way to understand what a hook does is to look at where it occurs in the source code.

Remember, this hook may occur in more than one file. Moreover, the hook's context may change from version to version.

Source View

Line Code
271       * Filters the comment author's returned IP address.
272       *
273       * @since 1.5.0
274       * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
275       *
276       * @param string     $comment_author_IP The comment author's IP address.
277       * @param int        $comment_ID        The comment ID.
278       * @param WP_Comment $comment           The comment object.
279       */
280      return apply_filters( 'get_comment_author_IP', $comment->comment_author_IP, $comment->comment_ID, $comment );  // phpcs:ignore WordPress.NamingConventions.ValidHookName.NotLowercase
281 }
282
283 /**
284  * Displays the IP address of the author of the current comment.
285  *
286  * @since 0.71
287  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
288  *
289  * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's IP address.