Changeset 55173 for trunk/src/wp-includes/block-patterns.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/block-patterns.php (modified) (3 diffs)

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

@@ -299 +299 @@
  *   - Description
  *   - Viewport Width
+ *   - Inserter         (yes/no)
  *   - Categories       (comma-separated values)
  *   - Keywords         (comma-separated values)
@@ -304 +305 @@
  *   - Post Types       (comma-separated values)
  *   - Template Types   (comma-separated values)
- *   - Inserter         (yes/no)
  *
  * @since 6.0.0
+ * @since 6.1.0 The `postTypes` property was added.
+ * @since 6.2.0 The `templateTypes` property was added.
  * @access private
  */
@@ -315 +317 @@
         'description'   => 'Description',
         'viewportWidth' => 'Viewport Width',
+        'inserter'      => 'Inserter',
         'categories'    => 'Categories',
         'keywords'      => 'Keywords',
         'blockTypes'    => 'Block Types',
         'postTypes'     => 'Post Types',
-        'inserter'      => 'Inserter',
         'templateTypes' => 'Template Types',
     );