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

Timestamp:

02/01/2023 03:00:19 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for block pattern properties.

Includes:

• Adding the templateTypes property to the WP_Block_Patterns_Registry::register() DocBlock.
• Adding @since notes for the postTypes and templateTypes properties to:
  • _register_theme_block_patterns()
  • WP_Block_Patterns_Registry::register()
• Bringing some consistency to the order of properties between:
  • _register_theme_block_patterns()
  • WP_Block_Patterns_Registry::register()
  • WP_REST_Block_Patterns_Controller::prepare_item_for_response()
  • WP_REST_Block_Patterns_Controller::get_item_schema()

Follow-up to [52943], [53152], [54263], [55168].

See #56792.

File:

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

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

@@ -44 +44 @@
      * @since 5.5.0
      * @since 5.8.0 Added support for the `blockTypes` property.
+     * @since 6.1.0 Added support for the `postTypes` property.
+     * @since 6.2.0 Added support for the `templateTypes` property.
      *
      * @param string $pattern_name       Block pattern name including namespace.
@@ -51 +53 @@
      *     @type string $title         Required. A human-readable title for the pattern.
      *     @type string $content       Required. Block HTML markup for the pattern.
-     *     @type string $description   Optional. Visually hidden text used to describe the pattern in the
-     *                                 inserter. A description is optional, but is strongly
+     *     @type string $description   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
@@ -58 +60 @@
      *     @type int    $viewportWidth Optional. The intended width of the pattern to allow for a scaled
      *                                 preview within the pattern inserter.
-     *     @type array  $categories    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.
+     *     @type array  $categories    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.
+     *     @type array  $keywords      Optional. A list of aliases or keywords that help users discover
+     *                                 the pattern while searching.
      *     @type array  $blockTypes    Optional. A list of block names including namespace that could use
      *                                 the block pattern in certain contexts (placeholder, transforms).
@@ -69 +72 @@
      *                                 (e.g. for `core/template-part` you can specify areas
      *                                 like `core/template-part/header` or `core/template-part/footer`).
-     *     @type array  $postTypes     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.
-     *     @type array  $keywords      Optional. A list of aliases or keywords that help users discover the
-     *                                 pattern while searching.
+     *     @type array  $postTypes     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.
+     *     @type array  $templateTypes Optional. An array of template types where the pattern fits.
      * }
      * @return bool True if the pattern was registered with success and false otherwise.