WP_REST_Attachments_Controller::prepare_item_for_response( WP_Post $item, WP_REST_Request $request ): WP_REST_Response

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$itemWP_Post

Attachment object.

$requestWP_REST_Request

Request object.

Return value

WP_REST_Response

Response object.

Performance profile

How much work a call to WP_REST_Attachments_Controller::prepare_item_for_response() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

67–163

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 239.

Plugin surface

4 hooks

Third-party callbacks on 'the_content', 'get_the_excerpt', 'the_excerpt' run inside this call, and their cost is not bounded by anything here.

Called by

4

4 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_post()one call below WP_REST_Attachments_Controller::prepare_item_for_response()

Further down the call graph this can also reach cache, option, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 80 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Attachments_Controller::prepare_item_for_response() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 4

4 hooks fire while WP_REST_Attachments_Controller::prepare_item_for_response() runs, in this order:

1. 1
   apply_filters( the_content )filterline 824 (+12 into the body)

   Filters the post content.

2. 2
   apply_filters( get_the_excerpt )filterline 830 (+18 into the body)

   Filters the retrieved post excerpt.

3. 3
   apply_filters( the_excerpt )filterline 833 (+21 into the body)

   Filters the displayed post excerpt.

4. 4
   apply_filters( rest_prepare_attachment )filterline 932 (+120 into the body)

   Filters an attachment returned from the REST API.

Uses · 13

• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_post_meta()Retrieves a post meta field for the given post ID.
• wp_attachment_is_image()Determines whether an attachment is an image.
• wp_get_attachment_metadata()Retrieves attachment metadata for attachment ID.
• wp_get_attachment_image_src()Retrieves an image to represent an attachment.
• wp_basename()i18n-friendly version of basename().
• wp_get_attachment_url()Retrieves the URL for an attachment.
• wp_get_missing_image_subsizes()Compare the existing image sub-sizes (as saved in the attachment meta) to the currently registered image sub-sizes, and return the difference.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• WP_REST_Posts_Controller::prepare_item_for_response()Prepares a single post output for response.
• WP_REST_Attachments_Controller::get_fields_for_response()
• stdClass::__construct()

Used by · 4

• WP_REST_Attachments_Controller::create_item()Creates a single attachment.
• WP_REST_Attachments_Controller::edit_media_item()Applies edits to a media item and creates a new attachment record.
• WP_REST_Attachments_Controller::post_process_item()Performs post-processing on an attachment.
• WP_REST_Attachments_Controller::update_item()Updates a single attachment.

Source code

View on Trac ↗View on GitHub ↗

812	public function prepare_item_for_response( $item, $request ) {813		// Restores the more descriptive, specific name for use within this method.814		$post = $item;815 816		$response = parent::prepare_item_for_response( $post, $request );817		$fields   = $this->get_fields_for_response( $request );818		$data     = $response->get_data();819 820		if ( in_array( 'description', $fields, true ) ) {821			$data['description'] = array(822				'raw'      => $post->post_content,823				/** This filter is documented in wp-includes/post-template.php */824				'rendered' => apply_filters( 'the_content', $post->post_content ),825			);826		}827 828		if ( in_array( 'caption', $fields, true ) ) {829			/** This filter is documented in wp-includes/post-template.php */830			$caption = apply_filters( 'get_the_excerpt', $post->post_excerpt, $post );831 832			/** This filter is documented in wp-includes/post-template.php */833			$caption = apply_filters( 'the_excerpt', $caption );834 835			$data['caption'] = array(836				'raw'      => $post->post_excerpt,837				'rendered' => $caption,838			);839		}840 841		if ( in_array( 'alt_text', $fields, true ) ) {842			$data['alt_text'] = get_post_meta( $post->ID, '_wp_attachment_image_alt', true );843		}844 845		if ( in_array( 'media_type', $fields, true ) ) {846			$data['media_type'] = wp_attachment_is_image( $post->ID ) ? 'image' : 'file';847		}848 849		if ( in_array( 'mime_type', $fields, true ) ) {850			$data['mime_type'] = $post->post_mime_type;851		}852 853		if ( in_array( 'media_details', $fields, true ) ) {854			$data['media_details'] = wp_get_attachment_metadata( $post->ID );855 856			// Ensure empty details is an empty object.857			if ( empty( $data['media_details'] ) ) {858				$data['media_details'] = new stdClass();859			} elseif ( ! empty( $data['media_details']['sizes'] ) ) {860 861				foreach ( $data['media_details']['sizes'] as $size => &$size_data ) {862 863					if ( isset( $size_data['mime-type'] ) ) {864						$size_data['mime_type'] = $size_data['mime-type'];865						unset( $size_data['mime-type'] );866					}867 868					// Use the same method image_downsize() does.869					$image_src = wp_get_attachment_image_src( $post->ID, $size );870					if ( ! $image_src ) {871						continue;872					}873 874					$size_data['source_url'] = $image_src[0];875				}876 877				$full_src = wp_get_attachment_image_src( $post->ID, 'full' );878 879				if ( ! empty( $full_src ) ) {880					$data['media_details']['sizes']['full'] = array(881						'file'       => wp_basename( $full_src[0] ),882						'width'      => $full_src[1],883						'height'     => $full_src[2],884						'mime_type'  => $post->post_mime_type,885						'source_url' => $full_src[0],886					);887				}888			} else {889				$data['media_details']['sizes'] = new stdClass();890			}891		}

Changelog

Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.