Changeset 34533

Timestamp:

09/25/2015 04:40:30 AM (11 years ago)

Author:

boonebgorges

Message:

Allow metadata to be attached to comment at time of creation.

The new $comment_meta parameter of wp_insert_comment() allows an array of
key/value pairs to be passed when creating a comment. These pairs are then
stored as commentmeta when the comment has been created.

Props tellyworth, wonderboymusic.
Fixes #12431.

Location:

trunk

Files:

• src/wp-includes/comment-functions.php (modified) (3 diffs)
• tests/phpunit/tests/comment.php (modified) (1 diff)

trunk/src/wp-includes/comment-functions.php

@@ -1378 +1378 @@
  *
  * @since 2.0.0
+ * @since 4.4.0 Introduced `$comment_meta` argument.
  *
  * @global wpdb $wpdb WordPress database abstraction object.
@@ -1402 +1403 @@
  *                                            Default empty.
  *     @type string     $comment_type         Comment type. Default empty.
+ *     @type array      $comment_meta         Optional. Array of key/value pairs to be stored in commentmeta for the
+ *                                            new comment.
  *     @type int        $user_id              ID of the user who submitted the comment. Default 0.
  * }
@@ -1439 +1442 @@
         }
         $comment = get_comment( $id );
+
+        // If metadata is provided, store it.
+        if ( isset( $commentdata['comment_meta'] ) && is_array( $commentdata['comment_meta'] ) ) {
+                foreach ( $commentdata['comment_meta'] as $meta_key => $meta_value ) {
+                        add_comment_meta( $comment->comment_ID, $meta_key, $meta_value, true );
+                }
+        }
 
         /**

trunk/tests/phpunit/tests/comment.php

@@ -274 +274 @@
                 $this->assertFalse( $sent );
         }
+
+        /**
+         * @ticket 12431
+         */
+        public function test_wp_new_comment_with_meta() {
+                $c = $this->factory->comment->create( array(
+                        'comment_approved' => '1',
+                        'comment_meta' => array(
+                                'food' => 'taco',
+                                'sauce' => 'fire'
+                        )
+                ) );
+
+                $this->assertEquals( 'fire', get_comment_meta( $c, 'sauce', true ) );
+        }
 }