WP_REST_Attachments_Controller::prepare_item_for_database() WordPress Method
The WP_REST_Attachments_Controller::prepare_item_for_database() method is used to prepare an attachment for insertion into the database. This method can be used to set the attachment title, caption, description, and alt text.
WP_REST_Attachments_Controller::prepare_item_for_database( WP_REST_Request $request ) #
Prepares a single attachment for create or update.
Parameters
- $request
(WP_REST_Request)(Required)Request object.
Return
(stdClass|WP_Error) Post object.
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php
protected function prepare_item_for_database( $request ) { $prepared_attachment = parent::prepare_item_for_database( $request ); // Attachment caption (post_excerpt internally). if ( isset( $request['caption'] ) ) { if ( is_string( $request['caption'] ) ) { $prepared_attachment->post_excerpt = $request['caption']; } elseif ( isset( $request['caption']['raw'] ) ) { $prepared_attachment->post_excerpt = $request['caption']['raw']; } } // Attachment description (post_content internally). if ( isset( $request['description'] ) ) { if ( is_string( $request['description'] ) ) { $prepared_attachment->post_content = $request['description']; } elseif ( isset( $request['description']['raw'] ) ) { $prepared_attachment->post_content = $request['description']['raw']; } } if ( isset( $request['post'] ) ) { $prepared_attachment->post_parent = (int) $request['post']; } return $prepared_attachment; }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
4.7.0 | Introduced. |