WP_Block_Styles_Registry::register( string|string[] $block_name, array $style_properties ): bool
- Since
- 5.3.0, 6.6.0
- Source
wp-includes/class-wp-block-styles-registry.php:64
Description
If the block styles are present in a standalone stylesheet, register it and pass its handle as the style_handle argument. If the block styles should be inline, use the inline_style argument. Usually, one of them would be used to pass CSS styles. However, you could also skip them and provide CSS styles in any stylesheet or with an inline tag.
Compatibility
- WordPress
- since 6.6.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
$block_namestring|string[]- Block type name including namespace or array of namespaced block type names.
$style_propertiesarray- Array containing the properties of the style.
$namestringThe identifier of the style used to compute a CSS class.$labelstringA human-readable label for the style.$inline_stylestringInline CSS code that registers the CSS class required for the style.$style_handlestringThe handle to an already registered style that should be enqueued in places where block styles are needed.$is_defaultboolWhether this is the default style for the block type.$style_dataarrayTheme.json-like object to generate CSS from.
Return value
bool- True if the block style was registered with success and false otherwise.
Performance profile
How much work a call to WP_Block_Styles_Registry::register() 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
- Light
- Scaling
- Scales with input
- Instructions
- 15–28
- Plugin surface
- None
- Called by
- 0
Touches nothing outside its own arguments.
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 67.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
do_action()one call below WP_Block_Styles_Registry::register()
Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
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_Block_Styles_Registry::register() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 15–23 | __(), _doing_it_wrong() |
isset($style_properties) | 22–28 | none |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 67 | 15–28 | 10 | |
| 8.5 | 67 | 15–28 | 10 | |
| 8.4 | 67 | 15–28 | 10 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 70 | 15–31 | 10 | |
| 8.2 | 70 | 15–31 | 10 | |
| 8.1 | 70 | 15–31 | 10 | 2 fewer instructions than PHP 7.4 |
| 7.4 | 72 | 15–33 | 10 |
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 · 3
- _doing_it_wrong()Marks something as being incorrectly called.
- __()Retrieves the translation of $text.
- str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
Source code
public function register( $block_name, $style_properties ) { if ( ! is_string( $block_name ) && ! is_array( $block_name ) ) { _doing_it_wrong( __METHOD__, __( 'Block name must be a string or array.' ), '6.6.0' ); return false; } if ( ! isset( $style_properties['name'] ) || ! is_string( $style_properties['name'] ) ) { _doing_it_wrong( __METHOD__, __( 'Block style name must be a string.' ), '5.3.0' ); return false; } if ( str_contains( $style_properties['name'], ' ' ) ) { _doing_it_wrong( __METHOD__, __( 'Block style name must not contain any spaces.' ), '5.9.0' ); return false; } $block_style_name = $style_properties['name']; $block_names = is_string( $block_name ) ? array( $block_name ) : $block_name; // Ensure there is a label defined. if ( empty( $style_properties['label'] ) ) { $style_properties['label'] = $block_style_name; } foreach ( $block_names as $name ) { if ( ! isset( $this->registered_block_styles[ $name ] ) ) { $this->registered_block_styles[ $name ] = array(); } $this->registered_block_styles[ $name ][ $block_style_name ] = $style_properties; } return true; }Changelog
Introduced in 5.3.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/class-wp-block-styles-registry.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.