wp_check_comment_data( array $comment_data ): int|string|WP_Error
- Since
- 6.7.0
- Source
wp-includes/comment.php:1352
Compatibility
- WordPress
- since 6.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.
Parameters
$comment_dataarray- Array of arguments for inserting a comment.
Return value
int|string|WP_Error- The approval status on success (0|1|'spam'|'trash'), WP_Error otherwise.
Performance profile
How much work a call to wp_check_comment_data() 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
- Heavy
- Scaling
- Constant
- Instructions
- 17–91
- Plugin surface
- 1 hook
- Called by
- 2
Reaches the database via ->get_var().
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 95.
Third-party callbacks on 'pre_comment_approved' run inside this call, and their cost is not bounded by anything here.
2 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 - sqldatabase query
->get_var()called directly - querycontent query
get_user_by()one call below wp_check_comment_data() - optionoption read or write
get_option()one call below wp_check_comment_data()
Further down the call graph this can also reach cache, serialize and transient. 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_check_comment_data() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
empty($comment_data) && isset($user) && $post_author === false | 17 | apply_filters() |
empty($comment_data) && isset($user) && $post_author !== false && ->has_cap() | 21 | ->has_cap(), apply_filters() |
!empty($comment_data) && isset($user) && $post_author === false | 37 | get_userdata(), ->prepare(), ->get_var(), apply_filters() |
!empty($comment_data) && isset($user) && $post_author !== false && ->has_cap() | 41 | get_userdata(), ->prepare(), ->get_var(), ->has_cap(), apply_filters() |
empty($comment_data) && !isset($user) | 58–64 | check_comment(), wp_check_comment_disallowed_list(), apply_filters() |
empty($comment_data) && isset($user) && $post_author !== false && !->has_cap() | 65–71 | ->has_cap(), check_comment(), wp_check_comment_disallowed_list(), apply_filters() |
!empty($comment_data) && !isset($user) | 78–84 | get_userdata(), ->prepare(), ->get_var(), check_comment(), wp_check_comment_disallowed_list(), apply_filters() |
!empty($comment_data) && isset($user) && $post_author !== false && !->has_cap() | 85–91 | get_userdata(), ->prepare(), ->get_var(), ->has_cap(), check_comment(), wp_check_comment_disallowed_list(), 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: 95 instructions, 17–91 executed per call, 7 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_check_comment_data() runs, in this order:
- apply_filters( pre_comment_approved )filterline 1407 (+55 into the body)
Filters a comment's approval status before it is set.
Uses · 4
- get_userdata()Retrieves user info by user ID.
- check_comment()Checks whether a comment passes internal checks to be allowed to add.
- wp_check_comment_disallowed_list()Checks if a comment contains disallowed characters or words.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 2
- wp_allow_comment()Validates whether this comment is allowed to be made.
- wp_new_comment()Adds a new comment to the database.
Source code
function wp_check_comment_data( $comment_data ) { global $wpdb; if ( ! empty( $comment_data['user_id'] ) ) { $user = get_userdata( $comment_data['user_id'] ); $post_author = (int) $wpdb->get_var( $wpdb->prepare( "SELECT post_author FROM $wpdb->posts WHERE ID = %d LIMIT 1", $comment_data['comment_post_ID'] ) ); } if ( isset( $user ) && ( $comment_data['user_id'] === $post_author || $user->has_cap( 'moderate_comments' ) ) ) { // The author and the admins get respect. $approved = 1; } else { // Everyone else's comments will be checked. if ( check_comment( $comment_data['comment_author'], $comment_data['comment_author_email'], $comment_data['comment_author_url'], $comment_data['comment_content'], $comment_data['comment_author_IP'], $comment_data['comment_agent'], $comment_data['comment_type'] ) ) { $approved = 1; } else { $approved = 0; } if ( wp_check_comment_disallowed_list( $comment_data['comment_author'], $comment_data['comment_author_email'], $comment_data['comment_author_url'], $comment_data['comment_content'], $comment_data['comment_author_IP'], $comment_data['comment_agent'] ) ) { $approved = EMPTY_TRASH_DAYS ? 'trash' : 'spam'; } } /** * Filters a comment's approval status before it is set. * * @since 2.1.0 * @since 4.9.0 Returning a WP_Error value from the filter will short-circuit comment insertion * and allow skipping further processing. * * @param int|string|WP_Error $approved The approval status. Accepts 1, 0, 'spam', 'trash', * or WP_Error. * @param array $commentdata Comment data. */ return apply_filters( 'pre_comment_approved', $approved, $comment_data );}Changelog
Introduced in 6.7.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 7.1.0 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.