rest_prepare_attachment WordPress Filter Hook

The rest_prepare_attachment hook is called when an attachment is being prepared for the REST API. This hook allows you to filter the attachment data before it is sent to the client.

apply_filters( 'rest_prepare_attachment', WP_REST_Response $response, WP_Post $post, WP_REST_Request $request ) #

Filters an attachment returned from the REST API.


Description

Allows modification of the attachment right before it is returned.


Top ↑

Parameters

$response

(WP_REST_Response)The response object.

$post

(WP_Post)The original attachment post.

$request

(WP_REST_Request)Request used to generate the response.


Top ↑

Source

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