Changeset 43510 for branches/4.9/src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php

Timestamp:

07/19/2018 06:48:52 PM (8 years ago)

Author:

kadamwhite

Message:

REST API: Support meta registration for specific object subtypes.

Introduce an object_subtype argument to the args array for register_meta() which can be used to limit meta registration to a single subtype (e.g. a custom post type or taxonomy, vs all posts or taxonomies).

Introduce register_post_meta() and register_term_meta() wrapper methods for register_meta to provide a convenient interface for the common case of registering meta for a specific taxonomy or post type. These methods work the way plugin developers have often expected register_meta to function, and should be used in place of direct register_meta where possible.

Props flixos90, tharsheblows, spacedmonkey.

Merges [43378] to the 4.9 branch.
Fixes #38323.

File:

• branches/4.9/src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php (modified) (2 diffs)

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

@@ -24 +24 @@
          */
         abstract protected function get_meta_type();
+
+        /**
+         * Retrieves the object meta subtype.
+         *
+         * @since 4.9.8
+         *
+         * @return string Subtype for the meta type, or empty string if no specific subtype.
+         */
+        protected function get_meta_subtype() {
+                return '';
+        }
 
         /**
@@ -318 +329 @@
                 $registered = array();
 
-                foreach ( get_registered_meta_keys( $this->get_meta_type() ) as $name => $args ) {
+                $meta_type    = $this->get_meta_type();
+                $meta_subtype = $this->get_meta_subtype();
+
+                $meta_keys = get_registered_meta_keys( $meta_type );
+                if ( ! empty( $meta_subtype ) ) {
+                        $meta_keys = array_merge( $meta_keys, get_registered_meta_keys( $meta_type, $meta_subtype ) );
+                }
+
+                foreach ( $meta_keys as $name => $args ) {
                         if ( empty( $args['show_in_rest'] ) ) {
                                 continue;