Title: WP_Block_Patterns_Registry::register
Published: August 11, 2020
Last modified: April 28, 2025

---

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

## In this article

 * [Parameters](https://developer.wordpress.org/reference/classes/wp_block_patterns_registry/register/?output_format=md#parameters)
 * [Return](https://developer.wordpress.org/reference/classes/wp_block_patterns_registry/register/?output_format=md#return)
 * [Source](https://developer.wordpress.org/reference/classes/wp_block_patterns_registry/register/?output_format=md#source)
 * [Related](https://developer.wordpress.org/reference/classes/wp_block_patterns_registry/register/?output_format=md#related)
 * [Changelog](https://developer.wordpress.org/reference/classes/wp_block_patterns_registry/register/?output_format=md#changelog)

[ Back to top](https://developer.wordpress.org/reference/classes/wp_block_patterns_registry/register/?output_format=md#wp--skip-link--target)

Registers a block pattern.

## 󠀁[Parameters](https://developer.wordpress.org/reference/classes/wp_block_patterns_registry/register/?output_format=md#parameters)󠁿

 `$pattern_name`stringrequired

Block pattern name including namespace.

`$pattern_properties`arrayrequired

List of properties for the block pattern.

 * `title` string
 * Required. A human-readable title for the pattern.
 * `content` string
 * 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.
 * `description` string
 * 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.
 * `viewportWidth` int
 * Optional. The intended width of the pattern to allow for a scaled preview within
   the pattern inserter.
 * `inserter` bool
 * 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. Default 
   true.
 * `categories` string[]
 * 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.
 * `keywords` string[]
 * Optional. A list of aliases or keywords that help users discover the pattern 
   while searching.
 * `blockTypes` string[]
 * 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`).
 * `postTypes` string[]
 * 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.
 * `templateTypes` string[]
 * Optional. An array of template types where the pattern fits.
 * `filePath` string
 * Optional. The full path to the file containing the block pattern content.

## 󠀁[Return](https://developer.wordpress.org/reference/classes/wp_block_patterns_registry/register/?output_format=md#return)󠁿

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

## 󠀁[Source](https://developer.wordpress.org/reference/classes/wp_block_patterns_registry/register/?output_format=md#source)󠁿

    ```php
    public function register( $pattern_name, $pattern_properties ) {
    	if ( ! isset( $pattern_name ) || ! is_string( $pattern_name ) ) {
    		_doing_it_wrong(
    			__METHOD__,
    			__( 'Pattern name must be a string.' ),
    			'5.5.0'
    		);
    		return false;
    	}

    	if ( ! isset( $pattern_properties['title'] ) || ! is_string( $pattern_properties['title'] ) ) {
    		_doing_it_wrong(
    			__METHOD__,
    			__( 'Pattern title must be a string.' ),
    			'5.5.0'
    		);
    		return false;
    	}

    	if ( ! isset( $pattern_properties['filePath'] ) ) {
    		if ( ! isset( $pattern_properties['content'] ) || ! is_string( $pattern_properties['content'] ) ) {
    			_doing_it_wrong(
    				__METHOD__,
    				__( 'Pattern content must be a string.' ),
    				'5.5.0'
    			);
    			return false;
    		}
    	}

    	$pattern = array_merge(
    		$pattern_properties,
    		array( 'name' => $pattern_name )
    	);

    	$this->registered_patterns[ $pattern_name ] = $pattern;

    	// If the pattern is registered inside an action other than `init`, store it
    	// also to a dedicated array. Used to detect deprecated registrations inside
    	// `admin_init` or `current_screen`.
    	if ( current_action() && 'init' !== current_action() ) {
    		$this->registered_patterns_outside_init[ $pattern_name ] = $pattern;
    	}

    	return true;
    }
    ```

[View all references](https://developer.wordpress.org/reference/files/wp-includes/class-wp-block-patterns-registry.php/)
[View on Trac](https://core.trac.wordpress.org/browser/tags/6.9.4/src/wp-includes/class-wp-block-patterns-registry.php#L89)
[View on GitHub](https://github.com/WordPress/wordpress-develop/blob/6.9.4/src/wp-includes/class-wp-block-patterns-registry.php#L89-L134)

## 󠀁[Related](https://developer.wordpress.org/reference/classes/wp_block_patterns_registry/register/?output_format=md#related)󠁿

| Uses | Description | 
| [current_action()](https://developer.wordpress.org/reference/functions/current_action/)`wp-includes/plugin.php` |

Retrieves the name of the current action hook.

  | 
| [__()](https://developer.wordpress.org/reference/functions/__/)`wp-includes/l10n.php` |

Retrieves the translation of $text.

  | 
| [_doing_it_wrong()](https://developer.wordpress.org/reference/functions/_doing_it_wrong/)`wp-includes/functions.php` |

Marks something as being incorrectly called.

  |

[Show 1 more](https://developer.wordpress.org/reference/classes/wp_block_patterns_registry/register/?output_format=md#)
[Show less](https://developer.wordpress.org/reference/classes/wp_block_patterns_registry/register/?output_format=md#)

## 󠀁[Changelog](https://developer.wordpress.org/reference/classes/wp_block_patterns_registry/register/?output_format=md#changelog)󠁿

| Version | Description | 
| [6.5.0](https://developer.wordpress.org/reference/since/6.5.0/) | Added support for the `filePath` property. | 
| [6.2.0](https://developer.wordpress.org/reference/since/6.2.0/) | Added support for the `templateTypes` property. | 
| [6.1.0](https://developer.wordpress.org/reference/since/6.1.0/) | Added support for the `postTypes` property. | 
| [5.8.0](https://developer.wordpress.org/reference/since/5.8.0/) | Added support for the `blockTypes` property. | 
| [5.5.0](https://developer.wordpress.org/reference/since/5.5.0/) | Introduced. |

## User Contributed Notes

You must [log in](https://login.wordpress.org/?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Fclasses%2Fwp_block_patterns_registry%2Fregister%2F)
before being able to contribute a note or feedback.