W3cubDocs

/WordPress

WP_REST_Block_Renderer_Controller::get_item( WP_REST_Request $request )

Returns block output from block’s registered render_callback.

Parameters

$request

(WP_REST_Request) (Required) Full details about the request.

Return

(WP_REST_Response|WP_Error) Response object on success, or WP_Error object on failure.

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-block-renderer-controller.php 

public function get_item( $request ) {
		global $post;

		$post_id = isset( $request['post_id'] ) ? intval( $request['post_id'] ) : 0;

		if ( 0 < $post_id ) {
			$post = get_post( $post_id );

			// Set up postdata since this will be needed if post_id was set.
			setup_postdata( $post );
		}

		$registry   = WP_Block_Type_Registry::get_instance();
		$registered = $registry->get_registered( $request['name'] );

		if ( null === $registered || ! $registered->is_dynamic() ) {
			return new WP_Error(
				'block_invalid',
				__( 'Invalid block.' ),
				array(
					'status' => 404,
				)
			);
		}

		$attributes = $request->get_param( 'attributes' );

		// Create an array representation simulating the output of parse_blocks.
		$block = array(
			'blockName'    => $request['name'],
			'attrs'        => $attributes,
			'innerHTML'    => '',
			'innerContent' => array(),
		);

		// Render using render_block to ensure all relevant filters are used.
		$data = array(
			'rendered' => render_block( $block ),
		);

		return rest_ensure_response( $data );
	}

Uses

Uses Description
wp-includes/class-wp-block-type-registry.php: WP_Block_Type_Registry::get_instance()

Utility method to retrieve the main instance of the class.
wp-includes/blocks.php: render_block()

Renders a single block into a HTML string.
wp-includes/rest-api.php: rest_ensure_response()

Ensures a REST response is a response object (for consistency).
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/query.php: setup_postdata()

Set up global post data.
wp-includes/post.php: get_post()

Retrieves post data given a post ID or post object.
wp-includes/class-wp-error.php: WP_Error::__construct()

Initialize the error.

Changelog

Version Description
5.0.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_block_renderer_controller/get_item