wp_get_typography_value_and_unit( string|int|float $raw_value, array $options = array() ): array|null

Compatibility

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

Parameters

$raw_valuestring|int|float

Raw size value from theme.json.

$optionsarrayoptional

An associative array of options. Default is empty array.Default: array()

• $coerce_tostringdefault: 'rem'

  Coerce the value to rem or px.

• $root_size_valueintdefault: 16

  Value of root font size for rem|em <-> px conversion.

• $acceptable_unitsstring[]default: array( 'rem', 'px', 'em' );

  An array of font size units.

Return value

array|null

An array consisting of 'value' and 'unit' properties on success.
null on failure.

Performance profile

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

7–75

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

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 it touches

• hookthird-party callbacksdo_action()one call below wp_get_typography_value_and_unit()

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 4 distinct outcomes

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

Uses · 3

• _doing_it_wrong()Marks something as being incorrectly called.
• __()Retrieves the translation of $text.
• wp_parse_args()Merges user defined arguments into defaults array.

Used by · 2

• wp_get_computed_fluid_typography_value()Internal implementation of CSS clamp() based on available min/max viewport width and min/max font sizes.
• wp_get_typography_font_size_value()Returns a font-size value based on a given font-size preset.

Source code

View on Trac ↗View on GitHub ↗

368function wp_get_typography_value_and_unit( $raw_value, $options = array() ): ?array {369	if ( ! is_string( $raw_value ) && ! is_int( $raw_value ) && ! is_float( $raw_value ) ) {370		_doing_it_wrong(371			__FUNCTION__,372			__( 'Raw size value must be a string, integer, or float.' ),373			'6.1.0'374		);375		return null;376	}377 378	if ( empty( $raw_value ) ) {379		return null;380	}381 382	// Converts numbers to pixel values by default.383	if ( is_numeric( $raw_value ) ) {384		$raw_value = $raw_value . 'px';385	}386 387	$defaults = array(388		'coerce_to'        => '',389		'root_size_value'  => 16,390		'acceptable_units' => array( 'rem', 'px', 'em' ),391	);392 393	/**394	 * @var array{395	 *     coerce_to: string,396	 *     root_size_value: positive-int,397	 *     acceptable_units: non-empty-array<non-empty-string>,398	 * } $options399	 */400	$options = wp_parse_args( $options, $defaults );401 402	// Bails out if the raw value can't be parsed.403	if ( ! preg_match( '/^(\d*\.?\d+)([a-zA-Z]+|%)$/', $raw_value, $matches ) ) {404		return null;405	}406 407	$value = (float) $matches[1];408	$unit  = $matches[2];409 410	if ( ! in_array( $unit, $options['acceptable_units'], true ) ) {411		return null;412	}413 414	/*415	 * Default browser font size. Later, possibly could inject some JS to416	 * compute this `getComputedStyle( document.querySelector( "html" ) ).fontSize`.417	 */418	if ( 'px' === $options['coerce_to'] && ( 'em' === $unit || 'rem' === $unit ) ) {419		$value = $value * $options['root_size_value'];420		$unit  = $options['coerce_to'];421	}422 423	if ( 'px' === $unit && ( 'em' === $options['coerce_to'] || 'rem' === $options['coerce_to'] ) ) {424		$value = $value / $options['root_size_value'];425		$unit  = $options['coerce_to'];426	}427 428	/*429	 * No calculation is required if swapping between em and rem yet,430	 * since we assume a root size value. Later we might like to differentiate between431	 * :root font size (rem) and parent element font size (em) relativity.432	 */433	if ( ( 'em' === $options['coerce_to'] || 'rem' === $options['coerce_to'] ) && ( 'em' === $unit || 'rem' === $unit ) ) {434		$unit = $options['coerce_to'];435	}436 437	return array(438		'value' => round( $value, 3 ),439		'unit'  => $unit,440	);441}

Changelog

Introduced in 6.1.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/typography.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.