Changeset 47325 for trunk/tests/phpunit/tests/rest-api/rest-settings-controller.php

Timestamp:

02/19/2020 10:54:03 PM (6 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Warn if registering array settings without an items schema.

The documentation for register_setting has also been clarified to include all of the supported types and the flexibility of the show_in_rest parameter.

Fixes #42875.
Props perrywagle, dshanske, kadamwhite.

File:

• trunk/tests/phpunit/tests/rest-api/rest-settings-controller.php (modified) (2 diffs)

trunk/tests/phpunit/tests/rest-api/rest-settings-controller.php

@@ -37 +37 @@
         parent::setUp();
         $this->endpoint = new WP_REST_Settings_Controller();
+    }
+
+    public function tearDown() {
+        parent::tearDown();
+
+        if ( isset( get_registered_settings()['mycustomarraysetting'] ) ) {
+            unregister_setting( 'somegroup', 'mycustomarraysetting' );
+        }
     }
 
@@ -650 +658 @@
     public function test_get_item_schema() {
     }
+
+    /**
+     * @ticket 42875
+     */
+    public function test_register_setting_issues_doing_it_wrong_when_show_in_rest_is_true() {
+        $this->setExpectedIncorrectUsage( 'register_setting' );
+
+        register_setting(
+            'somegroup',
+            'mycustomarraysetting',
+            array(
+                'type'         => 'array',
+                'show_in_rest' => true,
+            )
+        );
+    }
+
+    /**
+     * @ticket 42875
+     */
+    public function test_register_setting_issues_doing_it_wrong_when_show_in_rest_omits_schema() {
+        $this->setExpectedIncorrectUsage( 'register_setting' );
+
+        register_setting(
+            'somegroup',
+            'mycustomarraysetting',
+            array(
+                'type'         => 'array',
+                'show_in_rest' => array(
+                    'prepare_callback' => 'rest_sanitize_value_from_schema',
+                ),
+            )
+        );
+    }
+
+    /**
+     * @ticket 42875
+     */
+    public function test_register_setting_issues_doing_it_wrong_when_show_in_rest_omits_schema_items() {
+        $this->setExpectedIncorrectUsage( 'register_setting' );
+
+        register_setting(
+            'somegroup',
+            'mycustomarraysetting',
+            array(
+                'type'         => 'array',
+                'show_in_rest' => array(
+                    'schema' => array(
+                        'default' => array( 'Hi!' ),
+                    ),
+                ),
+            )
+        );
+    }
 }