wp_style_add_data( string $handle, string $key, mixed $value ): bool
- Since
- 3.6.0, 5.8.0, 6.9.0
- Source
wp-includes/functions.wp-styles.php:244
Description
Works only if the stylesheet has already been registered.
Possible values for $key and $value: 'rtl' bool|string To declare an RTL stylesheet.
'suffix' string Optional suffix, used in combination with RTL.
'alt' bool For rel="alternate stylesheet".
'title' string For preferred/alternate stylesheets.
'path' string The absolute path to a stylesheet. Stylesheet will load inline when 'path' is set.
Compatibility
- WordPress
- since 6.9.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
$handlestring- Name of the stylesheet.
$keystring- Name of data point for which we're storing a value.
Accepts 'rtl' and 'suffix', 'alt', 'title' and 'path'. $valuemixed- String containing the CSS data to be added.
Return value
bool- True on success, false on failure.
Performance profile
How much work a call to wp_style_add_data() 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
- Plugin surface
- None
- Called by
- 8
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. The body compiles to 11.
Nothing here hands control to plugin code.
8 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_style_add_data() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 11 | wp_styles(), ->add_data() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 11 instructions, 11 executed per call, 0 branches. The work does not change between versions.
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_styles()Initializes $wp_styles if it has not been set.
- wp_styles()::add_data()
Used by · 8
- register_block_style_handle()Finds a style handle for the block metadata field. It detects when a path to file was provided and registers the style under automatically generated handle name. It returns unprocessed style handle otherwise.
- twenty_twenty_one_scripts()Enqueues scripts and styles.
- twentynineteen_scripts()Enqueues scripts and styles.
- twentytwenty_block_editor_styles()Enqueues supplemental block editor styles.
- twentytwenty_register_styles()Registers and Enqueues Styles.
- twentytwentyfive_enqueue_styles()Enqueues the theme stylesheet on the front.
- twentytwentytwo_styles()Enqueues styles.
- wp_enqueue_block_style()Enqueues a stylesheet for a specific block.
Source code
function wp_style_add_data( $handle, $key, $value ) { return wp_styles()->add_data( $handle, $key, $value );}Changelog
Introduced in 3.6.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
See wp_maybe_inline_styles().from the docblock
About this page
- Parsed data
- Generated from the wordpress-develop 6.9.7 tag, from
src/wp-includes/functions.wp-styles.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.