wppaste
WordPress

block_core_navigation_link_filter_variations( array $variations, WP_Block_Type $block_type ): array

Since
6.5.0
Source
wp-includes/blocks/navigation-link.php:412
Filters the registered variations for a block type.

Description

Returns the dynamically built variations for all post-types and taxonomies.

Compatibility

WordPress
since 6.5.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$variationsarray
Array of registered variations for a block type.
$block_typeWP_Block_Type
The full block type object.

Return value

array
Numerically indexed array of block variations.

Performance profile

How much work a call to block_core_navigation_link_filter_variations() 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
6–13

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

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 one call costs · 2 distinct outcomes

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

WhenInstructionsCalls it makes
always6none
always13block_core_navigation_link_build_variations(), array_merge()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 14 instructions, 6–13 executed per call, 1 branch. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 1

Source code

function block_core_navigation_link_filter_variations( $variations, $block_type ) {	if ( 'core/navigation-link' !== $block_type->name ) {		return $variations;	} 	$generated_variations = block_core_navigation_link_build_variations(); 	/*	 * IMPORTANT: Order matters for deduplication.	 *	 * The variations returned from this filter are bootstrapped to JavaScript and	 * processed by the block variations reducer. The reducer uses `getUniqueItemsByName()`	 * (packages/blocks/src/store/reducer.js:51-57) which keeps the FIRST variation with	 * a given 'name' and discards later duplicates when processing the array in order.	 *	 * By placing generated variations first in `array_merge()`, the improved	 * labels (e.g., "Product link" instead of generic "Post Link") are processed first	 * and preserved. The generic incoming variations are then discarded as duplicates.	 *	 * Why `array_merge()` instead of manual deduplication?	 * - Both arrays use numeric indices (0, 1, 2...), so `array_merge()` concatenates	 *   and re-indexes them sequentially, preserving order	 * - The reducer handles deduplication, so it is not needed here	 * - This keeps the PHP code simple and relies on the established JavaScript behavior	 *	 * See: https://github.com/WordPress/gutenberg/pull/72517	 */	return array_merge( $generated_variations, $variations );}

Changelog

Introduced in 6.5.0. One change 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.

7.0.4
Return type changed from none to array.verified against source
6.5.0
Introduced.from the docblock

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.