WordPress at a glance
filter is not described

rest_pre_insert_comment filter-hook . WP 4.7.0

Filters a comment before it is inserted via the REST API.

Allows modification of the comment right before it is inserted via wp_insert_comment(). Returning a WP_Error value from the filter will shortcircuit insertion and allow skipping further processing.

Usage

add_filter( 'rest_pre_insert_comment', 'filter_function_name_9025', 10, 2 );
function filter_function_name_9025( $prepared_comment, $request ){
	// filter...

	return $prepared_comment;
}
$prepared_comment(array/WP_Error)
The prepared comment data for wp_insert_comment().
$request(WP_REST_Request)
Request used to insert the comment.

Notes

  • Since 4.8.0 $prepared_comment can now be a WP_Error to shortcircuit insertion.

Where the hook is called

WP_REST_Comments_Controller::create_item()
rest_pre_insert_comment
wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php 579
$prepared_comment = apply_filters( 'rest_pre_insert_comment', $prepared_comment, $request );

Where the hook is used (in WP core)

Does not used.