WP_Style_Engine_CSS_Declarations::filter_declaration( string $property, string $value, string $spacer = ”, array $options = array() ): string

Filters a CSS property + value pair.

Parameters

$propertystringrequired

The CSS property.

$valuestringrequired

The value to be filtered.

$spacerstringoptional

The spacer between the colon and the value.

Default:''

$optionsarrayoptional

An array of options.

important bool
Whether to output the declaration with !important. Default false.

Default:array()

Return

string The filtered declaration or an empty string.

Source

protected static function filter_declaration( $property, $value, $spacer = '', $options = array() ) {
	$filtered_value = wp_strip_all_tags( $value, true );
	if ( '' !== $filtered_value ) {
		$options = wp_parse_args(
			$options,
			array(
				'important' => false,
			)
		);

		$filtered_declaration = safecss_filter_attr( "{$property}:{$spacer}{$filtered_value}" );

		// Only append !important in the presence of an option value and when sanitization returns a single declaration.
		if ( true === $options['important'] && '' !== $filtered_declaration && ! str_contains( $filtered_declaration, ';' ) ) {
			return "$filtered_declaration !important";
		}

		return $filtered_declaration;
	}
	return '';
}

View all references View on Trac View on GitHub

Uses	Description
wp_strip_all_tags()`wp-includes/formatting.php`	Properly strips all HTML tags including ‘script’ and ‘style’.
safecss_filter_attr()`wp-includes/kses.php`	Filters an inline style attribute and removes disallowed rules.
wp_parse_args()`wp-includes/functions.php`	Merges user defined arguments into defaults array.

Show 1 more Show less

Changelog

Version	Description
7.1.0	Added the `$options` parameter.
6.1.0	Introduced.

User Contributed Notes

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