sanitize_hex_color_no_hash( string $color ): string|null

Sanitizes a hex color without a hash. Use sanitize_hex_color() when possible.

Description

Saving hex colors without a hash puts the burden of adding the hash on the UI, which makes it difficult to use or upgrade to other color types such as rgba, hsl, rgb, and HTML color names.

Returns either '', a 3 or 6 digit hex color (without a #), or null.

Parameters

$colorstringrequired: The color value to sanitize. Can be with or without a #.

Return

string|null The sanitized hex color without the hash prefix, empty string if input is empty, or null if invalid.

Source

function sanitize_hex_color_no_hash( $color ) {
	$color = ltrim( $color, '#' );

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

	return sanitize_hex_color( '#' . $color ) ? $color : null;
}

View all references View on Trac View on GitHub

Uses	Description
sanitize_hex_color()`wp-includes/formatting.php`	Sanitizes a hex color.

Used by	Description
WP_Customize_Manager::_sanitize_header_textcolor()`wp-includes/class-wp-customize-manager.php`	Callback for validating the header_textcolor value.
maybe_hash_hex_color()`wp-includes/formatting.php`	Ensures that any hex color is properly hashed.

Changelog

Version	Description
3.4.0	Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.