wppaste
WordPress

apply_filters( 'rest_prepare_comment', WP_REST_Response $response, WP_Comment $comment, WP_REST_Request $request )

Since
4.7.0
Filters a comment returned from the REST API.

Description

Allows modification of the comment right before it is returned.

Compatibility

WordPress
since 4.7.0
  • 6.7.10
  • 6.8.11
  • 6.9.10
  • 7.0.7
  • 7.1.3

Present in every tracked release (6.7.10 to 7.1.3).

Parameters

$responseWP_REST_Response
The response object.
$commentWP_Comment
The original comment object.
$requestWP_REST_Request
Request used to generate the response.

Where this hook fires · 2

  • wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php:1160WP_REST_Comments_Controller::prepare_item_for_response()
  • wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php:1260WP_REST_Comments_Controller::prepare_item_for_response()

Source code

View on Trac View on GitHub 

		 * @since 4.7.0		 *		 * @param WP_REST_Response  $response The response object.		 * @param WP_Comment        $comment  The original comment object.		 * @param WP_REST_Request   $request  Request used to generate the response.		 */		return apply_filters( 'rest_prepare_comment', $response, $comment, $request );	} 	/**	 * Prepares links for the request.	 *	 * @since 4.7.0

Changelog

Introduced in 4.7.0. Unchanged from 6.7.10 through 7.1.3.

  1. 6.7.10
  2. 6.8.11
  3. 6.9.10
  4. 7.0.7
  5. 7.1.3

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.0.7 tag, 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.