Changeset 55097

Timestamp:

01/19/2023 12:11:57 PM (4 years ago)

Author:

youknowriad

Message:

Editor: Allow block pattern categories to have descriptions.

Updates the corresponding REST API endpoint and unit test.

Fixes #57478.

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-block-pattern-categories-controller.php (modified) (3 diffs)
• tests/phpunit/tests/rest-api/wpRestBlockPatternCategoriesController.php (modified) (2 diffs)

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

@@ -103 +103 @@
         public function prepare_item_for_response( $item, $request ) {
                 $fields = $this->get_fields_for_response( $request );
-                $keys   = array( 'name', 'label' );
+                $keys   = array( 'name', 'label', 'description' );
                 $data   = array();
                 foreach ( $keys as $key ) {
-                        if ( rest_is_field_included( $key, $fields ) ) {
+                        if ( isset( $item[ $key ] ) && rest_is_field_included( $key, $fields ) ) {
                                 $data[ $key ] = $item[ $key ];
                         }
@@ -131 +131 @@
                         'type'       => 'object',
                         'properties' => array(
-                                'name'  => array(
+                                'name'        => array(
                                         'description' => __( 'The category name.' ),
                                         'type'        => 'string',
@@ -137 +137 @@
                                         'context'     => array( 'view', 'edit', 'embed' ),
                                 ),
-                                'label' => array(
+                                'label'       => array(
                                         'description' => __( 'The category label, in human readable format.' ),
+                                        'type'        => 'string',
+                                        'readonly'    => true,
+                                        'context'     => array( 'view', 'edit', 'embed' ),
+                                ),
+                                'description' => array(
+                                        'description' => __( 'The category description, in human readable format.' ),
                                         'type'        => 'string',
                                         'readonly'    => true,

trunk/tests/phpunit/tests/rest-api/wpRestBlockPatternCategoriesController.php

@@ -75 +75 @@
 
                 // Register some categories in the test registry.
-                $test_registry->register( 'test', array( 'label' => 'Test' ) );
-                $test_registry->register( 'query', array( 'label' => 'Query' ) );
+                $test_registry->register(
+                        'test',
+                        array(
+                                'label'       => 'Test',
+                                'description' => 'Test description',
+                        )
+                );
+                $test_registry->register(
+                        'query',
+                        array(
+                                'label'       => 'Query',
+                                'description' => 'Query',
+                        )
+                );
         }
 
@@ -104 +116 @@
 
                 $expected_names  = array( 'test', 'query' );
-                $expected_fields = array( 'name', 'label' );
+                $expected_fields = array( 'name', 'label', 'description' );
 
                 $request            = new WP_REST_Request( 'GET', static::REQUEST_ROUTE );
-                $request['_fields'] = 'name,label';
+                $request['_fields'] = 'name,label,description';
                 $response           = rest_get_server()->dispatch( $request );
                 $data               = $response->get_data();