generate_block_asset_handle( string $block_name, string $field_name, int $index ): string
Generates the name for an asset based on the name of the block and the field name provided.
Parameters
-
$block_namestring Required -
Name of the block.
-
$field_namestring Required -
Name of the metadata field.
-
$indexint Optional -
Index of the asset when multiple items passed.
Default 0.
Return
string Generated asset name for the block's field.
Source
File: wp-includes/blocks.php.
View all references
function generate_block_asset_handle( $block_name, $field_name, $index = 0 ) {
if ( str_starts_with( $block_name, 'core/' ) ) {
$asset_handle = str_replace( 'core/', 'wp-block-', $block_name );
if ( str_starts_with( $field_name, 'editor' ) ) {
$asset_handle .= '-editor';
}
if ( str_starts_with( $field_name, 'view' ) ) {
$asset_handle .= '-view';
}
if ( $index > 0 ) {
$asset_handle .= '-' . ( $index + 1 );
}
return $asset_handle;
}
$field_mappings = array(
'editorScript' => 'editor-script',
'script' => 'script',
'viewScript' => 'view-script',
'editorStyle' => 'editor-style',
'style' => 'style',
);
$asset_handle = str_replace( '/', '-', $block_name ) .
'-' . $field_mappings[ $field_name ];
if ( $index > 0 ) {
$asset_handle .= '-' . ( $index + 1 );
}
return $asset_handle;
}
Changelog
| Version | Description |
|---|---|
| 6.1.0 | Added $index parameter. |
| 5.5.0 | Introduced. |