apply_filters( 'rest_pre_insert_comment', array|WP_Error $prepared_comment, WP_REST_Request $request )

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


Description

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


Top ↑

Parameters

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

Top ↑

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php. View all references

$prepared_comment = apply_filters( 'rest_pre_insert_comment', $prepared_comment, $request );


Top ↑

Changelog

Changelog
Version Description
4.8.0 $prepared_comment can now be a WP_Error to short-circuit insertion.
4.7.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.