_build_block_template_result_from_post( WP_Post $post ): WP_Block_Template|WP_Error

Parameters

$postWP_Post

Template post.

Return

WP_Block_Template|WP_Error

Template or error object.

Uses · 18

• wp_is_post_revision()Determines if the specified post is a revision.
• get_post()Retrieves post data given a post ID or post object.
• get_the_terms()Retrieves the terms of the taxonomy that are attached to the post.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• __()Retrieves the translation of $text.
• get_post_meta()Retrieves a post meta field for the given post ID.
• _build_block_template_object_from_post_object()Builds a block template object from a post object.
• get_users()Retrieves list of users matching criteria.
• _wp_build_title_and_description_for_single_post_type_block_template()Builds the title and description of a post-specific template based on the underlying referenced post.
• get_post_types()Gets a list of all registered post type objects.
• _wp_build_title_and_description_for_taxonomy_block_template()Builds the title and description of a taxonomy-specific template based on the underlying entity referenced.
• get_taxonomies()Retrieves a list of registered taxonomy names or objects.

Used by · 6

• WP_Navigation_Block_Renderer::get_overlay_blocks_from_template_part()Gets the inner blocks for the navigation block from an overlay template part.
• WP_REST_Template_Autosaves_Controller::prepare_item_for_response()Prepares the item for the REST response.
• WP_REST_Template_Revisions_Controller::prepare_item_for_response()Prepares the item for the REST response.
• get_block_template()Retrieves a single unified template object using its id.
• get_block_templates()Retrieves a list of unified template objects based on a query.
• render_block_core_template_part()Renders the `core/template-part` block on the server.

Source

View on Trac ↗View on GitHub ↗

900function _build_block_template_result_from_post( $post ) {901	$post_id = wp_is_post_revision( $post );902	if ( ! $post_id ) {903		$post_id = $post;904	}905	$parent_post     = get_post( $post_id );906	$post->post_name = $parent_post->post_name;907	$post->post_type = $parent_post->post_type;908 909	$terms = get_the_terms( $parent_post, 'wp_theme' );910 911	if ( is_wp_error( $terms ) ) {912		return $terms;913	}914 915	if ( ! $terms ) {916		return new WP_Error( 'template_missing_theme', __( 'No theme is defined for this template.' ) );917	}918 919	$terms = array(920		'wp_theme' => $terms[0]->name,921	);922 923	if ( 'wp_template_part' === $parent_post->post_type ) {924		$type_terms = get_the_terms( $parent_post, 'wp_template_part_area' );925		if ( ! is_wp_error( $type_terms ) && false !== $type_terms ) {926			$terms['wp_template_part_area'] = $type_terms[0]->name;927		}928	}929 930	$meta = array(931		'origin'           => get_post_meta( $parent_post->ID, 'origin', true ),932		'is_wp_suggestion' => get_post_meta( $parent_post->ID, 'is_wp_suggestion', true ),933	);934 935	$template = _build_block_template_object_from_post_object( $post, $terms, $meta );936 937	if ( is_wp_error( $template ) ) {938		return $template;939	}940 941	// Check for a block template without a description and title or with a title equal to the slug.942	if ( 'wp_template' === $parent_post->post_type && empty( $template->description ) && ( empty( $template->title ) || $template->title === $template->slug ) ) {943		$matches = array();944 945		// Check for a block template for a single author, page, post, tag, category, custom post type, or custom taxonomy.946		if ( preg_match( '/(author|page|single|tag|category|taxonomy)-(.+)/', $template->slug, $matches ) ) {947			$type           = $matches[1];948			$slug_remaining = $matches[2];949 950			switch ( $type ) {951				case 'author':952					$nice_name = $slug_remaining;953					$users     = get_users(954						array(955							'capability'     => 'edit_posts',956							'search'         => $nice_name,957							'search_columns' => array( 'user_nicename' ),958							'fields'         => 'display_name',959						)960					);961 962					if ( empty( $users ) ) {963						$template->title = sprintf(964							/* translators: Custom template title in the Site Editor, referencing a deleted author. %s: Author nicename. */965							__( 'Deleted author: %s' ),966							$nice_name967						);968					} else {969						$author_name = $users[0];970 971						$template->title = sprintf(972							/* translators: Custom template title in the Site Editor. %s: Author name. */973							__( 'Author: %s' ),974							$author_name975						);976 977						$template->description = sprintf(978							/* translators: Custom template description in the Site Editor. %s: Author name. */979							__( 'Template for %s' ),

History

Introduced in 5.9.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/block-template-utils.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.