Changeset 54131 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php

Timestamp:

09/11/2022 11:28:39 PM (4 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Add support for settings to specify their own additionalProperties.

This switches the Settings Controller to use rest_default_additional_properties_to_false and deprecates its own method.

Props anna.bansaghi.
Fixes #56493.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php (modified) (3 diffs)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php

@@ -259 +259 @@
                         }
 
-                        $rest_args['schema'] = $this->set_additional_properties_to_false( $rest_args['schema'] );
+                        $rest_args['schema'] = rest_default_additional_properties_to_false( $rest_args['schema'] );
 
                         $rest_options[ $rest_args['name'] ] = $rest_args;
@@ -323 +323 @@
 
         /**
-         * Recursively add additionalProperties = false to all objects in a schema.
-         *
-         * This is need to restrict properties of objects in settings values to only
+         * Recursively add additionalProperties = false to all objects in a schema
+         * if no additionalProperties setting is specified.
+         *
+         * This is needed to restrict properties of objects in settings values to only
          * registered items, as the REST API will allow additional properties by
          * default.
          *
          * @since 4.9.0
+         * @deprecated 6.1.0 Use {@see rest_default_additional_properties_to_false()} instead.
          *
          * @param array $schema The schema array.
@@ -335 +337 @@
          */
         protected function set_additional_properties_to_false( $schema ) {
-                switch ( $schema['type'] ) {
-                        case 'object':
-                                foreach ( $schema['properties'] as $key => $child_schema ) {
-                                        $schema['properties'][ $key ] = $this->set_additional_properties_to_false( $child_schema );
-                                }
-
-                                $schema['additionalProperties'] = false;
-                                break;
-                        case 'array':
-                                $schema['items'] = $this->set_additional_properties_to_false( $schema['items'] );
-                                break;
-                }
-
-                return $schema;
+                _deprecated_function( __METHOD__, '6.1.0', 'rest_default_additional_properties_to_false()' );
+
+                return rest_default_additional_properties_to_false( $schema );
         }
 }