register_block_script_handle( array $metadata, string $field_name, int $index = 0 ): string|false

Description

Compatibility

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

Parameters

$metadataarray

Block metadata.

$field_namestring

Field name to pick from metadata.

$indexintoptional

Index of the script to register when multiple items passed.
Default 0.Default: 0

Return value

string|false

Script handle provided directly or created through script's registration, or false on failure.

Performance profile

How much work a call to register_block_script_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

6–111

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

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

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

Uses · 7

• remove_block_asset_path_prefix()Removes the block asset's path prefix if provided.
• wp_normalize_path()Normalizes a filesystem path.
• generate_block_asset_handle()Generates the name for an asset based on the name of the block and the field name provided.
• wp_script_is()Determines whether a script has been added to the queue.
• get_block_asset_url()Gets the URL to a block asset.
• wp_register_script()Registers a new script.
• wp_set_script_translations()Sets translated strings for a script.

Used by · 1

• register_block_type_from_metadata()Registers a block type from the metadata stored in the `block.json` file.

Source code

View on Trac ↗View on GitHub ↗

267function register_block_script_handle( $metadata, $field_name, $index = 0 ) {268	if ( empty( $metadata[ $field_name ] ) ) {269		return false;270	}271 272	$script_handle_or_path = $metadata[ $field_name ];273	if ( is_array( $script_handle_or_path ) ) {274		if ( empty( $script_handle_or_path[ $index ] ) ) {275			return false;276		}277		$script_handle_or_path = $script_handle_or_path[ $index ];278	}279 280	$script_path = remove_block_asset_path_prefix( $script_handle_or_path );281	if ( $script_handle_or_path === $script_path ) {282		return $script_handle_or_path;283	}284 285	$path                  = dirname( $metadata['file'] );286	$script_asset_raw_path = $path . '/' . substr_replace( $script_path, '.asset.php', - strlen( '.js' ) );287	$script_asset_path     = wp_normalize_path(288		realpath( $script_asset_raw_path )289	);290 291	// Asset file for blocks is optional. See https://core.trac.wordpress.org/ticket/60460.292	/** @var array{ handle?: non-falsy-string, dependencies?: list<non-falsy-string>, version?: string|false|null, ... } $script_asset */293	$script_asset  = ! empty( $script_asset_path ) ? require $script_asset_path : array();294	$script_handle = $script_asset['handle'] ??295		generate_block_asset_handle( $metadata['name'], $field_name, $index );296	if ( wp_script_is( $script_handle, 'registered' ) ) {297		return $script_handle;298	}299 300	$script_path_norm    = wp_normalize_path( realpath( $path . '/' . $script_path ) );301	$script_uri          = get_block_asset_url( $script_path_norm );302	$script_dependencies = $script_asset['dependencies'] ?? array();303	$block_version       = $metadata['version'] ?? false;304	$script_version      = $script_asset['version'] ?? $block_version;305	$script_args         = array();306	if ( 'viewScript' === $field_name && $script_uri ) {307		$script_args['strategy'] = 'defer';308	}309 310	$result = wp_register_script(311		$script_handle,312		$script_uri,313		$script_dependencies,314		$script_version,315		$script_args316	);317	if ( ! $result ) {318		return false;319	}320 321	if ( ! empty( $metadata['textdomain'] ) && in_array( 'wp-i18n', $script_dependencies, true ) ) {322		wp_set_script_translations( $script_handle, $metadata['textdomain'] );323	}324 325	return $script_handle;326}

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 7.1.0 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.