WP_Style_Engine_CSS_Declarations
Holds, sanitizes, processes, and prints CSS declarations for the style engine.
Source: wp-includes/style-engine/class-wp-style-engine-css-declarations.php
Since: 6.1.0
Properties
| Property | Type | Visibility | Description |
|---|---|---|---|
$declarations | array | protected | CSS declarations as property => value pairs |
Methods
__construct()
Creates a new declarations collection.
public function __construct( array $declarations = array() )Parameters
| Parameter | Type | Description |
|---|---|---|
$declarations | array | Initial CSS definitions (property => value pairs) |
Example
$declarations = new WP_Style_Engine_CSS_Declarations( array(
'color' => '#fff',
'background-color' => '#000',
) );add_declaration()
Adds a single CSS declaration.
public function add_declaration( string $property, string $value ): WP_Style_Engine_CSS_DeclarationsParameters
| Parameter | Type | Description |
|---|---|---|
$property | string | CSS property (sanitized via sanitize_key()) |
$value | string | CSS value (trimmed; empty values ignored) |
Returns
$this for method chaining.
Example
$declarations
->add_declaration( 'color', 'red' )
->add_declaration( 'font-size', '16px' );remove_declaration()
Removes a single declaration.
public function remove_declaration( string $property ): WP_Style_Engine_CSS_DeclarationsParameters
| Parameter | Type | Description |
|---|---|---|
$property | string | CSS property to remove |
Returns
$this for method chaining.
add_declarations()
Adds multiple declarations.
public function add_declarations( array $declarations ): WP_Style_Engine_CSS_DeclarationsParameters
| Parameter | Type | Description |
|---|---|---|
$declarations | array | CSS definitions (property => value pairs) |
Returns
$this for method chaining.
remove_declarations()
Removes multiple declarations.
public function remove_declarations( array $properties = array() ): WP_Style_Engine_CSS_DeclarationsParameters
| Parameter | Type | Description |
|---|---|---|
$properties | array | Array of property names to remove |
Returns
$this for method chaining.
get_declarations()
Gets the declarations array.
public function get_declarations(): arrayReturns
Associative array of CSS property => value pairs.
get_declarations_string()
Filters and compiles the CSS declarations into a string.
public function get_declarations_string( bool $should_prettify = false, int $indent_count = 0 ): stringParameters
| Parameter | Type | Default | Description |
|---|---|---|---|
$should_prettify | bool | false | Add spacing, newlines, and indents |
$indent_count | int | 0 | Number of tab indents (applies if prettify is true) |
Returns
Compiled CSS declarations string.
Example
$declarations = new WP_Style_Engine_CSS_Declarations( array(
'color' => 'red',
'font-size' => '16px',
) );
echo $declarations->get_declarations_string();
// Output: 'color:red;font-size:16px;'
echo $declarations->get_declarations_string( true, 1 );
// Output (prettified with 1 indent):
// color: red;
// font-size: 16px;Protected Methods
filter_declaration()
Filters a CSS property + value pair for safety.
protected static function filter_declaration(
string $property,
string $value,
string $spacer = ''
): stringParameters
| Parameter | Type | Description |
|---|---|---|
$property | string | CSS property |
$value | string | CSS value |
$spacer | string | Spacer between colon and value (for prettify) |
Returns
Filtered declaration string, or empty string if invalid.
Uses wp_strip_all_tags() and safecss_filter_attr() for sanitization.
sanitize_property()
Sanitizes property names.
protected function sanitize_property( string $property ): stringParameters
| Parameter | Type | Description |
|---|---|---|
$property | string | CSS property |
Returns
Sanitized property name via sanitize_key().