wp_should_add_elements_class_name( array $block, array $options ): bool

Compatibility

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

Parameters

$blockarray

Block object.

$optionsarray

Per element type options e.g. whether to skip serialization.

Return value

bool

Whether the block needs an elements class name.

Performance profile

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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

7–48

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

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

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

Uses · 1

• _wp_array_get()Accesses an array in depth based on a path of keys.

Used by · 1

• wp_render_elements_support_styles()Render the elements stylesheet and adds elements class name to block as required.

Source code

View on Trac ↗View on GitHub ↗

31function wp_should_add_elements_class_name( $block, $options ) {32	if ( ! isset( $block['attrs']['style']['elements'] ) ) {33		return false;34	}35 36	$element_color_properties = array(37		'button'  => array(38			'skip'  => $options['button']['skip'] ?? false,39			'paths' => array(40				array( 'button', 'color', 'text' ),41				array( 'button', 'color', 'background' ),42				array( 'button', 'color', 'gradient' ),43			),44		),45		'link'    => array(46			'skip'  => $options['link']['skip'] ?? false,47			'paths' => array(48				array( 'link', 'color', 'text' ),49				array( 'link', ':hover', 'color', 'text' ),50			),51		),52		'heading' => array(53			'skip'  => $options['heading']['skip'] ?? false,54			'paths' => array(55				array( 'heading', 'color', 'text' ),56				array( 'heading', 'color', 'background' ),57				array( 'heading', 'color', 'gradient' ),58				array( 'h1', 'color', 'text' ),59				array( 'h1', 'color', 'background' ),60				array( 'h1', 'color', 'gradient' ),61				array( 'h2', 'color', 'text' ),62				array( 'h2', 'color', 'background' ),63				array( 'h2', 'color', 'gradient' ),64				array( 'h3', 'color', 'text' ),65				array( 'h3', 'color', 'background' ),66				array( 'h3', 'color', 'gradient' ),67				array( 'h4', 'color', 'text' ),68				array( 'h4', 'color', 'background' ),69				array( 'h4', 'color', 'gradient' ),70				array( 'h5', 'color', 'text' ),71				array( 'h5', 'color', 'background' ),72				array( 'h5', 'color', 'gradient' ),73				array( 'h6', 'color', 'text' ),74				array( 'h6', 'color', 'background' ),75				array( 'h6', 'color', 'gradient' ),76			),77		),78	);79 80	$elements_style_attributes = $block['attrs']['style']['elements'];81 82	foreach ( $element_color_properties as $element_config ) {83		if ( $element_config['skip'] ) {84			continue;85		}86 87		foreach ( $element_config['paths'] as $path ) {88			if ( null !== _wp_array_get( $elements_style_attributes, $path, null ) ) {89				return true;90			}91		}92	}93 94	return false;95}

Changelog

Introduced in 6.6.0. One change between 6.7.7 and 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/block-supports/elements.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.