render_block_core_query_title( array $attributes, array $content, object $block ): string

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

$attributesarray

Block attributes.

$contentarray

Block content.

$blockobject

Block instance.

Return value

string

Returns the query title based on the queried object.

Performance profile

How much work a call to render_block_core_query_title() 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

Heavy

Reaches the database via get_post().

Scaling

Constant

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

Instructions

19–115

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• querycontent queryget_post()one call below render_block_core_query_title()
• hookthird-party callbacksapply_filters()one call below render_block_core_query_title()

Further down the call graph this can also reach option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 37 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 10

• is_archive()Determines whether the query is for an existing archive page.
• is_search()Determines whether the query is for a search.
• get_post_type()Retrieves the post type of the current post or of a given post.
• add_filter()Adds a callback function to a filter hook.
• get_the_archive_title()Retrieves the archive title based on the queried object.
• remove_filter()Removes a callback function from a filter hook.
• __()Retrieves the translation of $text.
• get_search_query()Retrieves the contents of the search WordPress query variable.
• get_post_type_object()Retrieves a post type object by name.
• get_block_wrapper_attributes()Generates a string of attributes by applying to the current block being rendered all of the features that the block supports.

Source code

View on Trac ↗View on GitHub ↗

21function render_block_core_query_title( $attributes, $content, $block ) {22	$type       = $attributes['type'] ?? null;23	$is_archive = is_archive();24	$is_search  = is_search();25	$post_type  = $block->context['query']['postType'] ?? get_post_type();26 27	if ( ! $type ||28		( 'archive' === $type && ! $is_archive ) ||29		( 'search' === $type && ! $is_search ) ||30		( 'post-type' === $type && ! $post_type )31	) {32		return '';33	}34	$title = '';35	if ( $is_archive ) {36		$show_prefix = $attributes['showPrefix'] ?? true;37		if ( ! $show_prefix ) {38			add_filter( 'get_the_archive_title_prefix', '__return_empty_string', 1 );39			$title = get_the_archive_title();40			remove_filter( 'get_the_archive_title_prefix', '__return_empty_string', 1 );41		} else {42			$title = get_the_archive_title();43		}44	}45	if ( $is_search ) {46		$title = __( 'Search results' );47 48		if ( isset( $attributes['showSearchTerm'] ) && $attributes['showSearchTerm'] ) {49			$title = sprintf(50				/* translators: %s is the search term. */51				__( 'Search results for: &#8220;%s&#8221;' ),52				get_search_query()53			);54		}55	}56	if ( 'post-type' === $type ) {57		$post_type_object = get_post_type_object( $post_type );58 59		if ( ! $post_type_object ) {60			return '';61		}62 63		$post_type_name = $post_type_object->labels->singular_name;64		$show_prefix    = $attributes['showPrefix'] ?? true;65 66		if ( $show_prefix ) {67			$title = sprintf(68				/* translators: %s is the post type name. */69				__( 'Post Type: &#8220;%s&#8221;' ),70				$post_type_name71			);72		} else {73			$title = $post_type_name;74		}75	}76 77	$level    = (int) ( $attributes['level'] ?? 1 );78	$tag_name = 0 === $level ? 'p' : 'h' . $level;79 80	$align_class_name   = empty( $attributes['textAlign'] ) ? '' : "has-text-align-{$attributes['textAlign']}";81	$wrapper_attributes = get_block_wrapper_attributes( array( 'class' => $align_class_name ) );82	return sprintf(83		'<%1$s %2$s>%3$s</%1$s>',84		$tag_name,85		$wrapper_attributes,86		$title87	);88}

Changelog

Introduced in 5.8.0. 3 changes between 6.7.7 and 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/blocks/query-title.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.