WP_Block_Patterns_Registry::get_content( string $pattern_name, bool $outside_init_only = false ): string

Compatibility

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.

$outside_init_onlybooloptional

Return only patterns registered outside the init action. Default false.Default: false

Return value

string

The content of the block pattern.

Performance profile

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

Heavy

Reads or writes the filesystem via is_file().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

21–67

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• filesystemfilesystem accessis_file()called directly

What one call costs · 32 distinct outcomes

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

Uses · 1

• str_ends_with()Polyfill for `str_ends_with()` function added in PHP 8.0.

Used by · 2

• WP_Block_Patterns_Registry::get_all_registered()Retrieves all registered block patterns.
• WP_Block_Patterns_Registry::get_registered()Retrieves an array containing the properties of a registered block pattern.

Source code

View on Trac ↗View on GitHub ↗

170	private function get_content( $pattern_name, $outside_init_only = false ) {171		if ( $outside_init_only ) {172			$patterns = &$this->registered_patterns_outside_init;173		} else {174			$patterns = &$this->registered_patterns;175		}176 177		$file_path    = $patterns[ $pattern_name ]['filePath'] ?? '';178		$is_stringy   = is_string( $file_path ) || ( is_object( $file_path ) && method_exists( $file_path, '__toString' ) );179		$pattern_path = $is_stringy ? realpath( (string) $file_path ) : null;180		if (181			! isset( $patterns[ $pattern_name ]['content'] ) &&182			is_string( $pattern_path ) &&183			( str_ends_with( $pattern_path, '.php' ) || str_ends_with( $pattern_path, '.html' ) ) &&184			is_file( $pattern_path ) &&185			is_readable( $pattern_path )186		) {187			ob_start();188			include $patterns[ $pattern_name ]['filePath'];189			$patterns[ $pattern_name ]['content'] = ob_get_clean();190			unset( $patterns[ $pattern_name ]['filePath'] );191		}192 193		return $patterns[ $pattern_name ]['content'];194	}

Changelog

Introduced in 6.5.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/class-wp-block-patterns-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.