WP_REST_Templates_Controller::prepare_item_for_response( WP_Block_Template $item, WP_REST_Request $request ): WP_REST_Response

Parameters

$itemWP_Block_Template

Template instance.

$requestWP_REST_Request

Request object.

Return

WP_REST_Response

Response object.

Hooks fired · 1

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

1. 1
   apply_filters( the_title )filterline 750 (+72 into the body)

   Filters the post title.

Uses · 18

• parse_blocks()Parses blocks out of a content string.
• resolve_pattern_blocks()Replaces patterns in a block tree with their content.
• serialize_blocks()Returns a joined string of the aggregate serialization of the given parsed blocks.
• 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.
• block_version()Returns the current version of the block format that the content string is using.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• mysql_to_rfc3339()Parses and formats a MySQL datetime (Y-m-d H:i:s) for ISO8601 (Y-m-d\TH:i:s).
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• WP_REST_Response::__construct()
• WP_REST_Templates_Controller::get_fields_for_response()
• WP_REST_Templates_Controller::get_wp_templates_author_text_field()Returns a human readable text for the author of the template.
• WP_REST_Templates_Controller::get_wp_templates_original_source_field()Returns the source from where the template originally comes from.

Used by · 6

• WP_REST_Templates_Controller::create_item()Creates a single template.
• WP_REST_Templates_Controller::delete_item()Deletes a single template.
• WP_REST_Templates_Controller::get_item()Returns the given template
• WP_REST_Templates_Controller::get_items()Returns a list of templates.
• WP_REST_Templates_Controller::get_template_fallback()Returns the fallback template for the given slug.
• WP_REST_Templates_Controller::update_item()Updates a single template.

Source

View on Trac ↗View on GitHub ↗

678	public function prepare_item_for_response( $item, $request ) {679		// Don't prepare the response body for HEAD requests.680		if ( $request->is_method( 'HEAD' ) ) {681			return new WP_REST_Response( array() );682		}683 684		/*685		 * Resolve pattern blocks so they don't need to be resolved client-side686		 * in the editor, improving performance.687		 */688		$blocks        = parse_blocks( $item->content );689		$blocks        = resolve_pattern_blocks( $blocks );690		$item->content = serialize_blocks( $blocks );691 692		// Restores the more descriptive, specific name for use within this method.693		$template = $item;694 695		$fields = $this->get_fields_for_response( $request );696 697		// Base fields for every template.698		$data = array();699 700		if ( rest_is_field_included( 'id', $fields ) ) {701			$data['id'] = $template->id;702		}703 704		if ( rest_is_field_included( 'theme', $fields ) ) {705			$data['theme'] = $template->theme;706		}707 708		if ( rest_is_field_included( 'content', $fields ) ) {709			$data['content'] = array();710		}711		if ( rest_is_field_included( 'content.raw', $fields ) ) {712			$data['content']['raw'] = $template->content;713		}714 715		if ( rest_is_field_included( 'content.block_version', $fields ) ) {716			$data['content']['block_version'] = block_version( $template->content );717		}718 719		if ( rest_is_field_included( 'slug', $fields ) ) {720			$data['slug'] = $template->slug;721		}722 723		if ( rest_is_field_included( 'source', $fields ) ) {724			$data['source'] = $template->source;725		}726 727		if ( rest_is_field_included( 'origin', $fields ) ) {728			$data['origin'] = $template->origin;729		}730 731		if ( rest_is_field_included( 'type', $fields ) ) {732			$data['type'] = $template->type;733		}734 735		if ( rest_is_field_included( 'description', $fields ) ) {736			$data['description'] = $template->description;737		}738 739		if ( rest_is_field_included( 'title', $fields ) ) {740			$data['title'] = array();741		}742 743		if ( rest_is_field_included( 'title.raw', $fields ) ) {744			$data['title']['raw'] = $template->title;745		}746 747		if ( rest_is_field_included( 'title.rendered', $fields ) ) {748			if ( $template->wp_id ) {749				/** This filter is documented in wp-includes/post-template.php */750				$data['title']['rendered'] = apply_filters( 'the_title', $template->title, $template->wp_id );751			} else {752				$data['title']['rendered'] = $template->title;753			}754		}755 756		if ( rest_is_field_included( 'status', $fields ) ) {757			$data['status'] = $template->status;

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-templates-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.