diff options
author | Sergey Biryukov <sergeybiryukov@git.wordpress.org> | 2023-02-01 15:00:19 +0000 |
---|---|---|
committer | Sergey Biryukov <sergeybiryukov@git.wordpress.org> | 2023-02-01 15:00:19 +0000 |
commit | d2f6c417ff17b633cc600cb33bcbff76dc78784c (patch) | |
tree | d99bf6f012c30dc12181e59f0506bf9557f8e07f /src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php | |
parent | 52e5e065b365c6fcd9a5f980b3cfb04d82d0f309 (diff) | |
download | wordpress-d2f6c417ff17b633cc600cb33bcbff76dc78784c.tar.gz wordpress-d2f6c417ff17b633cc600cb33bcbff76dc78784c.zip |
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.
git-svn-id: https://develop.svn.wordpress.org/trunk@55173 602fd350-edb4-49c9-b593-d223f7449a82
Diffstat (limited to 'src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php')
-rw-r--r-- | src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php b/src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php index 4d50bfae04..445f8c82f6 100644 --- a/src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php +++ b/src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php @@ -165,14 +165,14 @@ class WP_REST_Block_Patterns_Controller extends WP_REST_Controller { $keys = array( 'name' => 'name', 'title' => 'title', + 'content' => 'content', 'description' => 'description', 'viewportWidth' => 'viewport_width', - 'blockTypes' => 'block_types', - 'postTypes' => 'post_types', + 'inserter' => 'inserter', 'categories' => 'categories', 'keywords' => 'keywords', - 'content' => 'content', - 'inserter' => 'inserter', + 'blockTypes' => 'block_types', + 'postTypes' => 'post_types', 'templateTypes' => 'template_types', ); $data = array(); @@ -213,6 +213,12 @@ class WP_REST_Block_Patterns_Controller extends WP_REST_Controller { 'readonly' => true, '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.' ), 'type' => 'string', @@ -225,15 +231,9 @@ class WP_REST_Block_Patterns_Controller extends WP_REST_Controller { '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', + 'inserter' => array( + 'description' => __( 'Determines whether the pattern is visible in inserter.' ), + 'type' => 'boolean', 'readonly' => true, 'context' => array( 'view', 'edit', 'embed' ), ), @@ -249,21 +249,21 @@ class WP_REST_Block_Patterns_Controller extends WP_REST_Controller { 'readonly' => true, 'context' => array( 'view', 'edit', 'embed' ), ), - 'template_types' => array( - 'description' => __( 'An array of template types where the pattern fits.' ), + 'block_types' => array( + 'description' => __( 'Block types that the pattern is intended to be used with.' ), 'type' => 'array', 'readonly' => true, 'context' => array( 'view', 'edit', 'embed' ), ), - 'content' => array( - 'description' => __( 'The pattern content.' ), - 'type' => 'string', + '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' ), ), - 'inserter' => array( - 'description' => __( 'Determines whether the pattern is visible in inserter.' ), - 'type' => 'boolean', + 'template_types' => array( + 'description' => __( 'An array of template types where the pattern fits.' ), + 'type' => 'array', 'readonly' => true, 'context' => array( 'view', 'edit', 'embed' ), ), |