register_block_pattern( string $pattern_name, array $pattern_properties ): bool
- Since
- 5.5.0
- Source
wp-includes/block-patterns.php:21
Compatibility
- WordPress
- since 5.5.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
$pattern_namestring- Block pattern name including namespace.
$pattern_propertiesarray- List of properties for the block pattern.
See WP_Block_Patterns_Registry::register() for accepted arguments.
Return value
bool- True if the pattern was registered with success and false otherwise.
Performance profile
How much work a call to register_block_pattern() 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
- 9
- Plugin surface
- None
- Called by
- 7
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 9.
Nothing here hands control to plugin code.
7 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 register_block_pattern() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 9 | ::WP_Block_Patterns_Registry(), ->register() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 9 instructions, 9 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_Block_Patterns_Registry::get_instance()::register()
- WP_Block_Patterns_Registry::get_instance()Utility method to retrieve the main instance of the class.
Used by · 7
- _load_remote_block_patterns()Register Core's official patterns from wordpress.org/patterns.
- _load_remote_featured_patterns()Register `Featured` (category) patterns from wordpress.org/patterns.
- _register_core_block_patterns_and_categories()Registers the core block patterns and categories.
- _register_remote_theme_patterns()Registers patterns from Pattern Directory provided by a theme's `theme.json` file.
- _register_theme_block_patterns()Register any patterns that the active theme may provide under its `./patterns/` directory.
- twenty_twenty_one_register_block_pattern()Registers Block Patterns.
- twentytwentytwo_register_block_patterns()Registers block patterns and categories.
Source code
function register_block_pattern( $pattern_name, $pattern_properties ) { return WP_Block_Patterns_Registry::get_instance()->register( $pattern_name, $pattern_properties );}Changelog
Introduced in 5.5.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/block-patterns.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.