wppaste
WordPress

WP_REST_Pattern_Directory_Controller::prepare_item_for_response( object $item, WP_REST_Request $request ): WP_REST_Response

Since
5.8.0, 5.9.0
Source
wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php:192
Prepare a raw block pattern before it gets output in a REST API response.

Compatibility

WordPress
since 5.9.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$itemobject
Raw pattern from api.wordpress.org, before any changes.
$requestWP_REST_Request
Request object.

Return value

WP_REST_Response

Performance profile

How much work a call to WP_REST_Pattern_Directory_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
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
77

Executed per call on PHP 8.5. The body compiles to 77.

Plugin surface
1 hook

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

Called by
1

1 place 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

Further down the call graph this can also reach option, cache, serialize, query 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 · 1 distinct outcome

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

WhenInstructionsCalls it makes
always77absint(), sanitize_text_field(), wp_kses_post(), array_map(), explode(), array_map(), sanitize_text_field(), absint(), array_map(), ->add_additional_fields_to_object(), id(), apply_filters()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 77 instructions, 77 executed per call, 0 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Hooks and filters fired · 1

One hook fires while WP_REST_Pattern_Directory_Controller::prepare_item_for_response() runs, in this order:

  1. apply_filters( rest_prepare_block_pattern )filterline 220 (+28 into the body)

    Filters the REST API response for a block pattern.

Uses · 6

  • absint()Converts a value to non-negative integer.
  • sanitize_text_field()Sanitizes a string from user input or from the database.
  • wp_kses_post()Sanitizes content for allowed HTML tags for post content.
  • apply_filters()Calls the callback functions that have been added to a filter hook.
  • WP_REST_Pattern_Directory_Controller::add_additional_fields_to_object()
  • WP_REST_Response::__construct()

Used by · 1

Source code

View on Trac View on GitHub 

	public function prepare_item_for_response( $item, $request ) {		// Restores the more descriptive, specific name for use within this method.		$raw_pattern = $item; 		$prepared_pattern = array(			'id'             => absint( $raw_pattern->id ),			'title'          => sanitize_text_field( $raw_pattern->title->rendered ),			'content'        => wp_kses_post( $raw_pattern->pattern_content ),			'categories'     => array_map( 'sanitize_title', $raw_pattern->category_slugs ),			'keywords'       => array_map( 'sanitize_text_field', explode( ',', $raw_pattern->meta->wpop_keywords ) ),			'description'    => sanitize_text_field( $raw_pattern->meta->wpop_description ),			'viewport_width' => absint( $raw_pattern->meta->wpop_viewport_width ),			'block_types'    => array_map( 'sanitize_text_field', $raw_pattern->meta->wpop_block_types ),		); 		$prepared_pattern = $this->add_additional_fields_to_object( $prepared_pattern, $request ); 		$response = new WP_REST_Response( $prepared_pattern ); 		/**		 * Filters the REST API response for a block pattern.		 *		 * @since 5.8.0		 *		 * @param WP_REST_Response $response    The response object.		 * @param object           $raw_pattern The unprepared block pattern.		 * @param WP_REST_Request  $request     The request object.		 */		return apply_filters( 'rest_prepare_block_pattern', $response, $raw_pattern, $request );	}

Changelog

Introduced in 5.8.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.

5.9.0
Renamed $raw_pattern to $item to match parent class for PHP 8 named parameter support.from the docblock
5.8.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-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.