wpseek.com
A WordPress-centric search engine for devs and theme authors



register_block_script_module_id › WordPress Function

Since6.5.0
Deprecatedn/a
› register_block_script_module_id ( $metadata, $field_name, $index = 0 )
Parameters: (3)
  • (array) $metadata Block metadata.
    Required: Yes
  • (string) $field_name Field name to pick from metadata.
    Required: Yes
  • (int) $index Optional. Index of the script module ID to register when multiple items passed. Default 0.
    Required: No
    Default: —
Returns:
  • (string|false) Script module ID or false on failure.
Defined at:
Codex:

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.



Related Functions: register_block_script_handle, wp_register_script_module, wp_deregister_script_module, register_block_core_video, register_block_style

Source 

function register_block_script_module_id( $metadata, $field_name, $index = 0 ) {
	if ( empty( $metadata[ $field_name ] ) ) {
		return false;
	}

	$module_id = $metadata[ $field_name ];
	if ( is_array( $module_id ) ) {
		if ( empty( $module_id[ $index ] ) ) {
			return false;
		}
		$module_id = $module_id[ $index ];
	}

	$module_path = remove_block_asset_path_prefix( $module_id );
	if ( $module_id === $module_path ) {
		return $module_id;
	}

	$path                  = dirname( $metadata['file'] );
	$module_asset_raw_path = $path . '/' . substr_replace( $module_path, '.asset.php', - strlen( '.js' ) );
	$module_id             = generate_block_asset_handle( $metadata['name'], $field_name, $index );
	$module_asset_path     = wp_normalize_path(
		realpath( $module_asset_raw_path )
	);

	$module_path_norm = wp_normalize_path( realpath( $path . '/' . $module_path ) );
	$module_uri       = get_block_asset_url( $module_path_norm );

	$module_asset        = ! empty( $module_asset_path ) ? require $module_asset_path : array();
	$module_dependencies = $module_asset['dependencies'] ?? array();
	$block_version       = $metadata['version'] ?? false;
	$module_version      = $module_asset['version'] ?? $block_version;

	$supports_interactivity_true = isset( $metadata['supports']['interactivity'] ) && true === $metadata['supports']['interactivity'];
	$is_interactive              = $supports_interactivity_true || ( isset( $metadata['supports']['interactivity']['interactive'] ) && true === $metadata['supports']['interactivity']['interactive'] );
	$supports_client_navigation  = $supports_interactivity_true || ( isset( $metadata['supports']['interactivity']['clientNavigation'] ) && true === $metadata['supports']['interactivity']['clientNavigation'] );

	$args = array();

	// Blocks using the Interactivity API are server-side rendered, so they are
	// by design not in the critical rendering path and should be deprioritized.
	if ( $is_interactive ) {
		$args['fetchpriority'] = 'low';
		$args['in_footer']     = true;
	}

	// Blocks using the Interactivity API that support client-side navigation
	// must be marked as such in their script modules.
	if ( $is_interactive && $supports_client_navigation ) {
		wp_interactivity()->add_client_navigation_support_to_script_module( $module_id );
	}

	wp_register_script_module(
		$module_id,
		$module_uri,
		$module_dependencies,
		$module_version,
		$args
	);

	return $module_id;
}