rest_prepare_status WordPress Filter Hook

The rest_prepare_status hook is used to format the response data for a given request. This hook is called when the REST API prepares the data for output, after it has been retrieved from the database.

apply_filters( 'rest_prepare_status', WP_REST_Response $response, object $status, WP_REST_Request $request ) #

Filters a post status returned from the REST API.


Description

Allows modification of the status data right before it is returned.


Top ↑

Parameters

$response

(WP_REST_Response)The response object.

$status

(object)The original post status object.

$request

(WP_REST_Request)Request used to generate the response.


Top ↑

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-post-statuses-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.