rest_prepare_revision

Filter Hook

Description

Filters a revision returned from the REST API. Allows modification of the revision right before it is returned.

Hook Information

File Location	`wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php` View on GitHub
Hook Type	Filter
Line Number	`687`

Hook Parameters

Type	Name	Description
`WP_REST_Response`	`$response`	The response object.
`WP_Post`	`$post`	The original revision object.
`WP_REST_Request`	`$request`	Request used to generate the response.

Usage Examples

Basic Usage

<?php
// Hook into rest_prepare_revision
add_filter('rest_prepare_revision', 'my_custom_filter', 10, 3);

function my_custom_filter($response, $post, $request) {
    // Your custom filtering logic here
    return $response;
}

Source Code Context

wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php:687 - How this hook is used in WordPress core

<?php
 682  		 *
 683  		 * @param WP_REST_Response $response The response object.
 684  		 * @param WP_Post          $post     The original revision object.
 685  		 * @param WP_REST_Request  $request  Request used to generate the response.
 686  		 */
 687  		return apply_filters( 'rest_prepare_revision', $response, $post, $request );
 688  	}
 689  
 690  	/**
 691  	 * Checks the post_date_gmt or modified_gmt and prepare any post or
 692  	 * modified date for single post output.

PHP Documentation

<?php
/**
		 * Filters a revision returned from the REST API.
		 *
		 * Allows modification of the revision right before it is returned.
		 *
		 * @since 4.7.0
		 *
		 * @param WP_REST_Response $response The response object.
		 * @param WP_Post          $post     The original revision object.
		 * @param WP_REST_Request  $request  Request used to generate the response.
		 */

Quick Info

Hook Type: Filter
Parameters: 3
File: wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php

Links

WordPress Docs View Source Code Search Examples

Related Hooks

Related hooks will be displayed here in future updates.