wp_tinycolor_bound01()
Deprecated from version 6.3.0. It is no longer supported and can be removed in future releases. It is recommended to replace this function with the same one.
Takes input from [0, n] and returns it as [0, 1].
Direct port of TinyColor's function, lightly simplified to maintain consistency with TinyColor.
Internal function — this function is designed to be used by the kernel itself. It is not recommended to use this function in your code.
No Hooks.
Return
float
. Value in the range [0, 1].
Usage
wp_tinycolor_bound01( $n, $max );
- $n(mixed) (required)
- Number of unknown type.
- $max(int) (required)
- Upper value of the range to bound to.
Changelog
Since 5.8.0 | Introduced. |
Deprecated since | 6.3.0 |
wp_tinycolor_bound01() wp tinycolor bound01 code WP 6.5.2
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; }