[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-includes/ -> block-patterns.php (summary)

Register the block patterns and block patterns categories

File Size: 466 lines (15 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 10 functions

  register_block_pattern()
  unregister_block_pattern()
  register_block_pattern_category()
  unregister_block_pattern_category()
  _register_core_block_patterns_and_categories()
  wp_normalize_remote_block_pattern()
  _load_remote_block_patterns()
  _load_remote_featured_patterns()
  _register_remote_theme_patterns()
  _register_theme_block_patterns()

Functions
Functions that are not part of a class:

register_block_pattern( $pattern_name, $pattern_properties )   X-Ref
Registers a new block pattern.

param: string $pattern_name       Block pattern name including namespace.
param: array  $pattern_properties List of properties for the block pattern.
return: bool True if the pattern was registered with success and false otherwise.

unregister_block_pattern( $pattern_name )   X-Ref
Unregisters a block pattern.

param: string $pattern_name Block pattern name including namespace.
return: bool True if the pattern was unregistered with success and false otherwise.

register_block_pattern_category( $category_name, $category_properties )   X-Ref
Registers a new pattern category.

param: string $category_name       Pattern category name including namespace.
param: array  $category_properties List of properties for the block pattern.
return: bool True if the pattern category was registered with success and false otherwise.

unregister_block_pattern_category( $category_name )   X-Ref
Unregisters a pattern category.

param: string $category_name Pattern category name including namespace.
return: bool True if the pattern category was unregistered with success and false otherwise.

_register_core_block_patterns_and_categories()   X-Ref
Registers the core block patterns and categories.


wp_normalize_remote_block_pattern( $pattern )   X-Ref
Normalize the pattern properties to camelCase.

The API's format is snake_case, `register_block_pattern()` expects camelCase.

param: array $pattern Pattern as returned from the Pattern Directory API.
return: array Normalized pattern.

_load_remote_block_patterns( $deprecated = null )   X-Ref
Register Core's official patterns from wordpress.org/patterns.

param: WP_Screen $deprecated Unused. Formerly the screen that the current request was triggered from.

_load_remote_featured_patterns()   X-Ref
Register `Featured` (category) patterns from wordpress.org/patterns.


_register_remote_theme_patterns()   X-Ref
Registers patterns from Pattern Directory provided by a theme's
`theme.json` file.


_register_theme_block_patterns()   X-Ref
Register any patterns that the active theme may provide under its
`./patterns/` directory.




Generated : Tue Apr 21 08:20:12 2026 Cross-referenced by PHPXref