Changeset 59023

Timestamp:

09/16/2024 11:31:17 AM (4 weeks ago)

Author:

gziolo

Message:

Meta: Add label argument to register_meta function

With the introduction of Block Bindings, it became more common to see workflows where users need to see the custom fields that are available or connected. They were relying on the meta key, however it feelt too technical sometimes. The solution is adding a new label argument to include a human-readable name that can be used across the UI.

Props santosguillamot, mamaduka, gziolo, timothyblynjacobs, peterwilsoncc.
Fixes #61998.

Location:

trunk

Files:

• src/wp-includes/meta.php (modified) (3 diffs)
• src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php (modified) (1 diff)
• tests/phpunit/tests/meta/registerMeta.php (modified) (6 diffs)
• tests/phpunit/tests/rest-api/rest-post-meta-fields.php (modified) (2 diffs)
• tests/phpunit/tests/user/wpRegisterPersistedPreferencesMeta.php (modified) (1 diff)

trunk/src/wp-includes/meta.php

@@ -1370 +1370 @@
  * @since 5.5.0 The `$default` argument was added to the arguments array.
  * @since 6.4.0 The `$revisions_enabled` argument was added to the arguments array.
+ * @since 6.7.0 The `label` argument was added to the arguments array.
  *
  * @param string       $object_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user',
@@ -1381 +1382 @@
  *     @type string     $type              The type of data associated with this meta key.
  *                                         Valid values are 'string', 'boolean', 'integer', 'number', 'array', and 'object'.
+ *     @type string     $label             A human-readable label of the data attached to this meta key.
  *     @type string     $description       A description of the data attached to this meta key.
  *     @type bool       $single            Whether the meta key has one value per object, or an array of values per object.
@@ -1413 +1415 @@
         'object_subtype'    => '',
         'type'              => 'string',
+        'label'             => '',
         'description'       => '',
         'default'           => '',

trunk/src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php

@@ -479 +479 @@
             $default_schema = array(
                 'type'        => $default_args['type'],
+                'title'       => empty( $args['label'] ) ? '' : $args['label'],
                 'description' => empty( $args['description'] ) ? '' : $args['description'],
                 'default'     => isset( $args['default'] ) ? $args['default'] : null,

trunk/tests/phpunit/tests/meta/registerMeta.php

@@ -93 +93 @@
                     'flight_number' => array(
                         'type'              => 'string',
+                        'label'             => '',
                         'description'       => '',
                         'single'            => false,
@@ -118 +119 @@
                     'category_icon' => array(
                         'type'              => 'string',
+                        'label'             => '',
                         'description'       => '',
                         'single'            => false,
@@ -173 +175 @@
                     'flight_number' => array(
                         'type'              => 'string',
+                        'label'             => '',
                         'description'       => '',
                         'single'            => false,
@@ -257 +260 @@
     }
 
+    /**
+     * @ticket 61998
+     */
+    public function test_get_registered_meta_keys_label_arg() {
+        register_meta( 'post', 'registered_key1', array( 'label' => 'Field label' ) );
+
+        $meta_keys = get_registered_meta_keys( 'post' );
+
+        unregister_meta_key( 'post', 'registered_key1' );
+
+        $this->assertSame( 'Field label', $meta_keys['registered_key1']['label'] );
+    }
+
     public function test_get_registered_meta_keys_description_arg() {
         register_meta( 'post', 'registered_key1', array( 'description' => 'I\'m just a field, take a good look at me' ) );
@@ -341 +357 @@
                     'flight_number' => array(
                         'type'              => 'string',
+                        'label'             => '',
                         'description'       => '',
                         'single'            => false,
@@ -395 +412 @@
                     'flight_number' => array(
                         'type'              => 'string',
+                        'label'             => '',
                         'description'       => '',
                         'single'            => false,

trunk/tests/phpunit/tests/rest-api/rest-post-meta-fields.php

@@ -241 +241 @@
                 'show_in_rest' => true,
                 'default'      => 'Goodnight Moon',
+            )
+        );
+
+        register_post_meta(
+            'post',
+            'with_label',
+            array(
+                'type'         => 'string',
+                'single'       => true,
+                'show_in_rest' => true,
+                'label'        => 'Meta Label',
+                'default'      => '',
             )
         );
@@ -3092 +3104 @@
 
         $schema = $response->get_data()['schema']['properties']['meta']['properties']['with_default'];
-        $this->assertArrayHasKey( 'default', $schema );
-        $this->assertSame( 'Goodnight Moon', $schema['default'] );
+        $this->assertArrayHasKey( 'default', $schema, 'Schema is expected to have the default property' );
+        $this->assertSame( 'Goodnight Moon', $schema['default'], 'Schema default is expected to be defined and contain the value of the meta default argument.' );
+    }
+
+    /**
+     * @ticket 61998
+     */
+    public function test_title_is_added_to_schema() {
+        $request  = new WP_REST_Request( 'OPTIONS', '/wp/v2/posts' );
+        $response = rest_do_request( $request );
+
+        $schema = $response->get_data()['schema']['properties']['meta']['properties']['with_label'];
+
+        $this->assertArrayHasKey( 'title', $schema, 'Schema is expected to have the title property' );
+        $this->assertSame( 'Meta Label', $schema['title'], 'Schema title is expected to be defined and contain the value of the meta label argument.' );
     }
 

trunk/tests/phpunit/tests/user/wpRegisterPersistedPreferencesMeta.php

@@ -32 +32 @@
             array(
                 'type'              => 'object',
+                'label'             => '',
                 'description'       => '',
                 'single'            => true,