wpseek.com
A WordPress-centric search engine for devs and theme authors



wp_tinycolor_bound01 › WordPress Function

Since5.8.0
Deprecated6.3.0
› wp_tinycolor_bound01 ( $n, $max )
Access:
  • private
Parameters: (2)
  • (mixed) $n Number of unknown type.
    Required: Yes
  • (int) $max Upper value of the range to bound to.
    Required: Yes
Links:
Returns:
  • (float) Value in the range [0, 1].
Defined at:
Codex:

Takes input from [0, n] and returns it as [0, 1].

Direct port of TinyColor's function, lightly simplified to maintain consistency with TinyColor.


Related Functions: _wp_tinycolor_bound_alpha, wp_tinycolor_rgb_to_rgb, wp_tinycolor_hsl_to_rgb, wp_tinycolor_hue_to_rgb, wp_tinycolor_string_to_rgb

Source 

function wp_tinycolor_bound01( $n, $max ) {
	_deprecated_function( __FUNCTION__, '6.3.0' );
	if ( 'string' === gettype( $n ) && str_contains( $n, '.' ) && 1 === (float) $n ) {
		$n = '100%';
	}

	$n = min( $max, max( 0, (float) $n ) );

	// Automatically convert percentage into number.
	if ( 'string' === gettype( $n ) && str_contains( $n, '%' ) ) {
		$n = (int) ( $n * $max ) / 100;
	}

	// Handle floating point rounding errors.
	if ( ( abs( $n - $max ) < 0.000001 ) ) {
		return 1.0;
	}

	// Convert into [0, 1] range if it isn't already.
	return ( $n % $max ) / (float) $max;
}