generate_block_asset_handle( string $block_name, string $field_name, int $index = 0 ): string

Compatibility

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

Parameters

$block_namestring

Name of the block.

$field_namestring

Name of the metadata field.

$indexintoptional

Index of the asset when multiple items passed.
Default 0.Default: 0

Return value

string

Generated asset name for the block's field.

Performance profile

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

13–28

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

4

4 places in core call this, so the cost is paid more often than your own code shows.

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 generate_block_asset_handle() can have, taken from its control-flow graph on PHP 8.5.

Uses · 2

• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• str_ends_with()Polyfill for `str_ends_with()` function added in PHP 8.0.

Used by · 4

• enqueue_block_styles_assets()Function responsible for enqueuing the styles required for block styles functionality on the editor and on the frontend.
• register_block_script_handle()Finds a script handle for the selected block metadata field. It detects when a path to file was provided and optionally finds a corresponding asset file with details necessary to register the script under automatically generated handle name. It returns unprocessed script handle otherwise.
• register_block_script_module_id()Finds a script module ID for the selected block metadata field. It detects when a path to file was provided and optionally finds a corresponding asset file with details necessary to register the script module under with an automatically generated module ID. It returns unprocessed script module ID otherwise.
• register_block_style_handle()Finds a style handle for the block metadata field. It detects when a path to file was provided and registers the style under automatically generated handle name. It returns unprocessed style handle otherwise.

Source code

View on Trac ↗View on GitHub ↗

47function generate_block_asset_handle( $block_name, $field_name, $index = 0 ) {48	if ( str_starts_with( $block_name, 'core/' ) ) {49		$asset_handle = str_replace( 'core/', 'wp-block-', $block_name );50		if ( str_starts_with( $field_name, 'editor' ) ) {51			$asset_handle .= '-editor';52		}53		if ( str_starts_with( $field_name, 'view' ) ) {54			$asset_handle .= '-view';55		}56		if ( str_ends_with( strtolower( $field_name ), 'scriptmodule' ) ) {57			$asset_handle .= '-script-module';58		}59		if ( $index > 0 ) {60			$asset_handle .= '-' . ( $index + 1 );61		}62		return $asset_handle;63	}64 65	$field_mappings = array(66		'editorScript'     => 'editor-script',67		'editorStyle'      => 'editor-style',68		'script'           => 'script',69		'style'            => 'style',70		'viewScript'       => 'view-script',71		'viewScriptModule' => 'view-script-module',72		'viewStyle'        => 'view-style',73	);74	$asset_handle   = str_replace( '/', '-', $block_name ) .75		'-' . $field_mappings[ $field_name ];76	if ( $index > 0 ) {77		$asset_handle .= '-' . ( $index + 1 );78	}79	return $asset_handle;80}

Changelog

Introduced in 5.5.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 6.8.8 tag, from src/wp-includes/blocks.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.