WP_REST_Widgets_Controller::prepare_item_for_response( array $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

$itemarray

An array containing a widget_id and sidebar_id.

$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_Widgets_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

17–146

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

Plugin surface

1 hook

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

Called by

5

5 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
• serializeserialisationserialize()called directly

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

What one call costs · 50 distinct outcomes

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

Hooks and filters fired · 2

2 hooks fire while WP_REST_Widgets_Controller::prepare_item_for_response() runs, in this order:

1. 1
   apply_filters( rest_prepare_widget )filterline 689 (+18 into the body)

   Filters the REST API response for a widget.

2. 2
   apply_filters( rest_prepare_widget )filterline 753 (+82 into the body)

   Filters the REST API response for a widget.

Uses · 15

• __()Retrieves the translation of $text.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_parse_widget_id()Converts a widget ID into its id_base and number components.
• 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.
• wp_render_widget()Calls the render callback of a widget and returns the output.
• wp_render_widget_control()Calls the control callback of a widget and returns the output.
• wp_hash()Gets the hash of the given string.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• WP_Error::__construct()Initializes the error.
• WP_REST_Response::__construct()
• WP_REST_Widgets_Controller::get_fields_for_response()
• stdClass::__construct()

Used by · 5

• WP_REST_Widgets_Controller::create_item()Creates a widget.
• WP_REST_Widgets_Controller::delete_item()Deletes a widget.
• WP_REST_Widgets_Controller::get_item()Gets an individual widget.
• WP_REST_Widgets_Controller::get_items()Retrieves a collection of widgets.
• WP_REST_Widgets_Controller::update_item()Updates an existing widget.

Source code

View on Trac ↗View on GitHub ↗

671	public function prepare_item_for_response( $item, $request ) {672		global $wp_widget_factory, $wp_registered_widgets;673 674		$widget_id  = $item['widget_id'];675		$sidebar_id = $item['sidebar_id'];676 677		if ( ! isset( $wp_registered_widgets[ $widget_id ] ) ) {678			return new WP_Error(679				'rest_invalid_widget',680				__( 'The requested widget is invalid.' ),681				array( 'status' => 500 )682			);683		}684 685		$widget = $wp_registered_widgets[ $widget_id ];686		// Don't prepare the response body for HEAD requests.687		if ( $request->is_method( 'HEAD' ) ) {688			/** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php */689			return apply_filters( 'rest_prepare_widget', new WP_REST_Response( array() ), $widget, $request );690		}691 692		$parsed_id = wp_parse_widget_id( $widget_id );693		$fields    = $this->get_fields_for_response( $request );694 695		$prepared = array(696			'id'            => $widget_id,697			'id_base'       => $parsed_id['id_base'],698			'sidebar'       => $sidebar_id,699			'rendered'      => '',700			'rendered_form' => null,701			'instance'      => null,702		);703 704		if (705			rest_is_field_included( 'rendered', $fields ) &&706			'wp_inactive_widgets' !== $sidebar_id707		) {708			$prepared['rendered'] = trim( wp_render_widget( $widget_id, $sidebar_id ) );709		}710 711		if ( rest_is_field_included( 'rendered_form', $fields ) ) {712			$rendered_form = wp_render_widget_control( $widget_id );713			if ( ! is_null( $rendered_form ) ) {714				$prepared['rendered_form'] = trim( $rendered_form );715			}716		}717 718		if ( rest_is_field_included( 'instance', $fields ) ) {719			$widget_object = $wp_widget_factory->get_widget_object( $parsed_id['id_base'] );720			if ( $widget_object && isset( $parsed_id['number'] ) ) {721				$all_instances                   = $widget_object->get_settings();722				$instance                        = $all_instances[ $parsed_id['number'] ];723				$serialized_instance             = serialize( $instance );724				$prepared['instance']['encoded'] = base64_encode( $serialized_instance );725				$prepared['instance']['hash']    = wp_hash( $serialized_instance );726 727				if ( ! empty( $widget_object->widget_options['show_instance_in_rest'] ) ) {728					// Use new stdClass so that JSON result is {} and not [].729					$prepared['instance']['raw'] = empty( $instance ) ? new stdClass() : $instance;730				}731			}732		}733 734		$context  = ! empty( $request['context'] ) ? $request['context'] : 'view';735		$prepared = $this->add_additional_fields_to_object( $prepared, $request );736		$prepared = $this->filter_response_by_context( $prepared, $context );737 738		$response = rest_ensure_response( $prepared );739 740		if ( rest_is_field_included( '_links', $fields ) || rest_is_field_included( '_embedded', $fields ) ) {741			$response->add_links( $this->prepare_links( $prepared ) );742		}743 744		/**745		 * Filters the REST API response for a widget.746		 *747		 * @since 5.8.0748		 *749		 * @param WP_REST_Response|WP_Error $response The response object, or WP_Error object on failure.750		 * @param array                     $widget   The registered widget data.

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.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-widgets-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.