_register_theme_block_patterns()

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Performance profile

How much work a call to _register_theme_block_patterns() 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

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

4–23

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 96.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksdo_action()one call below _register_theme_block_patterns()

Further down the call graph this can also reach option, cache, serialize, transient and query. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 3 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost _register_theme_block_patterns() can have, taken from its control-flow graph on PHP 8.5.

Uses · 7

• wp_get_active_and_valid_themes()Retrieves an array of active and valid themes.
• wp_get_theme()Gets a WP_Theme object for a theme.
• _doing_it_wrong()Marks something as being incorrectly called.
• __()Retrieves the translation of $text.
• translate_with_gettext_context()Retrieves the translation of $text in the context defined in $context.
• register_block_pattern()Registers a new block pattern.
• WP_Block_Patterns_Registry::get_instance()Utility method to retrieve the main instance of the class.

Source code

View on Trac ↗View on GitHub ↗

414function _register_theme_block_patterns() {415 416	/*417	 * During the bootstrap process, a check for active and valid themes is run.418	 * If no themes are returned, the theme's functions.php file will not be loaded,419	 * which can lead to errors if patterns expect some variables or constants to420	 * already be set at this point, so bail early if that is the case.421	 */422	if ( empty( wp_get_active_and_valid_themes() ) ) {423		return;424	}425 426	/*427	 * Register patterns for the active theme. If the theme is a child theme,428	 * let it override any patterns from the parent theme that shares the same slug.429	 */430	$themes   = array();431	$theme    = wp_get_theme();432	$themes[] = $theme;433	if ( $theme->parent() ) {434		$themes[] = $theme->parent();435	}436	$registry = WP_Block_Patterns_Registry::get_instance();437 438	foreach ( $themes as $theme ) {439		$patterns    = $theme->get_block_patterns();440		$dirpath     = $theme->get_stylesheet_directory() . '/patterns/';441		$text_domain = $theme->get( 'TextDomain' );442 443		foreach ( $patterns as $file => $pattern_data ) {444			if ( $registry->is_registered( $pattern_data['slug'] ) ) {445				continue;446			}447 448			$file_path = $dirpath . $file;449 450			if ( ! file_exists( $file_path ) ) {451				_doing_it_wrong(452					__FUNCTION__,453					sprintf(454						/* translators: %s: file name. */455						__( 'Could not register file "%s" as a block pattern as the file does not exist.' ),456						$file457					),458					'6.4.0'459				);460				$theme->delete_pattern_cache();461				continue;462			}463 464			$pattern_data['filePath'] = $file_path;465 466			// Translate the pattern metadata.467			// phpcs:ignore WordPress.WP.I18n.NonSingularStringLiteralText,WordPress.WP.I18n.NonSingularStringLiteralDomain,WordPress.WP.I18n.LowLevelTranslationFunction468			$pattern_data['title'] = translate_with_gettext_context( $pattern_data['title'], 'Pattern title', $text_domain );469			if ( ! empty( $pattern_data['description'] ) ) {470				// phpcs:ignore WordPress.WP.I18n.NonSingularStringLiteralText,WordPress.WP.I18n.NonSingularStringLiteralDomain,WordPress.WP.I18n.LowLevelTranslationFunction471				$pattern_data['description'] = translate_with_gettext_context( $pattern_data['description'], 'Pattern description', $text_domain );472			}473 474			register_block_pattern( $pattern_data['slug'], $pattern_data );475		}476	}477}

Changelog

Introduced in 6.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 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.