wp_add_block_state_style_rule( array $css_rules, string $state, string|null $selector, array $style, string|null $rules_group = null )

Compatibility

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

Parameters

$css_rulesarray

Style rules.

$statestring

Pseudo-state selector.

$selectorstring|null

Block, feature, or element selector.

$stylearray

Style object.

$rules_groupstring|nulloptional

Optional CSS grouping rule, e.g. a media query.Default: null

Performance profile

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

8–47

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

2 places 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_add_block_state_style_rule() can have, taken from its control-flow graph on PHP 8.5.

Uses · 2

• 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_normalize_state_style_for_css_output()Normalizes a state style object before generating CSS declarations.

Used by · 2

• wp_get_block_state_style_rules()Builds compiled state style rules, preserving the selector each rule targets.
• wp_render_block_states_support()Renders per-instance state styles on the frontend.

Source code

View on Trac ↗View on GitHub ↗

361function wp_add_block_state_style_rule( &$css_rules, $state, $selector, $style, $rules_group = null ) {362	if ( empty( $style ) || ! is_array( $style ) ) {363		return;364	}365 366	$compiled     = wp_style_engine_get_styles(367		wp_normalize_state_style_for_css_output( $style )368	);369	$declarations = $compiled['declarations'] ?? array();370	$text_align   = $style['typography']['textAlign'] ?? null;371	// Base text alignment is class-based, so state styles need a declaration.372	if ( is_string( $text_align ) && '' !== trim( $text_align ) ) {373		$declarations['text-align'] = $text_align;374	}375 376	if ( empty( $declarations ) ) {377		return;378	}379 380	$css_rules[] = array(381		'state'        => $state,382		'selector'     => $selector,383		'declarations' => $declarations,384	);385	if ( ! empty( $rules_group ) ) {386		$css_rules[ count( $css_rules ) - 1 ]['rules_group'] = $rules_group;387	}388}

Changelog

Introduced in 7.1.0.

Signature, return type and hooks compared across 1 parsed release.

About this page

Parsed data

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