wp_apply_colors_support( WP_Block_Type $block_type, array $block_attributes ): array

Description

Compatibility

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

Parameters

$block_typeWP_Block_Type

Block type.

$block_attributesarray

Block attributes.

Return value

array

Colors CSS classes and inline styles.

Performance profile

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

43–117

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

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

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_apply_colors_support() 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 · 3

• wp_should_skip_block_supports_serialization()Checks whether serialization of the current block's supported properties should occur.
• block_has_support()Checks whether the current block type supports the feature requested.
• 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.

Used by · 1

• render_block_core_navigation_submenu()Renders the `core/navigation-submenu` block.

Source code

View on Trac ↗View on GitHub ↗

84function wp_apply_colors_support( $block_type, $block_attributes ) {85	$color_support = $block_type->supports['color'] ?? false;86 87	if (88		is_array( $color_support ) &&89		wp_should_skip_block_supports_serialization( $block_type, 'color' )90	) {91		return array();92	}93 94	$has_text_colors_support       = true === $color_support ||95		( isset( $color_support['text'] ) && $color_support['text'] ) ||96		( is_array( $color_support ) && ! isset( $color_support['text'] ) );97	$has_background_colors_support = true === $color_support ||98		( isset( $color_support['background'] ) && $color_support['background'] ) ||99		( is_array( $color_support ) && ! isset( $color_support['background'] ) );100	$has_gradients_support         = $color_support['gradients'] ?? false;101	$color_block_styles            = array();102 103	// Text colors.104	if ( $has_text_colors_support && ! wp_should_skip_block_supports_serialization( $block_type, 'color', 'text' ) ) {105		$preset_text_color          = array_key_exists( 'textColor', $block_attributes ) ? "var:preset|color|{$block_attributes['textColor']}" : null;106		$custom_text_color          = $block_attributes['style']['color']['text'] ?? null;107		$color_block_styles['text'] = $preset_text_color ? $preset_text_color : $custom_text_color;108	}109 110	// Background colors.111	if ( $has_background_colors_support && ! wp_should_skip_block_supports_serialization( $block_type, 'color', 'background' ) ) {112		$preset_background_color          = array_key_exists( 'backgroundColor', $block_attributes ) ? "var:preset|color|{$block_attributes['backgroundColor']}" : null;113		$custom_background_color          = $block_attributes['style']['color']['background'] ?? null;114		$color_block_styles['background'] = $preset_background_color ? $preset_background_color : $custom_background_color;115	}116 117	// Gradients.118	// Suppress color.gradient CSS when background.gradient is supported and119	// explicitly set. background.php owns CSS generation in that case, and120	// emitting the background shorthand here would conflict with it.121	$has_background_gradient_support = block_has_support( $block_type, array( 'background', 'gradient' ), false );122	$has_background_gradient_value   = ! empty( $block_attributes['style']['background']['gradient'] );123 124	if (125		$has_gradients_support &&126		! wp_should_skip_block_supports_serialization( $block_type, 'color', 'gradients' ) &&127		! ( $has_background_gradient_support && $has_background_gradient_value )128	) {129		$preset_gradient_color          = array_key_exists( 'gradient', $block_attributes ) ? "var:preset|gradient|{$block_attributes['gradient']}" : null;130		$custom_gradient_color          = $block_attributes['style']['color']['gradient'] ?? null;131		$color_block_styles['gradient'] = $preset_gradient_color ? $preset_gradient_color : $custom_gradient_color;132	}133 134	$attributes = array();135	$styles     = wp_style_engine_get_styles( array( 'color' => $color_block_styles ), array( 'convert_vars_to_classnames' => true ) );136 137	if ( ! empty( $styles['classnames'] ) ) {138		$attributes['class'] = $styles['classnames'];139	}140 141	if ( ! empty( $styles['css'] ) ) {142		$attributes['style'] = $styles['css'];143	}144 145	return $attributes;146}

Changelog

Introduced in 5.6.0. Unchanged from 6.7.7 through 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/colors.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.