rest_pre_insert_comment

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

Description

apply_filters( 'rest_pre_insert_comment', (array) $prepared_comment, (WP_REST_Request) $request ); 

Allows modification of the comment right before it is inserted via wp_insert_comment().

Parameters (2)

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

Usage

To run the hook, copy the example below.
  1. $prepared_comment = apply_filters( 'rest_pre_insert_comment', $prepared_comment, $request ); 
  2.  
  3. if ( !empty( $prepared_comment ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the rest_pre_insert_comment callback 
  2. function filter_rest_pre_insert_comment( $prepared_comment, $request ) { 
  3. // make filter magic happen here... 
  4. return $prepared_comment
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'rest_pre_insert_comment', 'filter_rest_pre_insert_comment', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'rest_pre_insert_comment', 'filter_rest_pre_insert_comment', 10, 2 ); 

Defined (1)

The filter is defined in the following location(s).

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