wp_get_unapproved_comment_author_email(): string
- Since
- 5.1.0, 5.7.0
- Source
wp-includes/comment.php:2034
Description
Used to allow the commenter to see their pending comment.
Compatibility
- WordPress
- since 5.7.0
- 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
string- The unapproved comment author's email (when supplied).
Performance profile
How much work a call to wp_get_unapproved_comment_author_email() 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
- 6–45
- Plugin surface
- None
- Called by
- 4
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 45.
Nothing here hands control to plugin code.
4 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()one call below wp_get_unapproved_comment_author_email()
Further down the call graph this can also reach option, cache, serialize, transient and query. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 8 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_get_unapproved_comment_author_email() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
empty($value) | 6–9 | none |
empty($value) | 11–14 | wp_get_current_commenter() |
!empty($value) | 17 | get_comment() |
!empty($value) | 22 | get_comment(), wp_get_current_commenter() |
!empty($value) && !hash_equals() | 29 | get_comment(), wp_hash(), hash_equals() |
!empty($value) && !hash_equals() | 34 | get_comment(), wp_hash(), hash_equals(), wp_get_current_commenter() |
!empty($value) && hash_equals() | 38–40 | get_comment(), wp_hash(), hash_equals(), strtotime(), time() |
!empty($value) && hash_equals() | 43–45 | get_comment(), wp_hash(), hash_equals(), strtotime(), time(), wp_get_current_commenter() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 45 instructions, 6–45 executed per call, 6 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.
Uses · 3
- get_comment()Retrieves comment data given a comment ID or comment object.
- wp_hash()Gets the hash of the given string.
- wp_get_current_commenter()Gets current commenter's name, email, and URL.
Used by · 4
- build_comment_query_vars_from_block()Helper function that constructs a comment query vars array from the passed block properties.
- comments_template()Loads the comment template specified in $file.
- get_page_of_comment()Calculates what page number a comment will appear on for comment paging.
- wp_list_comments()Displays a list of comments.
Source code
function wp_get_unapproved_comment_author_email() { $commenter_email = ''; if ( ! empty( $_GET['unapproved'] ) && ! empty( $_GET['moderation-hash'] ) ) { $comment_id = (int) $_GET['unapproved']; $comment = get_comment( $comment_id ); if ( $comment && hash_equals( $_GET['moderation-hash'], wp_hash( $comment->comment_date_gmt ) ) ) { // The comment will only be viewable by the comment author for 10 minutes. $comment_preview_expires = strtotime( $comment->comment_date_gmt . '+10 minutes' ); if ( time() < $comment_preview_expires ) { $commenter_email = $comment->comment_author_email; } } } if ( ! $commenter_email ) { $commenter = wp_get_current_commenter(); $commenter_email = $commenter['comment_author_email']; } return $commenter_email;}Changelog
Introduced in 5.1.0. 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.