Changeset 38864

Timestamp:

10/21/2016 06:27:18 PM (9 years ago)

Author:

rachelbaker

Message:

REST API: Allow comments to be created setting the user_agent parameter.

As of WordPress 4.3 the wp_new_comment() function has been updated to allow the comment_agent value to be set when a comment is created. The comments API endpoint now allows the comment author's user agent to be set when creating a comment.
Also, the readonly property on the author_user_agent parameter in the schema was removed.

Props rabmalin for the initial patch.
Fixes #38425.

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) (3 diffs)

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

@@ -420 +420 @@
         }
 
-        $prepared_comment['comment_agent'] = '';
+        if ( ! isset( $prepared_comment['comment_agent'] ) ) {
+            $prepared_comment['comment_agent'] = '';
+        }
+
         $prepared_comment['comment_approved'] = wp_allow_comment( $prepared_comment, true );
 
@@ -889 +892 @@
         }
 
+        if ( isset( $request['author_user_agent'] ) ) {
+            $prepared_comment['comment_agent'] = $request['author_user_agent'];
+        }
+
         if ( isset( $request['type'] ) ) {
             // Comment type "comment" needs to be created as an empty string.
@@ -976 +983 @@
                     'type'         => 'string',
                     'context'      => array( 'edit' ),
-                    'readonly'     => true,
+                    'arg_options'  => array(
+                        'sanitize_callback' => 'sanitize_text_field',
+                    ),
                 ),
                 'content'          => array(

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

@@ -1065 +1065 @@
     }
 
-    public function test_create_comment_with_status_and_IP() {
+    public function test_create_comment_with_status_IP_and_user_agent() {
         $post_id = $this->factory->post->create();
         wp_set_current_user( $this->admin_id );
@@ -1075 +1075 @@
             'author_ip'    => '139.130.4.5',
             'author_url'   => 'http://androidsdungeon.com',
+            'author_user_agent' => 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36',
             'content'      => 'Worst Comment Ever!',
             'status'       => 'approved',
@@ -1089 +1090 @@
         $this->assertEquals( 'approved', $data['status'] );
         $this->assertEquals( '139.130.4.5', $data['author_ip'] );
+        $this->assertEquals( 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36', $data['author_user_agent'] );
     }