Changeset 52943

Timestamp:

03/17/2022 04:11:27 AM (5 years ago)

Author:

peterwilsoncc

Message:

Editor/Docs: Add blockTypes argument to WP_Block_Patterns_Registry::register() docblock.

Add the optional blockTypes argument in the patten properties for WP_Block_Patterns_Registry::register().

Props vlad.olaru.
Fixes #55303.
See #54729.

File:

• trunk/src/wp-includes/class-wp-block-patterns-registry.php (modified) (2 diffs)

trunk/src/wp-includes/class-wp-block-patterns-registry.php

@@ -34 +34 @@
          *
          * @since 5.5.0
+         * @since 5.8.0 Added support for the `blockTypes` property.
          *
          * @param string $pattern_name       Block pattern name including namespace.
@@ -52 +53 @@
          *                                 A category must be registered separately in order to be used
          *                                 here.
+         *     @type array  $blockTypes    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`).
          *     @type array  $keywords      Optional. A list of aliases or keywords that help users discover the
          *                                 pattern while searching.