render_block_core_term_template( array $attributes, string $content, WP_Block $block ): string

Compatibility

Present in 3 of the 5 tracked releases, added in 6.9.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$attributesarray

Block attributes.

$contentstring

Block default content.

$blockWP_Block

Block instance.

Return value

string

Returns the output of the term template.

Performance profile

How much work a call to render_block_core_term_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

8

Executed per call on PHP 8.5. The body compiles to 180.

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

• hookthird-party callbacksdo_action()one call below render_block_core_term_template()

Further down the call graph this can also reach option, cache, serialize, query 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 · 1 distinct outcome

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

Uses · 13

• is_tax()Determines whether the query is for an existing custom taxonomy archive page.
• is_category()Determines whether the query is for an existing category archive page.
• is_tag()Determines whether the query is for an existing tag archive page.
• get_queried_object()Retrieves the currently queried object.
• is_taxonomy_hierarchical()Determines whether the taxonomy object is hierarchical.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• add_filter()Adds a callback function to a filter hook.
• remove_filter()Removes a callback function from a filter hook.
• esc_attr()Escaping for HTML attributes.
• 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.
• WP_Term_Query::__construct()Constructor.
• new WP_Block($block_instance)::render()

Source code

View on Trac ↗View on GitHub ↗

19function render_block_core_term_template( $attributes, $content, $block ) {20	if ( ! isset( $block->context ) || empty( $block->context['termQuery'] ) ) {21		return '';22	}23 24	$query = $block->context['termQuery'];25 26	$query_args = array(27		'number'     => $query['perPage'],28		'order'      => $query['order'],29		'orderby'    => $query['orderBy'],30		'hide_empty' => $query['hideEmpty'],31	);32 33	$inherit_query = isset( $query['inherit'] )34		&& $query['inherit']35		&& ( is_tax() || is_category() || is_tag() );36 37	if ( $inherit_query ) {38		// Get the current term and taxonomy from the queried object.39		$queried_object = get_queried_object();40 41		// For hierarchical taxonomies, show children of the current term.42		// For non-hierarchical taxonomies, show all terms (don't set parent).43		if ( is_taxonomy_hierarchical( $queried_object->taxonomy ) ) {44			// If showNested is true, use child_of to include nested terms.45			// Otherwise, use parent to show only direct children.46			if ( ! empty( $query['showNested'] ) ) {47				$query_args['child_of'] = $queried_object->term_id;48			} else {49				$query_args['parent'] = $queried_object->term_id;50			}51		}52		$query_args['taxonomy'] = $queried_object->taxonomy;53	} else {54		// If not inheriting set `taxonomy` from the block attribute.55		$query_args['taxonomy'] = $query['taxonomy'];56 57		// If we are including specific terms we ignore `showNested` argument.58		if ( ! empty( $query['include'] ) ) {59			$query_args['include'] = array_unique( array_map( 'intval', $query['include'] ) );60			$query_args['orderby'] = 'include';61			$query_args['order']   = 'asc';62		} elseif ( is_taxonomy_hierarchical( $query['taxonomy'] ) && empty( $query['showNested'] ) ) {63			// We set parent only when inheriting from the taxonomy archive context or not64			// showing nested terms, otherwise nested terms are not displayed.65			$query_args['parent'] = 0;66		}67	}68 69	$terms_query = new WP_Term_Query( $query_args );70	$terms       = $terms_query->get_terms();71 72	if ( ! $terms || is_wp_error( $terms ) ) {73		return '';74	}75 76	$content = '';77	foreach ( $terms as $term ) {78		// Get an instance of the current Term Template block.79		$block_instance = $block->parsed_block;80 81		// Set the block name to one that does not correspond to an existing registered block.82		// This ensures that for the inner instances of the Term Template block, we do not render any block supports.83		$block_instance['blockName'] = 'core/null';84 85		$term_id  = $term->term_id;86		$taxonomy = $term->taxonomy;87 88		$filter_block_context = static function ( $context ) use ( $term_id, $taxonomy ) {89			$context['termId']   = $term_id;90			$context['taxonomy'] = $taxonomy;91			return $context;92		};93 94		// Use an early priority to so that other 'render_block_context' filters have access to the values.95		add_filter( 'render_block_context', $filter_block_context, 1 );96 97		// Render the inner blocks of the Term Template block with `dynamic` set to `false` to prevent calling98		// `render_callback` and ensure that no wrapper markup is included.

Changelog

Introduced in 6.9.0. Unchanged from 6.9.7 through 7.1.0.

1. 6.9.7
2. 7.0.4
3. 7.1.0

Signature, return type and hooks compared across 3 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/blocks/term-template.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.