函数文档

wp_tinycolor_rgb_to_rgb()

💡 云策文档标注

概述

wp_tinycolor_rgb_to_rgb() 是一个 WordPress 函数,用于对 RGB 颜色对象的值进行舍入和转换。该函数是 TinyColor 库函数的直接移植版本,但已从 WordPress 6.3.0 版本起被弃用。

关键要点

  • 函数作用:接收一个 RGB 颜色数组作为参数,通过 wp_tinycolor_bound01() 将每个颜色分量从 [0, 255] 范围转换为 [0, 1] 范围,然后乘以 255 进行舍入和转换,返回处理后的 RGB 对象。
  • 弃用状态:自 WordPress 6.3.0 版本起被弃用,使用时会触发 _deprecated_function() 警告。
  • 相关函数:依赖于 wp_tinycolor_bound01() 进行数值范围转换,并被 wp_tinycolor_string_to_rgb() 用于解析 CSS 颜色字符串。

代码示例

function wp_tinycolor_rgb_to_rgb( $rgb_color ) {
    _deprecated_function( __FUNCTION__, '6.3.0' );

    return array(
        'r' => wp_tinycolor_bound01( $rgb_color['r'], 255 ) * 255,
        'g' => wp_tinycolor_bound01( $rgb_color['g'], 255 ) * 255,
        'b' => wp_tinycolor_bound01( $rgb_color['b'], 255 ) * 255,
    );
}

注意事项

  • 该函数已弃用,建议开发者避免在新代码中使用,并考虑替代方案。
  • 函数内部调用 _deprecated_function(),使用时会在调试模式下输出弃用警告。
  • 输入参数 $rgb_color 必须是一个包含 'r'、'g'、'b' 键的数组,否则可能导致错误。

📄 原文内容

Rounds and converts values of an RGB object.

Description

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

Parameters

$rgb_colorarrayrequired
RGB object.

Return

array Rounded and converted RGB object.

Source

function wp_tinycolor_rgb_to_rgb( $rgb_color ) {
	_deprecated_function( __FUNCTION__, '6.3.0' );

	return array(
		'r' => wp_tinycolor_bound01( $rgb_color['r'], 255 ) * 255,
		'g' => wp_tinycolor_bound01( $rgb_color['g'], 255 ) * 255,
		'b' => wp_tinycolor_bound01( $rgb_color['b'], 255 ) * 255,
	);
}

Changelog

Version Description
6.3.0 Deprecated.
5.8.0 Introduced.