wp_update_comment( array $commentarr, bool $wp_error = false ): int|false|WP_Error

Description

Compatibility

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

Parameters

$commentarrarray

Contains information on the comment.

$wp_errorbooloptional

Whether to return a WP_Error on failure. Default false.Default: false

Return value

int|false|WP_Error

The value 1 if the comment was updated, 0 if not updated.
False or a WP_Error object on failure.

Performance profile

How much work a call to wp_update_comment() 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

Reaches the database via ->update().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

15–150

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 199.

Plugin surface

3 hooks

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

Called by

3

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

What it touches

• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()called directly
• sqldatabase query->update()called directly
• cacheobject cachewp_cache_delete_multiple()one call below wp_update_comment()

Further down the call graph this can also reach serialize, option 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 · 68 distinct outcomes

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

Hooks and filters fired · 3

3 hooks fire while wp_update_comment() runs, in this order:

1. 1
   apply_filters( comment_save_pre )filterline 2925 (+56 into the body)

   Filters the comment content before it is updated in the database.

2. 2
   apply_filters( wp_update_comment_data )filterline 2953 (+84 into the body)

   Filters the comment data immediately before it is updated in the database.

3. 3
   do_action( edit_comment )actionline 3014 (+145 into the body)

   Fires immediately after a comment is updated in the database.

Uses · 20

• get_comment()Retrieves comment data given a comment ID or comment object.
• __()Retrieves the translation of $text.
• get_post()Retrieves post data given a post ID or post object.
• has_filter()Checks if any filter has been registered for a hook.
• user_can()Returns whether a particular user has the specified capability.
• add_filter()Adds a callback function to a filter hook.
• wp_slash()Adds slashes to a string or recursively adds slashes to strings within an array.
• wp_filter_comment()Filters and sanitizes comment data.
• remove_filter()Removes a callback function from a filter hook.
• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_gmt_from_date()Given a date in the timezone of the site, returns that date in UTC.

Used by · 3

• WP_REST_Comments_Controller::update_item()Updates a comment.
• edit_comment()Updates a comment with values provided in $_POST.
• wp_xmlrpc_server::wp_editComment()Edits a comment.

Source code

View on Trac ↗View on GitHub ↗

2869function wp_update_comment( $commentarr, $wp_error = false ) {2870	global $wpdb;2871 2872	// First, get all of the original fields.2873	$comment = get_comment( $commentarr['comment_ID'], ARRAY_A );2874 2875	if ( empty( $comment ) ) {2876		if ( $wp_error ) {2877			return new WP_Error( 'invalid_comment_id', __( 'Invalid comment ID.' ) );2878		} else {2879			return false;2880		}2881	}2882 2883	// Make sure that the comment post ID is valid (if specified).2884	if ( ! empty( $commentarr['comment_post_ID'] ) && ! get_post( $commentarr['comment_post_ID'] ) ) {2885		if ( $wp_error ) {2886			return new WP_Error( 'invalid_post_id', __( 'Invalid post ID.' ) );2887		} else {2888			return false;2889		}2890	}2891 2892	$filter_comment = false;2893	if ( ! has_filter( 'pre_comment_content', 'wp_filter_kses' ) ) {2894		$filter_comment = ! user_can( $comment['user_id'] ?? 0, 'unfiltered_html' );2895	}2896 2897	if ( $filter_comment ) {2898		add_filter( 'pre_comment_content', 'wp_filter_kses' );2899	}2900 2901	// Escape data pulled from DB.2902	$comment = wp_slash( $comment );2903 2904	$old_status = $comment['comment_approved'];2905 2906	// Merge old and new fields with new fields overwriting old ones.2907	$commentarr = array_merge( $comment, $commentarr );2908 2909	$commentarr = wp_filter_comment( $commentarr );2910 2911	if ( $filter_comment ) {2912		remove_filter( 'pre_comment_content', 'wp_filter_kses' );2913	}2914 2915	// Now extract the merged array.2916	$data = wp_unslash( $commentarr );2917 2918	/**2919	 * Filters the comment content before it is updated in the database.2920	 *2921	 * @since 1.5.02922	 *2923	 * @param string $comment_content The comment data.2924	 */2925	$data['comment_content'] = apply_filters( 'comment_save_pre', $data['comment_content'] );2926 2927	$data['comment_date_gmt'] = get_gmt_from_date( $data['comment_date'] );2928 2929	if ( ! isset( $data['comment_approved'] ) ) {2930		$data['comment_approved'] = 1;2931	} elseif ( 'hold' === $data['comment_approved'] ) {2932		$data['comment_approved'] = 0;2933	} elseif ( 'approve' === $data['comment_approved'] ) {2934		$data['comment_approved'] = 1;2935	}2936 2937	$comment_id      = $data['comment_ID'];2938	$comment_post_id = $data['comment_post_ID'];2939 2940	/**2941	 * Filters the comment data immediately before it is updated in the database.2942	 *2943	 * Note: data being passed to the filter is already unslashed.2944	 *2945	 * @since 4.7.02946	 * @since 5.5.0 Returning a WP_Error value from the filter will short-circuit comment update2947	 *              and allow skipping further processing.2948	 *

Changelog

Introduced in 2.0.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.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.