_block_bindings_term_data_get_value( array $source_args, WP_Block $block_instance ): mixed

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

$source_argsarray

Array containing source arguments used to look up the override value.
Example: array( "field" => "name" ).

$block_instanceWP_Block

The block instance.

Return value

mixed

The value computed for the source.

Performance profile

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

Scaling

Constant

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

Instructions

5–74

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

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_term()called directly
• hookthird-party callbacksapply_filters()one call below _block_bindings_term_data_get_value()

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 · 12 distinct outcomes

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

Uses · 8

• get_term()Gets all term data from database by term ID.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• get_taxonomy()Retrieves the taxonomy object of $taxonomy.
• current_user_can()Returns whether the current user has the specified capability.
• esc_html()Escaping for HTML blocks.
• get_term_link()Generates a permalink for a taxonomy term archive.
• esc_url()Checks and cleans a URL.
• wp_kses_post()Sanitizes content for allowed HTML tags for post content.

Source code

View on Trac ↗View on GitHub ↗

21function _block_bindings_term_data_get_value( array $source_args, $block_instance ) {22	if ( empty( $source_args['field'] ) ) {23		return null;24	}25 26	/*27	 * BACKWARDS COMPATIBILITY: Hardcoded exception for navigation blocks.28	 * Required for WordPress 6.9+ navigation blocks. DO NOT REMOVE.29	 */30	$block_name          = $block_instance->name ?? '';31	$is_navigation_block = in_array(32		$block_name,33		array( 'core/navigation-link', 'core/navigation-submenu' ),34		true35	);36 37	if ( $is_navigation_block ) {38		// Navigation blocks: read from block attributes.39		$term_id = $block_instance->attributes['id'] ?? null;40		$type    = $block_instance->attributes['type'] ?? '';41		// Map UI shorthand to taxonomy slug when using attributes.42		$taxonomy = ( 'tag' === $type ) ? 'post_tag' : $type;43	} else {44		// All other blocks: use context45		$term_id  = $block_instance->context['termId'] ?? null;46		$taxonomy = $block_instance->context['taxonomy'] ?? '';47	}48 49	// If we don't have required identifiers, bail early.50	if ( empty( $term_id ) || empty( $taxonomy ) ) {51		return null;52	}53 54	// Get the term data.55	$term = get_term( $term_id, $taxonomy );56	if ( is_wp_error( $term ) || ! $term ) {57		return null;58	}59 60	// Check if taxonomy exists and is publicly queryable.61	$taxonomy_object = get_taxonomy( $taxonomy );62	if ( ! $taxonomy_object || ! $taxonomy_object->publicly_queryable ) {63		if ( ! current_user_can( 'read' ) ) {64			return null;65		}66	}67 68	switch ( $source_args['field'] ) {69		case 'id':70			return esc_html( (string) $term_id );71 72		case 'name':73			return esc_html( $term->name );74 75		case 'link':76			// Only taxonomy entities are supported by Term Data.77			$term_link = get_term_link( $term );78			return is_wp_error( $term_link ) ? null : esc_url( $term_link );79 80		case 'slug':81			return esc_html( $term->slug );82 83		case 'description':84			return wp_kses_post( $term->description );85 86		case 'parent':87			return esc_html( (string) $term->parent );88 89		case 'count':90			return esc_html( (string) $term->count );91 92		default:93			return null;94	}95}

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/block-bindings/term-data.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.