rest_prepare_{$this->post_type} WordPress Filter Hook

The rest_prepare_{$this->post_type} hook is called when a request is made to the WordPress REST API for a post of the given post type. The hook allows a plugin to modify the data that is returned in the response.

apply_filters( "rest_prepare_{$this->post_type}", WP_REST_Response $response, WP_Post $post, WP_REST_Request $request ) #

Filters the post data for a REST API response.


Description

The dynamic portion of the hook name, $this->post_type, refers to the post type slug.

Possible hook names include:

  • rest_prepare_post
  • rest_prepare_page
  • rest_prepare_attachment

Top ↑

Parameters

$response

(WP_REST_Response)The response object.

$post

(WP_Post)Post object.

$request

(WP_REST_Request)Request object.


Top ↑

Source

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