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

Description

Parameters

$commentarrarray

Contains information on the comment.

$wp_errorbooloptional

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

Return

int|false|WP_Error

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

Hooks fired · 3

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

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

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

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

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

3. 3
   do_action( edit_comment )actionline 2755 (+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

View on Trac ↗View on GitHub ↗

2610function wp_update_comment( $commentarr, $wp_error = false ) {2611	global $wpdb;2612 2613	// First, get all of the original fields.2614	$comment = get_comment( $commentarr['comment_ID'], ARRAY_A );2615 2616	if ( empty( $comment ) ) {2617		if ( $wp_error ) {2618			return new WP_Error( 'invalid_comment_id', __( 'Invalid comment ID.' ) );2619		} else {2620			return false;2621		}2622	}2623 2624	// Make sure that the comment post ID is valid (if specified).2625	if ( ! empty( $commentarr['comment_post_ID'] ) && ! get_post( $commentarr['comment_post_ID'] ) ) {2626		if ( $wp_error ) {2627			return new WP_Error( 'invalid_post_id', __( 'Invalid post ID.' ) );2628		} else {2629			return false;2630		}2631	}2632 2633	$filter_comment = false;2634	if ( ! has_filter( 'pre_comment_content', 'wp_filter_kses' ) ) {2635		$filter_comment = ! user_can( $comment['user_id'] ?? 0, 'unfiltered_html' );2636	}2637 2638	if ( $filter_comment ) {2639		add_filter( 'pre_comment_content', 'wp_filter_kses' );2640	}2641 2642	// Escape data pulled from DB.2643	$comment = wp_slash( $comment );2644 2645	$old_status = $comment['comment_approved'];2646 2647	// Merge old and new fields with new fields overwriting old ones.2648	$commentarr = array_merge( $comment, $commentarr );2649 2650	$commentarr = wp_filter_comment( $commentarr );2651 2652	if ( $filter_comment ) {2653		remove_filter( 'pre_comment_content', 'wp_filter_kses' );2654	}2655 2656	// Now extract the merged array.2657	$data = wp_unslash( $commentarr );2658 2659	/**2660	 * Filters the comment content before it is updated in the database.2661	 *2662	 * @since 1.5.02663	 *2664	 * @param string $comment_content The comment data.2665	 */2666	$data['comment_content'] = apply_filters( 'comment_save_pre', $data['comment_content'] );2667 2668	$data['comment_date_gmt'] = get_gmt_from_date( $data['comment_date'] );2669 2670	if ( ! isset( $data['comment_approved'] ) ) {2671		$data['comment_approved'] = 1;2672	} elseif ( 'hold' === $data['comment_approved'] ) {2673		$data['comment_approved'] = 0;2674	} elseif ( 'approve' === $data['comment_approved'] ) {2675		$data['comment_approved'] = 1;2676	}2677 2678	$comment_id      = $data['comment_ID'];2679	$comment_post_id = $data['comment_post_ID'];2680 2681	/**2682	 * Filters the comment data immediately before it is updated in the database.2683	 *2684	 * Note: data being passed to the filter is already unslashed.2685	 *2686	 * @since 4.7.02687	 * @since 5.5.0 Returning a WP_Error value from the filter will short-circuit comment update2688	 *              and allow skipping further processing.2689	 *

History

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.0.4 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.