wp_get_computed_fluid_typography_value( array $args = array() ): string|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

$argsarrayoptional

An associative array of values to calculate a fluid formula for font size. Default is empty array.Default: array()

• $maximum_viewport_widthstring

  Maximum size up to which type will have fluidity.

• $minimum_viewport_widthstring

  Minimum viewport size from which type will have fluidity.

• $maximum_font_sizestring

  Maximum font size for any clamp() calculation.

• $minimum_font_sizestring

  Minimum font size for any clamp() calculation.

• $scale_factorint

  A scale factor to determine how fast a font scales within boundaries.

Return value

string|null

A font-size value using clamp() on success, otherwise null.

Performance profile

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

31–98

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

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

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

Uses · 1

• wp_get_typography_value_and_unit()Checks a string for a unit and value and returns an array consisting of `'value'` and `'unit'`, e.g. array( '42', 'rem' ).

Used by · 1

• 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 ↗

464function wp_get_computed_fluid_typography_value( $args = array() ) {465	$maximum_viewport_width_raw = $args['maximum_viewport_width'] ?? null;466	$minimum_viewport_width_raw = $args['minimum_viewport_width'] ?? null;467	$maximum_font_size_raw      = $args['maximum_font_size'] ?? null;468	$minimum_font_size_raw      = $args['minimum_font_size'] ?? null;469	$scale_factor               = $args['scale_factor'] ?? null;470 471	// Normalizes the minimum font size in order to use the value for calculations.472	$minimum_font_size = wp_get_typography_value_and_unit( $minimum_font_size_raw );473 474	/*475	 * We get a 'preferred' unit to keep units consistent when calculating,476	 * otherwise the result will not be accurate.477	 */478	$font_size_unit = $minimum_font_size['unit'] ?? 'rem';479 480	// Normalizes the maximum font size in order to use the value for calculations.481	$maximum_font_size = wp_get_typography_value_and_unit(482		$maximum_font_size_raw,483		array(484			'coerce_to' => $font_size_unit,485		)486	);487 488	// Checks for mandatory min and max sizes, and protects against unsupported units.489	if ( ! $maximum_font_size || ! $minimum_font_size ) {490		return null;491	}492 493	// Uses rem for accessible fluid target font scaling.494	$minimum_font_size_rem = wp_get_typography_value_and_unit(495		$minimum_font_size_raw,496		array(497			'coerce_to' => 'rem',498		)499	);500 501	// Viewport widths defined for fluid typography. Normalize units.502	$maximum_viewport_width = wp_get_typography_value_and_unit(503		$maximum_viewport_width_raw,504		array(505			'coerce_to' => $font_size_unit,506		)507	);508	$minimum_viewport_width = wp_get_typography_value_and_unit(509		$minimum_viewport_width_raw,510		array(511			'coerce_to' => $font_size_unit,512		)513	);514 515	// Protects against unsupported units in min and max viewport widths.516	if ( ! $minimum_viewport_width || ! $maximum_viewport_width ) {517		return null;518	}519 520	// Calculates the linear factor denominator. If it's 0, we cannot calculate a fluid value.521	$linear_factor_denominator = $maximum_viewport_width['value'] - $minimum_viewport_width['value'];522	if ( empty( $linear_factor_denominator ) ) {523		return null;524	}525 526	/*527	 * Build CSS rule.528	 * Borrowed from https://websemantics.uk/tools/responsive-font-calculator/.529	 */530	$view_port_width_offset = round( $minimum_viewport_width['value'] / 100, 3 ) . $font_size_unit;531	$linear_factor          = 100 * ( ( $maximum_font_size['value'] - $minimum_font_size['value'] ) / ( $linear_factor_denominator ) );532	$linear_factor_scaled   = round( $linear_factor * $scale_factor, 3 );533	$linear_factor_scaled   = empty( $linear_factor_scaled ) ? 1 : $linear_factor_scaled;534	$fluid_target_font_size = implode( '', $minimum_font_size_rem ) . " + ((1vw - $view_port_width_offset) * $linear_factor_scaled)";535 536	return "clamp($minimum_font_size_raw, $fluid_target_font_size, $maximum_font_size_raw)";537}

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.