Refine the handling of mids and the metadata hooks.

Author: johnbillion

src/wp-includes/meta.php

@@ -196,9 +196,9 @@ function add_metadata( $meta_type, $object_id, $meta_key, $meta_value, $unique =
  *
  * [X] change this function so it returns the array of mids instead of true
  * [ ] reinstate slashed data handling
- * [ ] need to account for the return value of "add_{$meta_type}_metadata" for each key
- * [ ] need tests to cover when the "add_{$meta_type}_metadata" filter returns a value for a key
- * [ ] confirm that the method of getting the mids via `range()` is reliable
+ * [X] need to account for the return value of "add_{$meta_type}_metadata" for each key
+ * [X] need tests to cover when the "add_{$meta_type}_metadata" filter returns a value for a key
+ * [X] confirm that the method of getting the mids via `range()` is reliable
  *
  * @since x.y.z
  *
@@ -274,20 +274,20 @@ function bulk_add_metadata( string $meta_type, $object_id, array $meta_fields )
 		return false;
 	}
 
-	$first_mid = (int) $wpdb->insert_id;
-	$all_mids  = range( $first_mid, $first_mid + count( $data ) - 1 );
-
-	$i = 0;
+	$first_mid     = (int) $wpdb->insert_id;
+	$inserted_mids = range( $first_mid, $first_mid + $inserted - 1 );
+	$keyed_mids    = array_combine( array_column( $data, 1 ), $inserted_mids );
+	$all_mids      = array_merge( $return, $keyed_mids );
 
 	wp_cache_delete( $object_id, $meta_type . '_meta' );
 
-	foreach ( $meta_fields as $meta_key => $meta_value ) {
+	foreach ( $data as $datum ) {
+		list( $object_id, $meta_key, $meta_value ) = $datum;
 		/** This action is documented in wp-includes/meta.php */
-		do_action( "added_{$meta_type}_meta", $all_mids[ $i ], $object_id, $meta_key, $meta_value );
-		$i++;
+		do_action( "added_{$meta_type}_meta", $all_mids[ $meta_key ], $object_id, $meta_key, $meta_value );
 	}
 
-	return true;
+	return $all_mids;
 }
 
 /**

tests/phpunit/tests/meta/bulkAddMetadata.php

@@ -0,0 +1,86 @@
+<?php
+
+/**
+ * @group meta
+ */
+class Tests_Meta_BulkAddMetadata extends WP_UnitTestCase {
+
+	public function test_all_meta_fields_should_be_added() {
+		global $wpdb;
+
+		$post_id = self::factory()->post->create();
+		$meta = array(
+			'key1' => '1',
+			'key2' => '2',
+			'key3' => '3',
+		);
+		$latest_mid = (int) $wpdb->get_var( "SELECT MAX( meta_id ) FROM {$wpdb->postmeta}" );
+		$filters = did_filter( 'add_post_metadata' );
+		$actions = did_action( 'added_post_meta' );
+
+		$result = bulk_add_metadata( 'post', $post_id, $meta );
+
+		$actual_vals = array(
+			'key1' => get_post_meta( $post_id, 'key1', true ),
+			'key2' => get_post_meta( $post_id, 'key2', true ),
+			'key3' => get_post_meta( $post_id, 'key3', true ),
+		);
+		$expected_vals = $meta;
+		$expected_mids = array(
+			'key1' => ( $latest_mid + 1 ),
+			'key2' => ( $latest_mid + 2 ),
+			'key3' => ( $latest_mid + 3 ),
+		);
+
+		$this->assertSame( $expected_vals, $actual_vals );
+		$this->assertSame( $expected_mids, $result );
+		$this->assertSame( $filters + 3, did_filter( 'add_post_metadata' ) );
+		$this->assertSame( $actions + 3, did_action( 'added_post_meta' ) );
+	}
+
+	public function test_correct_mids_should_be_returned_when_filter_is_in_place() {
+		global $wpdb;
+
+		add_filter( 'add_post_metadata', function( $check, $object_id, $meta_key ) {
+			if ( 'key2' === $meta_key ) {
+				return 123456;
+			}
+
+			return $check;
+		}, 10, 3 );
+
+		$post_id = self::factory()->post->create();
+		$meta = array(
+			'key1' => '1',
+			'key2' => '2',
+			'key3' => '3',
+		);
+		$latest_mid = (int) $wpdb->get_var( "SELECT MAX( meta_id ) FROM {$wpdb->postmeta}" );
+		$filters = did_filter( 'add_post_metadata' );
+		$actions = did_action( 'added_post_meta' );
+
+		$result = bulk_add_metadata( 'post', $post_id, $meta );
+
+		$expected_vals = array(
+			'key1' => '1',
+			'key2' => '',
+			'key3' => '3',
+		);
+		$actual_vals = array(
+			'key1' => get_post_meta( $post_id, 'key1', true ),
+			'key2' => get_post_meta( $post_id, 'key2', true ),
+			'key3' => get_post_meta( $post_id, 'key3', true ),
+		);
+		$expected_mids = array(
+			'key2' => 123456,
+			'key1' => ( $latest_mid + 1 ),
+			'key3' => ( $latest_mid + 2 ),
+		);
+
+		$this->assertSame( $expected_vals, $actual_vals );
+		$this->assertSame( $expected_mids, $result );
+		$this->assertSame( $filters + 3, did_filter( 'add_post_metadata' ) );
+		$this->assertSame( $actions + 2, did_action( 'added_post_meta' ) );
+	}
+
+}