WP_Block_Pattern_Categories_Registry::register( string $category_name, array $category_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

$category_namestring

Pattern category name including namespace.

$category_propertiesarray

List of properties for the block pattern category.

• $labelstring

  Required. A human-readable label for the pattern category.

Return value

bool

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

Performance profile

How much work a call to WP_Block_Pattern_Categories_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–26

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

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_Pattern_Categories_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_Pattern_Categories_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 ↗

52	public function register( $category_name, $category_properties ) {53		if ( ! isset( $category_name ) || ! is_string( $category_name ) ) {54			_doing_it_wrong(55				__METHOD__,56				__( 'Block pattern category name must be a string.' ),57				'5.5.0'58			);59			return false;60		}61 62		$category = array_merge(63			array( 'name' => $category_name ),64			$category_properties65		);66 67		$this->registered_categories[ $category_name ] = $category;68 69		// If the category is registered inside an action other than `init`, store it70		// also to a dedicated array. Used to detect deprecated registrations inside71		// `admin_init` or `current_screen`.72		if ( current_action() && 'init' !== current_action() ) {73			$this->registered_categories_outside_init[ $category_name ] = $category;74		}75 76		return true;77	}

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-pattern-categories-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.