Ticket #41055: 41055.2.diff

src/wp-includes/js/wp-api.js

@@ -501 +501 @@
                          * Add a helper function to handle post Meta.
                          */
                         MetaMixin = {
-                                getMeta: function() {
-                                        return buildCollectionGetter( this, 'PostMeta', 'https://api.w.org/meta' );
-                                }
+
+                                /**
+                                 * Get meta by key for a post.
+                                 *
+                                 * @param {string} key The meta key.
+                                 *
+                                 * @return {object} The post meta value.
+                                 */
+                                getMeta: function( key ) {
+                                        var metas = this.get( 'meta' );
+                                        return metas[ key ];
+                                },
+
+                                /**
+                                 * Get all meta key/values for a post.
+                                 *
+                                 * @return {object} The post metas, as a key value pair object.
+                                 */
+                                getMetas: function() {
+                                        return this.get( 'meta' );
+                                },
+
+                                /**
+                                 * Set a group of meta key/values for a post.
+                                 *
+                                 * @param {object} meta The post meta to set, as key/value pairs.
+                                 */
+                                setMetas: function( meta ) {
+                                        var metas = this.get( 'meta' );
+                                        _.extend( metas, meta );
+                                        this.set( 'meta', metas );
+                                },
+
+                                /**
+                                 * Set a single meta value for a post, by key.
+                                 *
+                                 * @param {string} key   The meta key.
+                                 * @param {object} value The meta value.
+                                 */
+                                setMeta: function( key, value ) {
+                                        var metas = this.get( 'meta' );
+                                        metas[ key ] = value;
+                                        this.set( 'meta', metas );
+                                },
                         },
 
                         /**
@@ -734 +775 @@
                         model = model.extend( CategoriesMixin );
                 }
 
-                // Add the MetaMixin for models that support meta collections.
-                if ( ! _.isUndefined( loadingObjects.collections[ modelClassName + 'Meta' ] ) ) {
+                // Add the MetaMixin for models that support meta.
+                if ( ! _.isUndefined( model.prototype.args.meta ) ) {
                         model = model.extend( MetaMixin );
                 }
 

tests/phpunit/tests/rest-api/rest-schema-setup.php

@@ -145 +145 @@
                         'post_excerpt'   => 'REST API Client Fixture: Post',
                         'post_author'    => 0,
                 ) );
+                $args = array(
+                        'sanitize_callback' => 'sanitize_my_meta_key',
+                        'auth_callback'     => '__return_true',
+                        'type'              => 'string',
+                        'description'       => 'Test meta key',
+                        'single'            => true,
+                        'show_in_rest'      => true,
+                );
+                register_meta( 'post', 'meta_key', $args );
+                update_post_meta( $post_id, 'meta_key', 'meta_value' );
                 wp_update_post( array(
                         'ID'           => $post_id,
                         'post_content' => 'Updated post content.',

tests/qunit/fixtures/wp-api-generated.js

@@ -3560 +3560 @@
         "sticky": false,
         "template": "",
         "format": "standard",
-        "meta": [],
+        "meta": {
+            "meta_key": "meta_value"
+        },
         "categories": [
             1
         ],
@@ -3651 +3653 @@
     "sticky": false,
     "template": "",
     "format": "standard",
-    "meta": [],
+    "meta": {
+        "meta_key": "meta_value"
+    },
     "categories": [
         1
     ],
@@ -3745 +3749 @@
         "comment_status": "closed",
         "ping_status": "closed",
         "template": "",
-        "meta": [],
+        "meta": {
+            "meta_key": ""
+        },
         "_links": {
             "self": [
                 {
@@ -3820 +3826 @@
     "comment_status": "closed",
     "ping_status": "closed",
     "template": "",
-    "meta": []
+    "meta": {
+        "meta_key": ""
+    }
 };
 
 mockedApiResponse.pageRevisions = [
@@ -3899 +3907 @@
         "comment_status": "open",
         "ping_status": "closed",
         "template": "",
-        "meta": [],
+        "meta": {
+            "meta_key": ""
+        },
         "description": {
             "rendered": "<p class=\"attachment\"><!-- <a...><img.../></a> --></p>"
         },
@@ -3958 +3968 @@
     "comment_status": "open",
     "ping_status": "closed",
     "template": "",
-    "meta": [],
+    "meta": {
+        "meta_key": ""
+    },
     "description": {
         "rendered": "<p class=\"attachment\"><!-- <a...><img.../></a> --></p>"
     },

tests/qunit/wp-includes/js/wp-api.js

@@ -343 +343 @@
                 } );
         });
 
+        // Test post meta.
+        wp.api.loadPromise.done( function() {
+                QUnit.test( 'Check meta support.' , function( assert ) {
+                        var theModels = new wp.api.collections.Posts();
+
+                        theModels.fetch().done( function() {
+
+                                // Get the main endpoint.
+                                var endpoint = theModels.at(0)
+
+                                // Verify the meta object returned correctly from `getMetas()`.
+                                assert.equal( JSON.stringify( endpoint.getMetas() ), '{"meta_key":"meta_value"}', 'Full meta key/values object should be readable.' );
+
+                                // Verify single meta returned correctly from `getMeta()`
+                                assert.equal( endpoint.getMeta( 'meta_key' ), 'meta_value', 'Single meta should be readable by key.' );
+
+                                // Verify setting meta values with `setMetas()`.
+                                endpoint.setMetas( { 'test_key':'test_value' } );
+                                assert.equal( endpoint.getMeta( 'test_key' ), 'test_value', 'Multiple meta should be writable via setMetas.' );
+
+                                // Verify setting a single meta value with `setMeta()`.
+                                endpoint.setMeta( 'test_key2', 'test_value2' );
+                                assert.equal( endpoint.getMeta( 'test_key2' ), 'test_value2', 'Single meta should be writable via setMeta.' );
+
+                        } );
+                } );
+        } );
+
+
 } )( window.QUnit );