Changeset 39337

Timestamp:

11/21/2016 10:55:33 PM (7 years ago)

Author:

rachelbaker

Message:

REST API: Set the comment type to a readonly property in the schema.

Document the type property as readonly and remove the default value. After #38820 it is no longer possible to set the type property on a comment to anything a custom type.

Props jnylen0, rachelbaker.
Fixes #38886.

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php (modified) (3 diffs)
• tests/phpunit/tests/rest-api/rest-comments-controller.php (modified) (1 diff)

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

@@ -459 +459 @@
         }
 
-        $prepared_comment = $this->prepare_item_for_database( $request );
-
-        if ( is_wp_error( $prepared_comment ) ) {
-            return $prepared_comment;
-        }
-
         // Do not allow comments to be created with a non-default type.
         if ( ! empty( $request['type'] ) && 'comment' !== $request['type'] ) {
             return new WP_Error( 'rest_invalid_comment_type', __( 'Cannot create a comment with that type.' ), array( 'status' => 400 ) );
         }
+
+        $prepared_comment = $this->prepare_item_for_database( $request );
+        if ( is_wp_error( $prepared_comment ) ) {
+            return $prepared_comment;
+        }
+
+        $prepared_comment['comment_type'] = '';
 
         /*
@@ -1088 +1089 @@
         } elseif ( $request->get_header( 'user_agent' ) ) {
             $prepared_comment['comment_agent'] = $request->get_header( 'user_agent' );
-        }
-
-        if ( isset( $request['type'] ) ) {
-            // Comment type "comment" needs to be created as an empty string.
-            $prepared_comment['comment_type'] = 'comment' === $request['type'] ? '' : $request['type'];
         }
 
@@ -1245 +1241 @@
                     'type'         => 'string',
                     'context'      => array( 'view', 'edit', 'embed' ),
-                    'default'      => 'comment',
-                    'arg_options'  => array(
-                        'sanitize_callback' => 'sanitize_key',
-                    ),
+                    'readonly'     => true,
                 ),
             ),

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

@@ -2331 +2331 @@
         $this->assertArrayHasKey( 'status', $properties );
         $this->assertArrayHasKey( 'type', $properties );
-        $this->assertEquals( 'comment', $properties['type']['default'] );
 
         $this->assertEquals( 0, $properties['parent']['default'] );
         $this->assertEquals( 0, $properties['post']['default'] );
+
+        $this->assertEquals( true, $properties['link']['readonly'] );
+        $this->assertEquals( true, $properties['type']['readonly'] );
     }