sanitize_hex_color( string $color ): string|void

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

$colorstringrequired

Return

string|void

Source

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;
	}
}

View all references View on Trac View on GitHub

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

Changelog

Version	Description
3.4.0	Introduced.

User Contributed Notes

Skip to note 3 content

Rinku Y 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
It is usually most important to set the default value of the setting as well as its sanitization callback, which will ensure that no unsafe data is stored in the database.
```
$wp_customize-&gt;add_setting( 'accent_color', array(
  'default' =&gt; '#f72525',
  'sanitize_callback' =&gt; 'sanitize_hex_color',
) );
```
Log in to add feedback
Skip to note 4 content

Andreas Brain 8 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

As of WordPress 4.6 this function is globally available, see https://core.trac.wordpress.org/ticket/27583

Log in to add feedback

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