WP_Block_Patterns_Registry::register( string $pattern_name, array $pattern_properties ): bool

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.

$pattern_propertiesarray

List of properties for the block pattern.

• $titlestring

  Required. A human-readable title for the pattern.

• $contentstring

  Optional. Block HTML markup for the pattern. If not provided, the content will be retrieved from the filePath if set. If both content and filePath are not set, the pattern will not be registered.

• $descriptionstring

  Optional. Visually hidden text used to describe the pattern in the inserter. A description is optional, but is strongly encouraged when the title does not fully describe what the pattern does. The description will help users discover the pattern while searching.

• $viewportWidthint

  Optional. The intended width of the pattern to allow for a scaled preview within the pattern inserter.

• $inserterbooldefault: true

  Optional. Determines whether the pattern is visible in inserter. To hide a pattern so that it can only be inserted programmatically, set this to false.

• $categoriesstring[]

  Optional. A list of registered pattern categories used to group block patterns. Block patterns can be shown on multiple categories. A category must be registered separately in order to be used here.

• $keywordsstring[]

  Optional. A list of aliases or keywords that help users discover the pattern while searching.

• $blockTypesstring[]

  Optional. A list of block names including namespace that could use the block pattern in certain contexts (placeholder, transforms). The block pattern is available in the block editor inserter regardless of this list of block names. Certain blocks support further specificity besides the block name (e.g. for core/template-part you can specify areas like core/template-part/header or core/template-part/footer).

• $postTypesstring[]

  Optional. An array of post types that the pattern is restricted to be used with. The pattern will only be available when editing one of the post types passed on the array. For all the other post types not part of the array the pattern is not available at all.

• $templateTypesstring[]

  Optional. An array of template types where the pattern fits.

• $filePathstring

  Optional. The full path to the file containing the block pattern content.

Return value

bool

True if the pattern was registered with success and false otherwise.

Performance profile

How much work a call to WP_Block_Patterns_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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

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

Instructions

13–38

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

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 WP_Block_Patterns_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 · 3 distinct outcomes

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

Uses · 3

• _doing_it_wrong()Marks something as being incorrectly called.
• __()Retrieves the translation of $text.
• current_action()Retrieves the name of the current action hook.

Source code

View on Trac ↗View on GitHub ↗

89	public function register( $pattern_name, $pattern_properties ) {90		if ( ! isset( $pattern_name ) || ! is_string( $pattern_name ) ) {91			_doing_it_wrong(92				__METHOD__,93				__( 'Pattern name must be a string.' ),94				'5.5.0'95			);96			return false;97		}98 99		if ( ! isset( $pattern_properties['title'] ) || ! is_string( $pattern_properties['title'] ) ) {100			_doing_it_wrong(101				__METHOD__,102				__( 'Pattern title must be a string.' ),103				'5.5.0'104			);105			return false;106		}107 108		if ( ! isset( $pattern_properties['filePath'] ) ) {109			if ( ! isset( $pattern_properties['content'] ) || ! is_string( $pattern_properties['content'] ) ) {110				_doing_it_wrong(111					__METHOD__,112					__( 'Pattern content must be a string.' ),113					'5.5.0'114				);115				return false;116			}117		}118 119		$pattern = array_merge(120			$pattern_properties,121			array( 'name' => $pattern_name )122		);123 124		$this->registered_patterns[ $pattern_name ] = $pattern;125 126		// If the pattern is registered inside an action other than `init`, store it127		// also to a dedicated array. Used to detect deprecated registrations inside128		// `admin_init` or `current_screen`.129		if ( current_action() && 'init' !== current_action() ) {130			$this->registered_patterns_outside_init[ $pattern_name ] = $pattern;131		}132 133		return true;134	}

Changelog

Introduced in 5.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.