rest_prepare_post_type WordPress Filter Hook

The rest_prepare_post_type hook is called when a post is being prepared for the REST API. This hook allows you to modify the post data before it is sent to the client.

apply_filters( 'rest_prepare_post_type', WP_REST_Response $response, WP_Post_Type $post_type, WP_REST_Request $request ) #

Filters a post type returned from the REST API.


Description

Allows modification of the post type data right before it is returned.


Top ↑

Parameters

$response

(WP_REST_Response)The response object.

$post_type

(WP_Post_Type)The original post type object.

$request

(WP_REST_Request)Request used to generate the response.


Top ↑

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-post-types-controller.php

View on Trac



Top ↑

Changelog

Changelog
VersionDescription
4.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.