wp_get_state_declarations_with_background_resets( array $declarations ): array
- Since
- 7.1.0
- Source
wp-includes/block-supports/states.php:114
Description
When a state sets a solid background-color, any gradient applied to the default state (via background shorthand or background-image) must be explicitly cleared. Without this, the gradient image layer remains visible on top of the solid hover color even when !important is used, because background-color and background-image are separate CSS properties.
Compatibility
- WordPress
- since 7.1.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in 1 of the 5 tracked releases, added in 7.1.0, and compiles on PHP 7.4 through 8.6-dev.
Parameters
$declarationsarray- CSS declarations generated by the style engine.
Return value
array- CSS declarations with background resets applied where needed.
Performance profile
How much work a call to wp_get_state_declarations_with_background_resets() 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
- Scaling
- Constant
- Instructions
- 4–24
- Plugin surface
- None
- Called by
- 1
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 25.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_get_state_declarations_with_background_resets() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 4–24 | none |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 25 instructions, 4–24 executed per call, 7 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Used by · 1
- wp_render_block_states_support()Renders per-instance state styles on the frontend.
Source code
function wp_get_state_declarations_with_background_resets( $declarations ) { if ( ! is_array( $declarations ) ) { return $declarations; } $has_background_color = isset( $declarations['background-color'] ) && '' !== $declarations['background-color']; $has_background = isset( $declarations['background'] ) && '' !== $declarations['background']; $has_background_image = isset( $declarations['background-image'] ) && '' !== $declarations['background-image']; /* * When the state sets a solid background-color but no gradient of its own, * emit `background-image: unset` to clear any gradient (whether stored as * the `background` shorthand or as `background-image`) that was applied to * the default / normal state via an inline style attribute. The declaration * is marked important when the state rule is registered with the style engine. */ if ( $has_background_color && ! $has_background && ! $has_background_image ) { $declarations['background-image'] = 'unset'; } return $declarations;}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.