WP_Block_Templates_Registry::register( string $template_name, array $args = array() ): WP_Block_Template|WP_Error

Compatibility

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

Parameters

$template_namestring

Template name including namespace.

$argsarrayoptional

Array of template arguments.Default: array()

Return value

WP_Block_Template|WP_Error

The registered template on success, or WP_Error on failure.

Performance profile

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

Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Constant

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

Instructions

23–88

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

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_Templates_Registry::register()
• optionoption read or writeget_option()one call below WP_Block_Templates_Registry::register()

Further down the call graph this can also reach cache, serialize, query 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 · 6 distinct outcomes

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

Uses · 7

• __()Retrieves the translation of $text.
• _doing_it_wrong()Marks something as being incorrectly called.
• get_stylesheet()Retrieves name of the current stylesheet.
• get_default_block_template_types()Returns a filtered list of default template types, containing their localized titles and descriptions.
• WP_Block_Templates_Registry::is_registered()Checks if a template is registered.
• WP_Error::__construct()Initializes the error.
• WP_Block_Template::__construct()

Source code

View on Trac ↗View on GitHub ↗

40	public function register( $template_name, $args = array() ) {41 42		$template = null;43 44		$error_message = '';45		$error_code    = '';46 47		if ( ! is_string( $template_name ) ) {48			$error_message = __( 'Template names must be strings.' );49			$error_code    = 'template_name_no_string';50		} elseif ( preg_match( '/[A-Z]+/', $template_name ) ) {51			$error_message = __( 'Template names must not contain uppercase characters.' );52			$error_code    = 'template_name_no_uppercase';53		} elseif ( ! preg_match( '/^[a-z0-9_\-]+\/\/[a-z0-9_\-]+$/', $template_name ) ) {54			$error_message = __( 'Template names must contain a namespace prefix. Example: my-plugin//my-custom-template' );55			$error_code    = 'template_no_prefix';56		} elseif ( $this->is_registered( $template_name ) ) {57			/* translators: %s: Template name. */58			$error_message = sprintf( __( 'Template "%s" is already registered.' ), $template_name );59			$error_code    = 'template_already_registered';60		}61 62		if ( $error_message ) {63			_doing_it_wrong( __METHOD__, $error_message, '6.7.0' );64 65			return new WP_Error( $error_code, $error_message );66		}67 68		if ( ! $template ) {69			$theme_name             = get_stylesheet();70			list( $plugin, $slug )  = explode( '//', $template_name );71			$default_template_types = get_default_block_template_types();72 73			$template              = new WP_Block_Template();74			$template->id          = $theme_name . '//' . $slug;75			$template->theme       = $theme_name;76			$template->plugin      = $plugin;77			$template->author      = null;78			$template->content     = $args['content'] ?? '';79			$template->source      = 'plugin';80			$template->slug        = $slug;81			$template->type        = 'wp_template';82			$template->title       = $args['title'] ?? $template_name;83			$template->description = $args['description'] ?? '';84			$template->status      = 'publish';85			$template->origin      = 'plugin';86			$template->is_custom   = ! isset( $default_template_types[ $template_name ] );87			$template->post_types  = $args['post_types'] ?? array();88		}89 90		$this->registered_templates[ $template_name ] = $template;91 92		return $template;93	}

Changelog

Introduced in 6.7.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-templates-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.