Changeset 47325

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.

Location:

trunk

Files:

• src/wp-includes/option.php (modified) (2 diffs)
• tests/phpunit/tests/rest-api/rest-settings-controller.php (modified) (2 diffs)

trunk/src/wp-includes/option.php

@@ -2105 +2105 @@
  *     Data used to describe the setting when registered.
  *
- *     @type string   $type              The type of data associated with this setting.
- *                                       Valid values are 'string', 'boolean', 'integer', and 'number'.
- *     @type string   $description       A description of the data attached to this setting.
- *     @type callable $sanitize_callback A callback function that sanitizes the option's value.
- *     @type bool     $show_in_rest      Whether data associated with this setting should be included in the REST API.
- *     @type mixed    $default           Default value when calling `get_option()`.
+ *     @type string     $type              The type of data associated with this setting.
+ *                                         Valid values are 'string', 'boolean', 'integer', 'number', 'array', and 'object'.
+ *     @type string     $description       A description of the data attached to this setting.
+ *     @type callable   $sanitize_callback A callback function that sanitizes the option's value.
+ *     @type bool|array $show_in_rest      Whether data associated with this setting should be included in the REST API.
+ *                                         When registering complex settings, this argument may optionally be an
+ *                                         array with a 'schema' key.
+ *     @type mixed      $default           Default value when calling `get_option()`.
  * }
  */
@@ -2143 +2145 @@
         $args = apply_filters( 'register_setting_args', $args, $defaults, $option_group, $option_name );
         $args = wp_parse_args( $args, $defaults );
+
+        // Require an item schema when registering settings with an array type.
+        if ( false !== $args['show_in_rest'] && 'array' === $args['type'] && ( ! is_array( $args['show_in_rest'] ) || ! isset( $args['show_in_rest']['schema']['items'] ) ) ) {
+                _doing_it_wrong( __FUNCTION__, __( 'When registering an "array" setting to show in the REST API, you must specify the schema for each array item in "show_in_rest.schema.items".' ), '5.4.0' );
+        }
 
         if ( ! is_array( $wp_registered_settings ) ) {

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!' ),
+                                        ),
+                                ),
+                        )
+                );
+        }
 }