wp_tinycolor_hsl_to_rgb( array $hsl_color ): array
- Since
- 5.8.0
- Source
wp-includes/deprecated.php:4958
Description
Direct port of TinyColor's function, lightly simplified to maintain consistency with TinyColor.
Compatibility
Deprecated in WordPress 6.3.0. Kept for back-compatibility; avoid it in new code.
- WordPress
- since 5.8.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$hsl_colorarray- HSL object.
Return value
array- Rounded and converted RGB object.
Performance profile
How much work a call to wp_tinycolor_hsl_to_rgb() 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
- Scaling
- Constant
- Instructions
- 39–63
- Plugin surface
- None
- Called by
- 1
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 70.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
do_action()one call below wp_tinycolor_hsl_to_rgb()
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 · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_tinycolor_hsl_to_rgb() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$s === 0 | 39 | _deprecated_function(), wp_tinycolor_bound01(), wp_tinycolor_bound01(), wp_tinycolor_bound01() |
$s !== 0 | 63 | _deprecated_function(), wp_tinycolor_bound01(), wp_tinycolor_bound01(), wp_tinycolor_bound01(), wp_tinycolor_hue_to_rgb(), wp_tinycolor_hue_to_rgb(), wp_tinycolor_hue_to_rgb() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 70 | 39–63 | 2 | |
| 8.5 | 70 | 39–63 | 2 | |
| 8.4 | 70 | 39–63 | 2 | |
| 8.3 | 70 | 39–63 | 2 | |
| 8.2 | 70 | 39–63 | 2 | |
| 8.1 | 70 | 39–63 | 2 | 2 fewer instructions than PHP 7.4 |
| 7.4 | 72 | 39–64 | 2 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 3
- _deprecated_function()Marks a function as deprecated and inform when it has been used.
- wp_tinycolor_bound01()Takes input from [0, n] and returns it as [0, 1].
- wp_tinycolor_hue_to_rgb()Helper function for hsl to rgb conversion.
Used by · 1
- wp_tinycolor_string_to_rgb()Parses hex, hsl, and rgb CSS strings using the same regex as TinyColor v1.4.2 used in the JavaScript. Only colors output from react-color are implemented.
Source code
function wp_tinycolor_hsl_to_rgb( $hsl_color ) { _deprecated_function( __FUNCTION__, '6.3.0' ); $h = wp_tinycolor_bound01( $hsl_color['h'], 360 ); $s = wp_tinycolor_bound01( $hsl_color['s'], 100 ); $l = wp_tinycolor_bound01( $hsl_color['l'], 100 ); if ( 0 === $s ) { // Achromatic. $r = $l; $g = $l; $b = $l; } else { $q = $l < 0.5 ? $l * ( 1 + $s ) : $l + $s - $l * $s; $p = 2 * $l - $q; $r = wp_tinycolor_hue_to_rgb( $p, $q, $h + 1 / 3 ); $g = wp_tinycolor_hue_to_rgb( $p, $q, $h ); $b = wp_tinycolor_hue_to_rgb( $p, $q, $h - 1 / 3 ); } return array( 'r' => $r * 255, 'g' => $g * 255, 'b' => $b * 255, );}Changelog
Introduced in 5.8.0. Unchanged from 6.7.7 through 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/deprecated.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.