WP_Style_Engine_CSS_Declarations::add_declaration( string $property, string $value, array $options = array() ): WP_Style_Engine_CSS_Declarations
- Since
- 6.1.0, 7.1.0
- Source
wp-includes/style-engine/class-wp-style-engine-css-declarations.php:69
Compatibility
- WordPress
- since 7.1.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$propertystring- The CSS property.
$valuestring- The CSS value.
$optionsarrayoptional- An array of options. Default empty array.Default:
array()$importantbooldefault: falseWhether to output the declaration with !important.
Return value
WP_Style_Engine_CSS_Declarations- Returns the object to allow chaining methods.
Performance profile
How much work a call to WP_Style_Engine_CSS_Declarations::add_declaration() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 11–34
- Plugin surface
- None
- Called by
- 1
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 42.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What one call costs · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Style_Engine_CSS_Declarations::add_declaration() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 11–17 | ->sanitize_property() |
!empty($property) && is_string($value) && $value !== "" | 32–34 | ->sanitize_property(), wp_parse_args(), array_filter() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 42 | 11–34 | 4 | |
| 8.5 | 42 | 11–34 | 4 | |
| 8.4 | 42 | 11–34 | 4 | 2 fewer instructions than PHP 8.3 |
| 8.3 | 44 | 11–36 | 4 | |
| 8.2 | 44 | 11–36 | 4 | |
| 8.1 | 44 | 11–36 | 4 | |
| 7.4 | 44 | 11–36 | 4 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 2
- wp_parse_args()Merges user defined arguments into defaults array.
- WP_Style_Engine_CSS_Declarations::sanitize_property()Sanitizes property names.
Used by · 1
- WP_Style_Engine_CSS_Declarations::add_declarations()Adds multiple declarations.
Source code
public function add_declaration( $property, $value, $options = array() ) { // Sanitizes the property. $property = $this->sanitize_property( $property ); // Bails early if the property is empty. if ( empty( $property ) ) { return $this; } // Bail early if value is not a string. Prevents fatal errors from malformed block markup. if ( ! is_string( $value ) ) { return $this; } // Trims the value. If empty, bail early. $value = trim( $value ); if ( '' === $value ) { return $this; } $options = wp_parse_args( $options, array( 'important' => false, ) ); $options = array_filter( $options ); // Adds the declaration property/value pair. $this->declarations[ $property ] = $value; if ( $options ) { $this->declaration_options[ $property ] = $options; } else { unset( $this->declaration_options[ $property ] ); } return $this; }Changelog
Introduced in 6.1.0. One change between 6.7.7 and 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
$options added.verified against source$options parameter.from the docblockAbout this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/style-engine/class-wp-style-engine-css-declarations.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.