build_variation_for_navigation_link( WP_Taxonomy|WP_Post_Type $entity, string $kind ): array

Compatibility

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

Parameters

$entityWP_Taxonomy|WP_Post_Type

post type or taxonomy entity.

$kindstring

string of value 'taxonomy' or 'post-type'.

Return value

array

Performance profile

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

57–98

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

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

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

Uses · 3

• __()Retrieves the translation of $text.
• WP_Post_Type::get_default_labels()Returns the default labels for post types.
• WP_Taxonomy::get_default_labels()Returns the default labels for taxonomies.

Used by · 1

• block_core_navigation_link_build_variations()Returns an array of variations for the navigation link block.

Source code

View on Trac ↗View on GitHub ↗

311function build_variation_for_navigation_link( $entity, $kind ) {312	$title       = '';313	$description = '';314 315	// Get default labels based on entity type316	$default_labels = null;317	if ( $entity instanceof WP_Post_Type ) {318		$default_labels = WP_Post_Type::get_default_labels();319	} elseif ( $entity instanceof WP_Taxonomy ) {320		$default_labels = WP_Taxonomy::get_default_labels();321	}322 323	// Get title and check if it's default324	$is_default_title = false;325	if ( property_exists( $entity->labels, 'item_link' ) ) {326		$title = $entity->labels->item_link;327		if ( isset( $default_labels['item_link'] ) ) {328			$is_default_title = in_array( $title, $default_labels['item_link'], true );329		}330	}331 332	// Get description and check if it's default333	$is_default_description = false;334	if ( property_exists( $entity->labels, 'item_link_description' ) ) {335		$description = $entity->labels->item_link_description;336		if ( isset( $default_labels['item_link_description'] ) ) {337			$is_default_description = in_array( $description, $default_labels['item_link_description'], true );338		}339	}340 341	// Calculate singular name once (used for both title and description)342	$singular = $entity->labels->singular_name ?? ucfirst( $entity->name );343 344	// Set default title if needed345	if ( $is_default_title || '' === $title ) {346		/* translators: %s: Singular label of the entity. */347		$title = sprintf( __( '%s link' ), $singular );348	}349 350	// Default description if needed.351	// Use a single space character instead of an empty string to prevent fallback to the352	// block.json default description ("Add a page, link, or another item to your navigation.").353	// An empty string would be treated as missing and trigger the fallback, while a single354	// space appears blank in the UI but prevents the fallback behavior.355	// We avoid generating descriptions like "A link to a %s" to prevent grammatical errors356	// (e.g., "A link to a event" should be "A link to an event").357	if ( $is_default_description || '' === $description ) {358		$description = ' ';359	}360 361	$variation = array(362		'name'        => $entity->name,363		'title'       => $title,364		'description' => $description,365		'attributes'  => array(366			'type' => $entity->name,367			'kind' => $kind,368		),369	);370 371	// Tweak some value for the variations.372	$variation_overrides = array(373		'post_tag'    => array(374			'name'       => 'tag',375			'attributes' => array(376				'type' => 'tag',377				'kind' => $kind,378			),379		),380		'post_format' => array(381			// The item_link and item_link_description for post formats is the382			// same as for tags, so need to be overridden.383			'title'       => __( 'Post Format Link' ),384			'description' => __( 'A link to a post format' ),385			'attributes'  => array(386				'type' => 'post_format',387				'kind' => $kind,388			),389		),390	);

Changelog

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/blocks/navigation-link.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.