_resolve_home_block_template(): array|null

In this article

This function has been deprecated. Site Editor’s server-side redirect for missing postType and postId query args is removed. Thus, this function is no longer used instead.

This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

Returns the correct template for the site’s home page.

Return

array|null A template object, or null if none could be found.

Source

function _resolve_home_block_template() {
	_deprecated_function( __FUNCTION__, '6.2.0' );

	$show_on_front = get_option( 'show_on_front' );
	$front_page_id = get_option( 'page_on_front' );

	if ( 'page' === $show_on_front && $front_page_id ) {
		return array(
				'postType' => 'page',
				'postId'   => $front_page_id,
		);
	}

	$hierarchy = array( 'front-page', 'home', 'index' );
	$template  = resolve_block_template( 'home', $hierarchy, '' );

	if ( ! $template ) {
		return null;
	}

	return array(
			'postType' => 'wp_template',
			'postId'   => $template->id,
	);
}

Changelog

VersionDescription
6.2.0Site Editor’s server-side redirect for missing postType and postId query args is removed. Thus, this function is no longer used.
6.0.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.