WP_REST_Font_Collections_Controller::prepare_item_for_response( WP_Font_Collection $item, WP_REST_Request $request ): WP_REST_Response|WP_Error

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_Font_Collection

Font collection object.

$requestWP_REST_Request

Request object.

Return value

WP_REST_Response|WP_Error

Response object on success, or WP_Error object on failure.

Performance profile

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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

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

Instructions

28–82

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

Plugin surface

1 hook

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

Called by

2

2 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

What one call costs · 8 distinct outcomes

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

Hooks and filters fired · 3

3 hooks fire while WP_REST_Font_Collections_Controller::prepare_item_for_response() runs, in this order:

1. 1
   apply_filters( rest_prepare_font_collection )filterline 197 (+23 into the body)

   Filters the font collection data for a REST API response.

2. 2
   apply_filters( rest_prepare_font_collection )filterline 213 (+39 into the body)

   Filters the font collection data for a REST API response.

3. 3
   apply_filters( rest_prepare_font_collection )filterline 236 (+62 into the body)

   Filters the font collection data for a REST API response.

Uses · 9

• rest_is_field_included()Given an array of fields to include in a response, some of which may be `nested.fields`, determine whether the provided field should be included in the response body.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• WP_REST_Font_Collections_Controller::get_fields_for_response()
• WP_REST_Response::__construct()
• WP_REST_Font_Collections_Controller::prepare_links()Prepares links for the request.
• WP_REST_Font_Collections_Controller::add_additional_fields_to_object()
• WP_REST_Font_Collections_Controller::filter_response_by_context()

Used by · 2

• WP_REST_Font_Collections_Controller::get_item()Gets a font collection.
• WP_REST_Font_Collections_Controller::get_items()Gets the font collections available.

Source code

View on Trac ↗View on GitHub ↗

174	public function prepare_item_for_response( $item, $request ) {175		$fields = $this->get_fields_for_response( $request );176		$data   = array();177 178		if ( rest_is_field_included( 'slug', $fields ) ) {179			$data['slug'] = $item->slug;180		}181 182		// If any data fields are requested, get the collection data.183		$data_fields = array( 'name', 'description', 'font_families', 'categories' );184		if ( ! empty( array_intersect( $fields, $data_fields ) ) ) {185			$collection_data = $item->get_data();186			if ( is_wp_error( $collection_data ) ) {187				$collection_data->add_data( array( 'status' => 500 ) );188				return $collection_data;189			}190 191			/**192			 * Don't prepare the response body for HEAD requests.193			 * Can't exit at the beginning of the method due to the potential need to return a WP_Error object.194			 */195			if ( $request->is_method( 'HEAD' ) ) {196				/** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-font-collections-controller.php */197				return apply_filters( 'rest_prepare_font_collection', new WP_REST_Response( array() ), $item, $request );198			}199 200			foreach ( $data_fields as $field ) {201				if ( rest_is_field_included( $field, $fields ) ) {202					$data[ $field ] = $collection_data[ $field ];203				}204			}205		}206 207		/**208		 * Don't prepare the response body for HEAD requests.209		 * Can't exit at the beginning of the method due to the potential need to return a WP_Error object.210		 */211		if ( $request->is_method( 'HEAD' ) ) {212			/** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-font-collections-controller.php */213			return apply_filters( 'rest_prepare_font_collection', new WP_REST_Response( array() ), $item, $request );214		}215 216		$response = rest_ensure_response( $data );217 218		if ( rest_is_field_included( '_links', $fields ) ) {219			$links = $this->prepare_links( $item );220			$response->add_links( $links );221		}222 223		$context        = ! empty( $request['context'] ) ? $request['context'] : 'view';224		$response->data = $this->add_additional_fields_to_object( $response->data, $request );225		$response->data = $this->filter_response_by_context( $response->data, $context );226 227		/**228		 * Filters the font collection data for a REST API response.229		 *230		 * @since 6.5.0231		 *232		 * @param WP_REST_Response   $response The response object.233		 * @param WP_Font_Collection $item     The font collection object.234		 * @param WP_REST_Request    $request  Request used to generate the response.235		 */236		return apply_filters( 'rest_prepare_font_collection', $response, $item, $request );237	}

Changelog

Introduced in 6.5.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 7.1.0 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-font-collections-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.