WP_Theme_JSON::compute_style_properties( array $styles, array $settings = array(), array $properties = null, array $theme_json = null, string $selector = null, boolean $use_root_padding = null ): 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

$stylesarray

Styles to process.

$settingsarrayoptional

Theme settings.Default: array()

$propertiesarrayoptional

Properties metadata.Default: null

$theme_jsonarrayoptional

Theme JSON array.Default: null

$selectorstringoptional

The style block selector.Default: null

$use_root_paddingbooleanoptional

Whether to add custom properties at root level.Default: null

Return value

array

Returns the modified $declarations.

Performance profile

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

9–20

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

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 · 1 distinct outcome

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

Uses · 4

• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• 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_typography_font_size_value()Returns a font-size value based on a given font-size preset.
• static::get_property_value()

Source code

View on Trac ↗View on GitHub ↗

2395	protected static function compute_style_properties( $styles, $settings = array(), $properties = null, $theme_json = null, $selector = null, $use_root_padding = null ) {2396		if ( empty( $styles ) ) {2397			return array();2398		}2399 2400		if ( null === $properties ) {2401			$properties = static::PROPERTIES_METADATA;2402		}2403		$declarations             = array();2404		$root_variable_duplicates = array();2405		$root_style_length        = strlen( '--wp--style--root--' );2406 2407		foreach ( $properties as $css_property => $value_path ) {2408			if ( ! is_array( $value_path ) ) {2409				continue;2410			}2411 2412			$is_root_style = str_starts_with( $css_property, '--wp--style--root--' );2413			if ( $is_root_style && ( static::ROOT_BLOCK_SELECTOR !== $selector || ! $use_root_padding ) ) {2414				continue;2415			}2416 2417			$value = static::get_property_value( $styles, $value_path, $theme_json );2418 2419			/*2420			 * Root-level padding styles don't currently support strings with CSS shorthand values.2421			 * This may change: https://github.com/WordPress/gutenberg/issues/40132.2422			 */2423			if ( '--wp--style--root--padding' === $css_property && is_string( $value ) ) {2424				continue;2425			}2426 2427			if ( $is_root_style && $use_root_padding ) {2428				$root_variable_duplicates[] = substr( $css_property, $root_style_length );2429			}2430 2431			/*2432			 * Processes background image styles.2433			 * If the value is a URL, it will be converted to a CSS `url()` value.2434			 * For uploaded image (images with a database ID), apply size and position defaults,2435			 * equal to those applied in block supports in lib/background.php.2436			 */2437			if ( 'background-image' === $css_property && ! empty( $value ) ) {2438				$background_styles = wp_style_engine_get_styles(2439					array( 'background' => array( 'backgroundImage' => $value ) )2440				);2441				$value             = $background_styles['declarations'][ $css_property ];2442			}2443			if ( empty( $value ) && static::ROOT_BLOCK_SELECTOR !== $selector && ! empty( $styles['background']['backgroundImage']['id'] ) ) {2444				if ( 'background-size' === $css_property ) {2445					$value = 'cover';2446				}2447				// If the background size is set to `contain` and no position is set, set the position to `center`.2448				if ( 'background-position' === $css_property ) {2449					$background_size = $styles['background']['backgroundSize'] ?? null;2450					$value           = 'contain' === $background_size ? '50% 50%' : null;2451				}2452			}2453 2454			// Skip if empty and not "0" or value represents array of longhand values.2455			$has_missing_value = empty( $value ) && ! is_numeric( $value );2456			if ( $has_missing_value || is_array( $value ) ) {2457				continue;2458			}2459 2460			// Calculates fluid typography rules where available.2461			if ( 'font-size' === $css_property ) {2462				/*2463				 * wp_get_typography_font_size_value() will check2464				 * if fluid typography has been activated and also2465				 * whether the incoming value can be converted to a fluid value.2466				 * Values that already have a clamp() function will not pass the test,2467				 * and therefore the original $value will be returned.2468				 * Pass the current theme_json settings to override any global settings.2469				 */2470				$value = wp_get_typography_font_size_value( array( 'size' => $value ), $settings );2471			}2472 2473			if ( 'aspect-ratio' === $css_property ) {2474				// For aspect ratio to work, other dimensions rules must be unset.

Changelog

Introduced in 5.8.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.0.4 tag, from src/wp-includes/class-wp-theme-json.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.