get_comment_author_IP( int|WP_Comment $comment_id = 0 ): string

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$comment_idint|WP_Commentoptional

WP_Comment or the ID of the comment for which to get the author's IP address.
Default current comment.Default: 0

Return value

string

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

Performance profile

How much work a call to get_comment_author_IP() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

16

Executed per call on PHP 8.5. The body compiles to 16.

Plugin surface

1 hook

Third-party callbacks on 'get_comment_author_IP' run inside this call, and their cost is not bounded by anything here.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_comment_author_IP() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while get_comment_author_IP() runs, in this order:

1. 1
   apply_filters( get_comment_author_IP )filterline 332 (+13 into the body)

   Filters the comment author's returned IP address.

Uses · 2

• get_comment()Retrieves comment data given a comment ID or comment object.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 2

• WP_Comments_List_Table::column_author()Outputs the author column.
• comment_author_IP()Displays the IP address of the author of the current comment.

Source code

View on Trac ↗View on GitHub ↗

319function get_comment_author_IP( $comment_id = 0 ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid320	$comment = get_comment( $comment_id );321 322	/**323	 * Filters the comment author's returned IP address.324	 *325	 * @since 1.5.0326	 * @since 4.1.0 The `$comment_id` and `$comment` parameters were added.327	 *328	 * @param string     $comment_author_ip The comment author's IP address, or an empty string if it's not available.329	 * @param string     $comment_id        The comment ID as a numeric string.330	 * @param WP_Comment $comment           The comment object.331	 */332	return apply_filters( 'get_comment_author_IP', $comment->comment_author_IP, $comment->comment_ID, $comment );  // phpcs:ignore WordPress.NamingConventions.ValidHookName.NotLowercase333}

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.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/comment-template.php, 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.