wp_get_current_commenter(): array
- Since
- 2.0.4
- Source
wp-includes/comment.php:1989
Description
Expects cookies content to already be sanitized. User of this function might wish to recheck the returned array for validity.
Compatibility
- WordPress
- since 2.0.4
- PHP
- 7.4–8.6-dev
- 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), and compiles on PHP 7.4 through 8.6-dev.
Return value
array- An array of current commenter variables.
$comment_authorstringThe name of the current commenter, or an empty string.$comment_author_emailstringThe email address of the current commenter, or an empty string.$comment_author_urlstringThe URL address of the current commenter, or an empty string.
Performance profile
How much work a call to wp_get_current_commenter() 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
- Scaling
- Constant
- Instructions
- 28–43
- Plugin surface
- 1 hook
- Called by
- 12
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 43.
Third-party callbacks on 'wp_get_current_commenter' run inside this call, and their cost is not bounded by anything here.
12 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_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 wp_get_current_commenter() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 28–43 | compact(), apply_filters() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 43 instructions, 28–43 executed per call, 3 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while wp_get_current_commenter() runs, in this order:
- apply_filters( wp_get_current_commenter )filterline 2020 (+31 into the body)
Filters the current commenter's name, email, and URL.
Uses · 1
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 12
- TwentyNineteen_Walker_Comment::html5_comment()Outputs a comment in the HTML5 format.
- Walker_Comment::comment()Outputs a single comment.
- Walker_Comment::filter_comment_text()Filters the comment text.
- Walker_Comment::html5_comment()Outputs a comment in the HTML5 format.
- comment_form()Outputs a complete commenting form for use within a template.
- comments_template()Loads the comment template specified in $file.
- render_block_core_comment_author_name()Renders the `core/comment-author-name` block on the server.
- render_block_core_comment_content()Renders the `core/comment-content` block on the server.
- twentyeleven_comment()Template for comments and pingbacks.
- twentyten_comment()Template for comments and pingbacks.
- twentytwelve_comment()Template for comments and pingbacks.
- wp_get_unapproved_comment_author_email()Gets unapproved comment author's email.
Source code
function wp_get_current_commenter() { // Cookies should already be sanitized. $comment_author = ''; if ( isset( $_COOKIE[ 'comment_author_' . COOKIEHASH ] ) ) { $comment_author = $_COOKIE[ 'comment_author_' . COOKIEHASH ]; } $comment_author_email = ''; if ( isset( $_COOKIE[ 'comment_author_email_' . COOKIEHASH ] ) ) { $comment_author_email = $_COOKIE[ 'comment_author_email_' . COOKIEHASH ]; } $comment_author_url = ''; if ( isset( $_COOKIE[ 'comment_author_url_' . COOKIEHASH ] ) ) { $comment_author_url = $_COOKIE[ 'comment_author_url_' . COOKIEHASH ]; } /** * Filters the current commenter's name, email, and URL. * * @since 3.1.0 * * @param array $comment_author_data { * An array of current commenter variables. * * @type string $comment_author The name of the current commenter, or an empty string. * @type string $comment_author_email The email address of the current commenter, or an empty string. * @type string $comment_author_url The URL address of the current commenter, or an empty string. * } */ return apply_filters( 'wp_get_current_commenter', compact( 'comment_author', 'comment_author_email', 'comment_author_url' ) );}Changelog
Introduced in 2.0.4. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.9.7 tag, from
src/wp-includes/comment.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.