WP_REST_Sidebars_Controller::prepare_item_for_response( array $item, WP_REST_Request $request ): WP_REST_Response

Parameters

$itemarray

Sidebar instance.

$requestWP_REST_Request

Full details about the request.

Return

WP_REST_Response

Prepared response object.

Hooks fired · 2

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

1. 1
   apply_filters( rest_prepare_sidebar )filterline 332 (+9 into the body)

   Filters the REST API response for a sidebar.

2. 2
   apply_filters( rest_prepare_sidebar )filterline 402 (+79 into the body)

   Filters the REST API response for a sidebar.

Uses · 13

• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_sidebar_description()Retrieves description for a sidebar.
• wp_is_block_theme()Returns whether the active theme is a block-based theme or not.
• 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_get_sidebars_widgets()Retrieves the full list of sidebars and their widget instance IDs.
• rest_validate_value_from_schema()Validate a value based on a schema.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• WP_REST_Response::__construct()
• WP_REST_Sidebars_Controller::get_fields_for_response()
• WP_REST_Sidebars_Controller::get_item_schema()Retrieves the block type' schema, conforming to JSON Schema.
• WP_REST_Sidebars_Controller::add_additional_fields_to_object()
• WP_REST_Sidebars_Controller::filter_response_by_context()

Used by · 3

• WP_REST_Sidebars_Controller::get_item()Retrieves one sidebar from the collection.
• WP_REST_Sidebars_Controller::get_items()Retrieves the list of sidebars (active or inactive).
• WP_REST_Sidebars_Controller::update_item()Updates a sidebar.

Source

View on Trac ↗View on GitHub ↗

323	public function prepare_item_for_response( $item, $request ) {324		global $wp_registered_sidebars, $wp_registered_widgets;325 326		// Restores the more descriptive, specific name for use within this method.327		$raw_sidebar = $item;328 329		// Don't prepare the response body for HEAD requests.330		if ( $request->is_method( 'HEAD' ) ) {331			/** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php */332			return apply_filters( 'rest_prepare_sidebar', new WP_REST_Response( array() ), $raw_sidebar, $request );333		}334 335		$id      = $raw_sidebar['id'];336		$sidebar = array( 'id' => $id );337 338		if ( isset( $wp_registered_sidebars[ $id ] ) ) {339			$registered_sidebar = $wp_registered_sidebars[ $id ];340 341			$sidebar['status']        = 'active';342			$sidebar['name']          = $registered_sidebar['name'] ?? '';343			$sidebar['description']   = isset( $registered_sidebar['description'] ) ? wp_sidebar_description( $id ) : '';344			$sidebar['class']         = $registered_sidebar['class'] ?? '';345			$sidebar['before_widget'] = $registered_sidebar['before_widget'] ?? '';346			$sidebar['after_widget']  = $registered_sidebar['after_widget'] ?? '';347			$sidebar['before_title']  = $registered_sidebar['before_title'] ?? '';348			$sidebar['after_title']   = $registered_sidebar['after_title'] ?? '';349		} else {350			$sidebar['status']      = 'inactive';351			$sidebar['name']        = $raw_sidebar['name'];352			$sidebar['description'] = '';353			$sidebar['class']       = '';354		}355 356		if ( wp_is_block_theme() ) {357			$sidebar['status'] = 'inactive';358		}359 360		$fields = $this->get_fields_for_response( $request );361		if ( rest_is_field_included( 'widgets', $fields ) ) {362			$sidebars = wp_get_sidebars_widgets();363			$widgets  = array_filter(364				$sidebars[ $sidebar['id'] ] ?? array(),365				static function ( $widget_id ) use ( $wp_registered_widgets ) {366					return isset( $wp_registered_widgets[ $widget_id ] );367				}368			);369 370			$sidebar['widgets'] = array_values( $widgets );371		}372 373		$schema = $this->get_item_schema();374		$data   = array();375		foreach ( $schema['properties'] as $property_id => $property ) {376			if ( isset( $sidebar[ $property_id ] ) && true === rest_validate_value_from_schema( $sidebar[ $property_id ], $property ) ) {377				$data[ $property_id ] = $sidebar[ $property_id ];378			} elseif ( isset( $property['default'] ) ) {379				$data[ $property_id ] = $property['default'];380			}381		}382 383		$context = ! empty( $request['context'] ) ? $request['context'] : 'view';384		$data    = $this->add_additional_fields_to_object( $data, $request );385		$data    = $this->filter_response_by_context( $data, $context );386 387		$response = rest_ensure_response( $data );388 389		if ( rest_is_field_included( '_links', $fields ) || rest_is_field_included( '_embedded', $fields ) ) {390			$response->add_links( $this->prepare_links( $sidebar ) );391		}392 393		/**394		 * Filters the REST API response for a sidebar.395		 *396		 * @since 5.8.0397		 *398		 * @param WP_REST_Response $response    The response object.399		 * @param array            $raw_sidebar The raw sidebar data.400		 * @param WP_REST_Request  $request     The request object.401		 */402		return apply_filters( 'rest_prepare_sidebar', $response, $raw_sidebar, $request );

History

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 7.1.0 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-sidebars-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.