Changeset 43510 for branches/4.9/tests/phpunit/tests/term/meta.php

Timestamp:

07/19/2018 06:48:52 PM (7 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/tests/phpunit/tests/term/meta.php (modified) (2 diffs)

branches/4.9/tests/phpunit/tests/term/meta.php

@@ -7 +7 @@
  */
 class Tests_Term_Meta extends WP_UnitTestCase {
+
+    private $last_register_meta_call = array(
+        'object_type' => '',
+        'meta_key'    => '',
+        'args'        => array(),
+    );
+
     public function setUp() {
         parent::setUp();
@@ -442 +449 @@
         $q->set( 'cache_results', true );
     }
+
+    /**
+     * @ticket 38323
+     * @dataProvider data_register_term_meta
+     */
+    public function test_register_term_meta( $taxonomy, $meta_key, $args ) {
+        add_filter( 'register_meta_args', array( $this, 'filter_register_meta_args_set_last_register_meta_call' ), 10, 4 );
+
+        register_term_meta( $taxonomy, $meta_key, $args );
+
+        $args['object_subtype'] = $taxonomy;
+
+        // Reset global so subsequent data tests do not get polluted.
+        $GLOBALS['wp_meta_keys'] = array();
+
+        $this->assertEquals( 'term', $this->last_register_meta_call['object_type'] );
+        $this->assertEquals( $meta_key, $this->last_register_meta_call['meta_key'] );
+        $this->assertEquals( $args, $this->last_register_meta_call['args'] );
+    }
+
+    public function data_register_term_meta() {
+        return array(
+            array( 'wptests_tax', 'registered_key1', array( 'single' => true ) ),
+            array( 'category', 'registered_key2', array() ),
+            array( '', 'registered_key3', array( 'sanitize_callback' => 'absint' ) ),
+        );
+    }
+
+    public function filter_register_meta_args_set_last_register_meta_call( $args, $defaults, $object_type, $meta_key ) {
+        $this->last_register_meta_call['object_type'] = $object_type;
+        $this->last_register_meta_call['meta_key']    = $meta_key;
+        $this->last_register_meta_call['args']        = $args;
+
+        return $args;
+    }
+
+    /**
+     * @ticket 38323
+     * @dataProvider data_unregister_term_meta
+     */
+    public function test_unregister_term_meta( $taxonomy, $meta_key ) {
+        global $wp_meta_keys;
+
+        register_term_meta( $taxonomy, $meta_key, array() );
+        unregister_term_meta( $taxonomy, $meta_key );
+
+        $actual = $wp_meta_keys;
+
+        // Reset global so subsequent data tests do not get polluted.
+        $wp_meta_keys = array();
+
+        $this->assertEmpty( $actual );
+    }
+
+    public function data_unregister_term_meta() {
+        return array(
+            array( 'wptests_tax', 'registered_key1' ),
+            array( 'category', 'registered_key2' ),
+            array( '', 'registered_key3' ),
+        );
+    }
 }