WP_Block_Patterns_Registry

15#[AllowDynamicProperties]16final class WP_Block_Patterns_Registry {17	/**18	 * Registered block patterns array.19	 *20	 * @since 5.5.021	 * @var array[]22	 */23	private $registered_patterns = array();24 25	/**26	 * Patterns registered outside the `init` action.27	 *28	 * @since 6.0.029	 * @var array[]30	 */31	private $registered_patterns_outside_init = array();32 33	/**34	 * Container for the main instance of the class.35	 *36	 * @since 5.5.037	 * @var WP_Block_Patterns_Registry|null38	 */39	private static $instance = null;40 41	/**42	 * Registers a block pattern.43	 *44	 * @since 5.5.045	 * @since 5.8.0 Added support for the `blockTypes` property.46	 * @since 6.1.0 Added support for the `postTypes` property.47	 * @since 6.2.0 Added support for the `templateTypes` property.48	 * @since 6.5.0 Added support for the `filePath` property.49	 *50	 * @param string $pattern_name       Block pattern name including namespace.51	 * @param array  $pattern_properties {52	 *     List of properties for the block pattern.53	 *54	 *     @type string   $title         Required. A human-readable title for the pattern.55	 *     @type string   $content       Optional. Block HTML markup for the pattern.56	 *                                   If not provided, the content will be retrieved from the `filePath` if set.57	 *                                   If both `content` and `filePath` are not set, the pattern will not be registered.58	 *     @type string   $description   Optional. Visually hidden text used to describe the pattern59	 *                                   in the inserter. A description is optional, but is strongly60	 *                                   encouraged when the title does not fully describe what the61	 *                                   pattern does. The description will help users discover the62	 *                                   pattern while searching.63	 *     @type int      $viewportWidth Optional. The intended width of the pattern to allow for a scaled64	 *                                   preview within the pattern inserter.65	 *     @type bool     $inserter      Optional. Determines whether the pattern is visible in inserter.66	 *                                   To hide a pattern so that it can only be inserted programmatically,67	 *                                   set this to false. Default true.68	 *     @type string[] $categories    Optional. A list of registered pattern categories used to group69	 *                                   block patterns. Block patterns can be shown on multiple categories.70	 *                                   A category must be registered separately in order to be used here.71	 *     @type string[] $keywords      Optional. A list of aliases or keywords that help users discover72	 *                                   the pattern while searching.73	 *     @type string[] $blockTypes    Optional. A list of block names including namespace that could use74	 *                                   the block pattern in certain contexts (placeholder, transforms).75	 *                                   The block pattern is available in the block editor inserter76	 *                                   regardless of this list of block names.77	 *                                   Certain blocks support further specificity besides the block name78	 *                                   (e.g. for `core/template-part` you can specify areas79	 *                                   like `core/template-part/header` or `core/template-part/footer`).80	 *     @type string[] $postTypes     Optional. An array of post types that the pattern is restricted81	 *                                   to be used with. The pattern will only be available when editing one82	 *                                   of the post types passed on the array. For all the other post types83	 *                                   not part of the array the pattern is not available at all.84	 *     @type string[] $templateTypes Optional. An array of template types where the pattern fits.85	 *     @type string   $filePath      Optional. The full path to the file containing the block pattern content.86	 * }87	 * @return bool True if the pattern was registered with success and false otherwise.88	 */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'