Changeset 39058

Timestamp:

10/31/2016 04:06:54 PM (9 years ago)

Author:

joehoyle

Message:

REST API: Add support for "integer" type for meta and options

Previously Settings only supported "number" which meant it was possible to push floats to things like posts_per_page. This means now developers can also specify type => ineger in meta nad settings resgration.

Props flixos90.
Fixes #38393.

Location:

trunk

Files:

• src/wp-includes/option.php (modified) (3 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php (modified) (2 diffs)
• src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-settings-controller.php (modified) (1 diff)

trunk/src/wp-includes/option.php

@@ -1782 +1782 @@
     register_setting( 'general', 'start_of_week', array(
         'show_in_rest' => true,
-        'type'         => 'number',
+        'type'         => 'integer',
         'description'  => __( 'A day number of the week that the week should start on.' ),
     ) );
@@ -1804 +1804 @@
     register_setting( 'writing', 'default_category', array(
         'show_in_rest' => true,
-        'type'         => 'number',
+        'type'         => 'integer',
         'description'  => __( 'Default category.' ),
     ) );
@@ -1816 +1816 @@
     register_setting( 'reading', 'posts_per_page', array(
         'show_in_rest' => true,
-        'type'         => 'number',
+        'type'         => 'integer',
         'description'  => __( 'Blog pages show at most.' ),
         'default'      => 10,

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

@@ -133 +133 @@
             case 'string':
                 return (string) $value;
+            case 'integer':
+                return (int) $value;
             case 'number':
                 return (float) $value;
@@ -259 +261 @@
              * to be updated with arbitrary values that we can't do decent sanitizing for.
              */
-            if ( ! in_array( $rest_args['schema']['type'], array( 'number', 'string', 'boolean' ), true ) ) {
+            if ( ! in_array( $rest_args['schema']['type'], array( 'number', 'integer', 'string', 'boolean' ), true ) ) {
                 continue;
             }

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

@@ -405 +405 @@
                 $value = (string) $value;
                 break;
+            case 'integer':
+                $value = (int) $value;
+                break;
             case 'number':
                 $value = (float) $value;

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

@@ -268 +268 @@
     }
 
+    public function test_update_item_with_integer() {
+        wp_set_current_user( self::$administrator );
+        $request = new WP_REST_Request( 'PUT', '/wp/v2/settings' );
+        $request->set_param( 'posts_per_page', 11 );
+        $response = $this->server->dispatch( $request );
+        $this->assertEquals( 200, $response->get_status() );
+    }
+
+    public function test_update_item_with_invalid_float_for_integer() {
+        wp_set_current_user( self::$administrator );
+        $request = new WP_REST_Request( 'PUT', '/wp/v2/settings' );
+        $request->set_param( 'posts_per_page', 10.5 );
+        $response = $this->server->dispatch( $request );
+        $this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
+    }
+
     /**
      * Setting an item to "null" will essentially restore it to it's default value.