WP hooks navigation: Home/browse • Actions index • Filters index
To save our bandwidth, we show only a snippet of code around each occurence of the hook. View complete file in SVN (without highlighting).
The best way to understand what a hook does is to look at where it occurs in the source code.
do_action( "hook_name" )
apply_filters( "hook_name", "what_to_filter" )
.Remember, this hook may occur in more than one file. Moreover, the hook's context may change from version to version.
Line | Code |
---|---|
302 | * Filters the comment author's returned IP address. |
303 | * |
304 | * @since 1.5.0 |
305 | * @since 4.1.0 The `$comment_id` and `$comment` parameters were added. |
306 | * |
307 | * @param string $comment_author_ip The comment author's IP address, or an empty string if it's not available. |
308 | * @param string $comment_id The comment ID as a numeric string. |
309 | * @param WP_Comment $comment The comment object. |
310 | */ |
311 | return apply_filters( 'get_comment_author_IP', $comment->comment_author_IP, $comment->comment_ID, $comment ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.NotLowercase |
312 | } |
313 |
|
314 | /** |
315 | * Displays the IP address of the author of the current comment. |
316 | * |
317 | * @since 0.71 |
318 | * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object. |
319 | * |
320 | * @param int|WP_Comment $comment_id Optional. WP_Comment or the ID of the comment for which to print the author's IP address. |