_wp_build_title_and_description_for_single_post_type_block_template( string $post_type, string $slug, WP_Block_Template $template ): bool

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$post_typestring

Post type, e.g. page, post, product.

$slugstring

Slug of the post, e.g. a-story-about-shoes.

$templateWP_Block_Template

Template to mutate adding the description and title computed.

Return value

bool

Returns true if the referenced post was found and false otherwise.

Performance profile

How much work a call to _wp_build_title_and_description_for_single_post_type_block_template() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

40–78

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 91.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What one call costs · 3 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost _wp_build_title_and_description_for_single_post_type_block_template() can have, taken from its control-flow graph on PHP 8.5.

Uses · 4

• get_post_type_object()Retrieves a post type object by name.
• wp_parse_args()Merges user defined arguments into defaults array.
• __()Retrieves the translation of $text.
• WP_Query::__construct()Constructor.

Used by · 1

• _build_block_template_result_from_post()Builds a unified template object based a post Object.

Source code

View on Trac ↗View on GitHub ↗

686function _wp_build_title_and_description_for_single_post_type_block_template( $post_type, $slug, WP_Block_Template $template ) {687	$post_type_object = get_post_type_object( $post_type );688 689	$default_args = array(690		'post_type'              => $post_type,691		'post_status'            => 'publish',692		'posts_per_page'         => 1,693		'update_post_meta_cache' => false,694		'update_post_term_cache' => false,695		'ignore_sticky_posts'    => true,696		'no_found_rows'          => true,697	);698 699	$args = array(700		'name' => $slug,701	);702	$args = wp_parse_args( $args, $default_args );703 704	$posts_query = new WP_Query( $args );705 706	if ( empty( $posts_query->posts ) ) {707		$template->title = sprintf(708			/* translators: Custom template title in the Site Editor referencing a post that was not found. 1: Post type singular name, 2: Post type slug. */709			__( 'Not found: %1$s (%2$s)' ),710			$post_type_object->labels->singular_name,711			$slug712		);713 714		return false;715	}716 717	$post_title = $posts_query->posts[0]->post_title;718 719	$template->title = sprintf(720		/* translators: Custom template title in the Site Editor. 1: Post type singular name, 2: Post title. */721		__( '%1$s: %2$s' ),722		$post_type_object->labels->singular_name,723		$post_title724	);725 726	$template->description = sprintf(727		/* translators: Custom template description in the Site Editor. %s: Post title. */728		__( 'Template for %s' ),729		$post_title730	);731 732	$args = array(733		'title' => $post_title,734	);735	$args = wp_parse_args( $args, $default_args );736 737	$posts_with_same_title_query = new WP_Query( $args );738 739	if ( count( $posts_with_same_title_query->posts ) > 1 ) {740		$template->title = sprintf(741			/* translators: Custom template title in the Site Editor. 1: Template title, 2: Post type slug. */742			__( '%1$s (%2$s)' ),743			$template->title,744			$slug745		);746	}747 748	return true;749}

Changelog

Introduced in 6.1.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.