render_block_core_icon( array $attributes ): string

Compatibility

Present in 2 of the 5 tracked releases, added in 7.0.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$attributesarray

The block attributes.

Return value

string

Returns the Icon.

Performance profile

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

93–166

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

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

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 4

• wp_style_engine_get_styles()Global public interface method to generate styles from a single style object, e.g. the value of a block's attributes.style object or the top level styles in theme.json.
• wp_get_icon()Returns the SVG markup for a registered icon.
• get_block_wrapper_attributes()Generates a string of attributes by applying to the current block being rendered all of the features that the block supports.
• WP_HTML_Tag_Processor::__construct()Constructor.

Source code

View on Trac ↗View on GitHub ↗

17function render_block_core_icon( $attributes ) {18	if ( empty( $attributes['icon'] ) ) {19		return;20	}21 22	// Text color and background color.23	$color_styles = array();24 25	$preset_text_color    = array_key_exists( 'textColor', $attributes ) ? "var:preset|color|{$attributes['textColor']}" : null;26	$custom_text_color    = $attributes['style']['color']['text'] ?? null;27	$color_styles['text'] = $preset_text_color ? $preset_text_color : $custom_text_color;28 29	$preset_background_color    = array_key_exists( 'backgroundColor', $attributes ) ? "var:preset|color|{$attributes['backgroundColor']}" : null;30	$custom_background_color    = $attributes['style']['color']['background'] ?? null;31	$color_styles['background'] = $preset_background_color ? $preset_background_color : $custom_background_color;32 33	// Border.34	$border_styles = array();35	$sides         = array( 'top', 'right', 'bottom', 'left' );36 37	if ( isset( $attributes['style']['border']['radius'] ) ) {38		$border_styles['radius'] = $attributes['style']['border']['radius'];39	}40	if ( isset( $attributes['style']['border']['style'] ) ) {41		$border_styles['style'] = $attributes['style']['border']['style'];42	}43	if ( isset( $attributes['style']['border']['width'] ) ) {44		$border_styles['width'] = $attributes['style']['border']['width'];45	}46 47	$preset_color           = array_key_exists( 'borderColor', $attributes ) ? "var:preset|color|{$attributes['borderColor']}" : null;48	$custom_color           = $attributes['style']['border']['color'] ?? null;49	$border_styles['color'] = $preset_color ? $preset_color : $custom_color;50 51	foreach ( $sides as $side ) {52		$border                 = $attributes['style']['border'][ $side ] ?? null;53		$border_styles[ $side ] = array(54			'color' => $border['color'] ?? null,55			'style' => $border['style'] ?? null,56			'width' => $border['width'] ?? null,57		);58	}59 60	// Spacing (Padding).61	$spacing_styles = array();62	if ( isset( $attributes['style']['spacing']['padding'] ) ) {63		$spacing_styles['padding'] = $attributes['style']['spacing']['padding'];64	}65 66	// Dimensions (Width).67	$dimensions_styles = array();68	if ( isset( $attributes['style']['dimensions']['width'] ) ) {69		$dimensions_styles['width'] = $attributes['style']['dimensions']['width'];70	}71 72	// Generate styles and classes.73	$styles = wp_style_engine_get_styles(74		array(75			'color'      => $color_styles,76			'border'     => $border_styles,77			'spacing'    => $spacing_styles,78			'dimensions' => $dimensions_styles,79		),80	);81 82	$svg = wp_get_icon(83		$attributes['icon'],84		array(85			// Width is applied via the dimensions block support styles below.86			'size'  => null,87			'class' => $styles['classnames'] ?? '',88			'label' => $attributes['ariaLabel'] ?? '',89		)90	);91 92	if ( '' === $svg ) {93		return;94	}95 96	$processor = new WP_HTML_Tag_Processor( $svg );

Changelog

Introduced in 7.0.0. Unchanged from 7.0.4 through 7.1.0.

1. 7.0.4
2. 7.1.0

Signature, return type and hooks compared across 2 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/blocks/icon.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.