Changeset 55173 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.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/rest-api/endpoints/class-wp-rest-block-patterns-controller.php (modified) (4 diffs)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php

@@ -166 +166 @@
             'name'          => 'name',
             'title'         => 'title',
+            'content'       => 'content',
             'description'   => 'description',
             'viewportWidth' => 'viewport_width',
+            'inserter'      => 'inserter',
+            'categories'    => 'categories',
+            'keywords'      => 'keywords',
             'blockTypes'    => 'block_types',
             'postTypes'     => 'post_types',
-            'categories'    => 'categories',
-            'keywords'      => 'keywords',
-            'content'       => 'content',
-            'inserter'      => 'inserter',
             'templateTypes' => 'template_types',
         );
@@ -214 +214 @@
                     'context'     => array( 'view', 'edit', 'embed' ),
                 ),
+                'content'        => array(
+                    'description' => __( 'The pattern content.' ),
+                    'type'        => 'string',
+                    'readonly'    => true,
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
                 'description'    => array(
                     'description' => __( 'The pattern detailed description.' ),
@@ -226 +232 @@
                     'context'     => array( 'view', 'edit', 'embed' ),
                 ),
-                'block_types'    => array(
-                    'description' => __( 'Block types that the pattern is intended to be used with.' ),
-                    'type'        => 'array',
-                    'readonly'    => true,
-                    'context'     => array( 'view', 'edit', 'embed' ),
-                ),
-                'post_types'     => array(
-                    'description' => __( 'An array of post types that the pattern is restricted to be used with.' ),
-                    'type'        => 'array',
-                    'readonly'    => true,
-                    'context'     => array( 'view', 'edit', 'embed' ),
-                ),
-                'categories'     => array(
-                    'description' => __( 'The pattern category slugs.' ),
-                    'type'        => 'array',
-                    'readonly'    => true,
-                    'context'     => array( 'view', 'edit', 'embed' ),
-                ),
-                'keywords'       => array(
-                    'description' => __( 'The pattern keywords.' ),
-                    'type'        => 'array',
-                    'readonly'    => true,
-                    'context'     => array( 'view', 'edit', 'embed' ),
-                ),
-                'template_types' => array(
-                    'description' => __( 'An array of template types where the pattern fits.' ),
-                    'type'        => 'array',
-                    'readonly'    => true,
-                    'context'     => array( 'view', 'edit', 'embed' ),
-                ),
-                'content'        => array(
-                    'description' => __( 'The pattern content.' ),
-                    'type'        => 'string',
-                    'readonly'    => true,
-                    'context'     => array( 'view', 'edit', 'embed' ),
-                ),
                 'inserter'       => array(
                     'description' => __( 'Determines whether the pattern is visible in inserter.' ),
@@ -268 +238 @@
                     'context'     => array( 'view', 'edit', 'embed' ),
                 ),
+                'categories'     => array(
+                    'description' => __( 'The pattern category slugs.' ),
+                    'type'        => 'array',
+                    'readonly'    => true,
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+                'keywords'       => array(
+                    'description' => __( 'The pattern keywords.' ),
+                    'type'        => 'array',
+                    'readonly'    => true,
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+                'block_types'    => array(
+                    'description' => __( 'Block types that the pattern is intended to be used with.' ),
+                    'type'        => 'array',
+                    'readonly'    => true,
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+                'post_types'     => array(
+                    'description' => __( 'An array of post types that the pattern is restricted to be used with.' ),
+                    'type'        => 'array',
+                    'readonly'    => true,
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+                'template_types' => array(
+                    'description' => __( 'An array of template types where the pattern fits.' ),
+                    'type'        => 'array',
+                    'readonly'    => true,
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
             ),
         );