#59269 Add support for adding metadata in bulk

src/wp-includes/class-wpdb.php

@@ -535,6 +535,7 @@ class wpdb {
 	 *
 	 * @see wpdb::prepare()
 	 * @see wpdb::insert()
+	 * @see wpdb::insert_multiple()
 	 * @see wpdb::update()
 	 * @see wpdb::delete()
 	 * @see wp_set_wpdb_vars()
@@ -2492,7 +2493,7 @@ public function remove_placeholder_escape( $query ) {
 	 *                                Both `$data` columns and `$data` values should be "raw" (neither should be SQL escaped).
 	 *                                Sending a null value will cause the column to be set to NULL - the corresponding
 	 *                                format is ignored in this case.
-	 * @param string[]|string $format Optional. An array of formats to be mapped to each of the value in `$data`.
+	 * @param string[]|string $format Optional. An array of formats to be mapped to each of the values in `$data`.
 	 *                                If string, that format will be used for all of the values in `$data`.
 	 *                                A format is one of '%d', '%f', '%s' (integer, float, string).
 	 *                                If omitted, all values in `$data` will be treated as strings unless otherwise
@@ -2503,6 +2504,110 @@ public function insert( $table, $data, $format = null ) {
 		return $this->_insert_replace_helper( $table, $data, $format, 'INSERT' );
 	}
 
+	/**
+	 * Inserts multiple rows into the table in one query.
+	 *
+	 * If the insert fails, no rows will be inserted. It's not possible for some rows
+	 * to be inserted and not others.
+	 *
+	 * Examples:
+	 *
+	 *     $wpdb->insert_multiple(
+	 *         'table',
+	 *         array(
+	 *             'column1',
+	 *             'column2',
+	 *         ),
+	 *         array(
+	 *             array(
+	 *                 'column 1 value 1',
+	 *                 'column 2 value 1',
+	 *             ),
+	 *             array(
+	 *                 'column 1 value 2',
+	 *                 'column 2 value 2',
+	 *             ),
+	 *             array(
+	 *                 'column 1 value 3',
+	 *                 'column 2 value 3',
+	 *             ),
+	 *         )
+	 *     );
+	 *     $wpdb->insert_multiple(
+	 *         'table',
+	 *         array(
+	 *             'column1',
+	 *             'column2',
+	 *         ),
+	 *         array(
+	 *             array(
+	 *                 'column 1 value 1',
+	 *                 1,
+	 *             ),
+	 *             array(
+	 *                 'column 1 value 2',
+	 *                 2,
+	 *             ),
+	 *             array(
+	 *                 'column 1 value 3',
+	 *                 3,
+	 *             ),
+	 *         ),
+	 *         array(
+	 *             '%s',
+	 *             '%d',
+	 *         )
+	 *     );
+	 *
+	 * @since x.y.z
+	 *
+	 * @param string   $table   Table name.
+	 * @param string[] $columns Array of column names.
+	 * @param array    $rows    Array of rows of values to insert. Values should be "raw" (should not be SQL escaped).
+	 *                          Sending a null value will cause the column to be set to NULL - the corresponding
+	 *                          format is ignored in this case.
+	 * @param string[] $format  Optional. An array of formats to be mapped to each of the values in each row.
+	 *                          A format is one of '%d', '%f', '%s' (integer, float, string).
+	 *                          If omitted, all values in `$rows` will be treated as strings unless otherwise
+	 *                          specified in wpdb::$field_types. Default empty array.
+	 * @return int|false The number of rows inserted, or false on error.
+	 */
+	public function insert_multiple( string $table, array $columns, array $rows, array $format = array() ) {
+		$this->insert_id = 0;
+
+		$values_sql = array();
+		$values     = array(
+			$table,
+		);
+
+		foreach ( $rows as $row ) {
+			$data = $this->process_fields( $table, array_combine( $columns, $row ), $format );
+			if ( false === $data ) {
+				return false;
+			}
+
+			$formats = array();
+			foreach ( $data as $value ) {
+				if ( is_null( $value['value'] ) ) {
+					$formats[] = 'NULL';
+					continue;
+				}
+
+				$formats[] = $value['format'];
+				$values[]  = $value['value'];
+			}
+
+			$values_sql[] = '(' . implode( ', ', $formats ) . ')';
+		}
+
+		$all_formats = implode( ', ', $values_sql );
+		$fields      = implode( '`, `', $columns );
+		$sql         = "INSERT INTO %i (`$fields`) VALUES $all_formats";
+
+		$this->check_current_query = false;
+		return $this->query( $this->prepare( $sql, $values ) );
+	}
+
 	/**
 	 * Replaces a row in the table or inserts it if it does not exist, based on a PRIMARY KEY or a UNIQUE index.
 	 *

src/wp-includes/comment.php

@@ -472,6 +472,34 @@ function add_comment_meta( $comment_id, $meta_key, $meta_value, $unique = false
 	return add_metadata( 'comment', $comment_id, $meta_key, $meta_value, $unique );
 }
 
+/**
+ * Adds multiple items of meta data to a comment.
+ *
+ * This function is more performant than calling `add_comment_meta()` multiple times because it queries the database
+ * only once and clears the meta cache only once.
+ *
+ * Examples:
+ *
+ *     bulk_add_comment_meta(
+ *         $comment->comment_ID,
+ *         array(
+ *             'meta_key_1' => 'value_1',
+ *             'meta_key_2' => 'value_2',
+ *         )
+ *     );
+ *
+ * For historical reasons both the meta key and the meta value are expected to be "slashed" (slashes escaped) on input.
+ *
+ * @since x.y.z
+ *
+ * @param int                 $comment_id  Comment ID.
+ * @param array<string,mixed> $meta_fields Metadata values keyed by their meta key. Values must be serializable if non-scalar.
+ * @return array<string,int>|false Array of meta IDs keyed by their meta key on success, false on failure.
+ */
+function bulk_add_comment_meta( int $comment_id, array $meta_fields ) {
+	return bulk_add_metadata( 'comment', $comment_id, $meta_fields );
+}
+
 /**
  * Removes metadata matching criteria from a comment.
  *
@@ -2160,9 +2188,7 @@ function wp_insert_comment( $commentdata ) {
 
 	// 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 );
-		}
+		bulk_add_comment_meta( $comment->comment_ID, $commentdata['comment_meta'] );
 	}
 
 	/**

src/wp-includes/meta.php

@@ -170,6 +170,123 @@ function add_metadata( $meta_type, $object_id, $meta_key, $meta_value, $unique =
 	return $mid;
 }
 
+/**
+ * Adds multiple items of metadata for the specified object.
+ *
+ * This function is more performant than calling `add_metadata()` multiple times because it queries the database only
+ * once and clears the meta cache only once.
+ *
+ * This function will always insert all of the provided metadata even if matching keys already exist. This behaviour
+ * matches that of add_metadata() when its `$unique` parameter is set to false.
+ *
+ * If the insert fails, no metadata will be inserted. It's not possible for a subset of the rows to be inserted.
+ *
+ * Examples:
+ *
+ *     bulk_add_metadata(
+ *         'post',
+ *         $post_id,
+ *         array(
+ *             'meta_key_1' => 'value_1',
+ *             'meta_key_2' => 'value_2',
+ *         )
+ *     );
+ *
+ * For historical reasons both the meta key and the meta value are expected to be "slashed" (slashes escaped) on input.
+ *
+ * @since x.y.z
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param string              $meta_type   Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user',
+ *                                         'blog', or any other object type with an associated meta table.
+ * @param int                 $object_id   ID of the object metadata is for.
+ * @param array<string,mixed> $meta_fields Metadata values keyed by their meta key. Values must be serializable if non-scalar.
+ * @return array<string,int>|false Array of meta IDs keyed by their meta key on success, false on failure.
+ */
+function bulk_add_metadata( string $meta_type, int $object_id, array $meta_fields ) {
+	global $wpdb;
+
+	if ( ! $meta_type || ! $meta_fields ) {
+		return false;
+	}
+
+	$object_id = absint( $object_id );
+	if ( ! $object_id ) {
+		return false;
+	}
+
+	$table = _get_meta_table( $meta_type );
+	if ( ! $table ) {
+		return false;
+	}
+
+	$meta_subtype = get_object_subtype( $meta_type, $object_id );
+	$column       = sanitize_key( $meta_type . '_id' );
+	$data         = array();
+	$return       = array();
+	$added_keys   = array();
+
+	foreach ( $meta_fields as $meta_key => $meta_value ) {
+		// expected_slashed ($meta_key, $meta_value)
+		$meta_key   = wp_unslash( $meta_key );
+		$meta_value = wp_unslash( $meta_value );
+		$meta_value = sanitize_meta( $meta_key, $meta_value, $meta_type, $meta_subtype );
+
+		/** This filter is documented in wp-includes/meta.php */
+		$check = apply_filters( "add_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, false );
+		if ( null !== $check ) {
+			$return[ $meta_key ] = $check;
+			continue;
+		}
+
+		/** This action is documented in wp-includes/meta.php */
+		do_action( "add_{$meta_type}_meta", $object_id, $meta_key, $meta_value );
+
+		$added_keys[] = $meta_key;
+
+		$data[] = array(
+			$object_id,
+			$meta_key,
+			maybe_serialize( $meta_value ),
+		);
+	}
+
+	// If there is no data to save, don't attempt to save it.
+	if ( ! $data ) {
+		return $return;
+	}
+
+	$inserted = $wpdb->insert_multiple(
+		$table,
+		array(
+			$column,
+			'meta_key',
+			'meta_value',
+		),
+		$data
+	);
+
+	if ( ! $inserted ) {
+		return false;
+	}
+
+	$first_mid     = (int) $wpdb->insert_id;
+	$inserted_mids = range( $first_mid, $first_mid + $inserted - 1 );
+	$keyed_mids    = array_combine( $added_keys, $inserted_mids );
+	$all_mids      = array_merge( $return, $keyed_mids );
+
+	wp_cache_delete( $object_id, $meta_type . '_meta' );
+
+	foreach ( $data as $datum ) {
+		list( $row_object_id, $meta_key, $meta_value ) = $datum;
+		/** This action is documented in wp-includes/meta.php */
+		do_action( "added_{$meta_type}_meta", $all_mids[ $meta_key ], $row_object_id, $meta_key, $meta_value );
+	}
+
+	return $all_mids;
+}
+
 /**
  * Updates metadata for the specified object. If no value already exists for the specified object
  * ID and metadata key, the metadata will be added.

src/wp-includes/ms-site.php

@@ -1043,6 +1043,34 @@ function add_site_meta( $site_id, $meta_key, $meta_value, $unique = false ) {
 	return add_metadata( 'blog', $site_id, $meta_key, $meta_value, $unique );
 }
 
+/**
+ * Adds multiple items of meta data to a site.
+ *
+ * This function is more performant than calling `add_site_meta()` multiple times because it queries the database
+ * only once and clears the meta cache only once.
+ *
+ * Examples:
+ *
+ *     bulk_add_site_meta(
+ *         $site_id,
+ *         array(
+ *             'meta_key_1' => 'value_1',
+ *             'meta_key_2' => 'value_2',
+ *         )
+ *     );
+ *
+ * For historical reasons both the meta key and the meta value are expected to be "slashed" (slashes escaped) on input.
+ *
+ * @since x.y.z
+ *
+ * @param int                 $site_id     Site ID.
+ * @param array<string,mixed> $meta_fields Metadata values keyed by their meta key. Values must be serializable if non-scalar.
+ * @return array<string,int>|false Array of meta IDs keyed by their meta key on success, false on failure.
+ */
+function bulk_add_site_meta( int $site_id, array $meta_fields ) {
+	return bulk_add_metadata( 'blog', $site_id, $meta_fields );
+}
+
 /**
  * Removes metadata matching criteria from a site.
  *

src/wp-includes/post.php

@@ -2658,6 +2658,34 @@ function add_post_meta( $post_id, $meta_key, $meta_value, $unique = false ) {
 	return add_metadata( 'post', $post_id, $meta_key, $meta_value, $unique );
 }
 
+/**
+ * Adds multiple items of meta data to a post.
+ *
+ * This function is more performant than calling `add_post_meta()` multiple times because it queries the database
+ * only once and clears the meta cache only once.
+ *
+ * Examples:
+ *
+ *     bulk_add_post_meta(
+ *         $post->ID,
+ *         array(
+ *             'meta_key_1' => 'value_1',
+ *             'meta_key_2' => 'value_2',
+ *         )
+ *     );
+ *
+ * For historical reasons both the meta key and the meta value are expected to be "slashed" (slashes escaped) on input.
+ *
+ * @since x.y.z
+ *
+ * @param int                 $post_id     Post ID.
+ * @param array<string,mixed> $meta_fields Metadata values keyed by their meta key. Values must be serializable if non-scalar.
+ * @return array<string,int>|false Array of meta IDs keyed by their meta key on success, false on failure.
+ */
+function bulk_add_post_meta( int $post_id, array $meta_fields ) {
+	return bulk_add_metadata( 'post', $post_id, $meta_fields );
+}
+
 /**
  * Deletes a post meta field for the given post ID.
  *
@@ -5018,8 +5046,12 @@ function wp_insert_post( $postarr, $wp_error = false, $fire_after_hooks = true )
 	}
 
 	if ( ! empty( $postarr['meta_input'] ) ) {
-		foreach ( $postarr['meta_input'] as $field => $value ) {
-			update_post_meta( $post_id, $field, $value );
+		if ( $update ) {
+			foreach ( $postarr['meta_input'] as $field => $value ) {
+				update_post_meta( $post_id, $field, $value );
+			}
+		} else {
+			bulk_add_post_meta( $post_id, $postarr['meta_input'] );
 		}
 	}