W3cubDocs

sanitize_hex_color( string $color )

Sanitizes a hex color.

Description

Returns either ”, a 3 or 6 digit hex color (with #), or nothing. For sanitizing values without a #, see sanitize_hex_color_no_hash().

Parameters

$color: (string) (Required)

Return

(string|void)

Source

File: wp-includes/formatting.php

function sanitize_hex_color( $color ) {
	if ( '' === $color ) {
		return '';
	}

	// 3 or 6 hex digits, or the empty string.
	if ( preg_match( '|^#([A-Fa-f0-9]{3}){1,2}$|', $color ) ) {
		return $color;
	}
}

Used By

Used By	Description
wp-includes/rest-api.php: rest_sanitize_value_from_schema()	Sanitize a value based on a schema.
wp-includes/formatting.php: sanitize_hex_color_no_hash()	Sanitizes a hex color without a hash. Use sanitize_hex_color() when possible.

Changelog

Version	Description
3.4.0	Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/sanitize_hex_color