Add/rest api for block commenting

lib/compat/wordpress-6.7/rest-api.php

@@ -114,3 +114,62 @@ function gutenberg_override_default_rest_server() {
 	return 'Gutenberg_REST_Server';
 }
 add_filter( 'wp_rest_server_class', 'gutenberg_override_default_rest_server', 1 );
+
+/**
+ * Updates the comment type in the REST API for WordPress version 6.7.
+ *
+ * This function is used as a filter callback for the 'rest_pre_insert_comment' hook.
+ * It checks if the 'comment_type' parameter is set to 'block_comment' in the REST API request,
+ * and if so, updates the 'comment_type' and 'comment_approved' properties of the prepared comment.
+ *
+ * @param array $prepared_comment The prepared comment data.
+ * @param WP_REST_Request $request The REST API request object.
+ * @return array The updated prepared comment data.
+ */
+if ( ! function_exists( 'update_comment_type_in_rest_api_6_7' ) && gutenberg_is_experiment_enabled( 'gutenberg-block-comment' ) ) {
+	function update_comment_type_in_rest_api_6_7( $prepared_comment, $request ) {
+		if ( ! empty( $request['comment_type'] ) && 'block_comment' === $request['comment_type'] ) {
+			$prepared_comment['comment_type']     = $request['comment_type'];
+			$prepared_comment['comment_approved'] = $request['comment_approved'];
+		}
+
+		return $prepared_comment;
+	}
+	add_filter( 'rest_pre_insert_comment', 'update_comment_type_in_rest_api_6_7', 10, 2 );
+}
+
+/**
+ * Updates the comment type for avatars in the WordPress REST API.
+ *
+ * This function adds the 'block_comment' type to the list of comment types
+ * for which avatars should be retrieved in the WordPress REST API.
+ *
+ * @param array $comment_type The array of comment types.
+ * @return array The updated array of comment types.
+ */
+if ( ! function_exists( 'update_get_avatar_comment_type' ) && gutenberg_is_experiment_enabled( 'gutenberg-block-comment' ) ) {
+	function update_get_avatar_comment_type( $comment_type ) {
+		$comment_type[] = 'block_comment';
+		return $comment_type;
+	}
+	add_filter( 'get_avatar_comment_types', 'update_get_avatar_comment_type', 10, 1 );
+}
+
+/**
+ * Updates the comment type filter dropdown options.
+ *
+ * This function is only defined if the 'gutenberg-block-comment' experiment is enabled and the 'update_comment_type_filter_dropdown' function does not already exist.
+ * It returns an array of comment type options for the comment type filter dropdown in the admin area.
+ *
+ * @return array An associative array of comment type options.
+ * The keys are the comment type slugs and the values are the translated names of the comment types.
+ */
+if ( ! function_exists( 'update_comment_type_filter_dropdown' ) && gutenberg_is_experiment_enabled( 'gutenberg-block-comment' ) ) {
+	function update_comment_type_filter_dropdown() {
+		return array(
+			'comment'       => __( 'Comments' ),
+			'block_comment' => __( 'Block Comments' ),
+		);
+	}
+	add_filter( 'admin_comment_types_dropdown', 'update_comment_type_filter_dropdown' );
+}

lib/experimental/editor-settings.php

@@ -28,6 +28,9 @@ function gutenberg_enable_experiments() {
 	if ( gutenberg_is_experiment_enabled( 'gutenberg-full-page-client-side-navigation' ) ) {
 		wp_add_inline_script( 'wp-block-library', 'window.__experimentalFullPageClientSideNavigation = true', 'before' );
 	}
+	if ( $gutenberg_experiments && array_key_exists( 'gutenberg-block-comment', $gutenberg_experiments ) ) {
+		wp_add_inline_script( 'wp-block-editor', 'window.__experimentalEnableBlockComment = true', 'before' );
+	}
 	if ( $gutenberg_experiments && array_key_exists( 'gutenberg-quick-edit-dataviews', $gutenberg_experiments ) ) {
 		wp_add_inline_script( 'wp-block-editor', 'window.__experimentalQuickEditDataViews = true', 'before' );
 	}

lib/experiments-page.php

@@ -163,6 +163,18 @@ function gutenberg_initialize_experiments_settings() {
 		)
 	);
 
+	add_settings_field(
+		'gutenberg-block-comment',
+		__( 'Block Comments', 'gutenberg' ),
+		'gutenberg_display_experiment_field',
+		'gutenberg-experiments',
+		'gutenberg_experiments_section',
+		array(
+			'label' => __( 'Enable multi-user commenting on blocks in post editor', 'gutenberg' ),
+			'id'    => 'gutenberg-block-comment',
+		)
+	);
+
 	add_settings_field(
 		'gutenberg-media-processing',
 		__( 'Client-side media processing', 'gutenberg' ),

phpunit/bootstrap.php

@@ -97,6 +97,7 @@ function fail_if_died( $message ) {
 		'gutenberg-form-blocks'        => 1,
 		'gutenberg-block-experiments'  => 1,
 		'gutenberg-media-processing'   => 1,
+		'gutenberg-block-comment'      => 1,
 	),
 );
 

phpunit/class-block-comment-filter-test.php

@@ -0,0 +1,61 @@
+<?php
+
+/**
+ * This class contains unit tests for the block comment filter functions.
+ *
+ * @package Gutenberg
+ */
+class Tests_blockCommentFilter extends WP_UnitTestCase {
+
+	/**
+	 * Tests that `update_comment_type_in_rest_api_6_7` updates comment type correctly.
+	 */
+	public function test_update_comment_type_in_rest_api_6_7() {
+		// Mock request and prepared comment
+		$request = new WP_REST_Request( WP_REST_Server::READABLE );
+		$request->set_param( 'comment_type', 'block_comment' );
+		$request->set_param( 'comment_approved', '1' );
+
+		$prepared_comment = array(
+			'comment_type'     => '',
+			'comment_approved' => '0',
+		);
+
+		// Call the function
+		$updated_comment = update_comment_type_in_rest_api_6_7( $prepared_comment, $request );
+
+		// Assertions
+		$this->assertEquals( 'block_comment', $updated_comment['comment_type'] );
+		$this->assertEquals( '1', $updated_comment['comment_approved'] );
+	}
+
+	/**
+	 * Tests that `update_comment_type_filter_dropdown` returns the correct options.
+	 */
+	public function test_update_get_avatar_comment_type() {
+
+		// Mock comment types
+		$comment_types = array( 'comment', 'pingback' );
+
+		// Call the function
+		$updated_comment_types = update_get_avatar_comment_type( $comment_types );
+
+		// Assertions
+		$this->assertContains( 'block_comment', $updated_comment_types );
+	}
+
+	/**
+	 * Tests that `update_comment_type_filter_dropdown` returns the correct options.
+	*/
+	public function test_update_comment_type_filter_dropdown() {
+
+		// Call the function
+		$dropdown_options = update_comment_type_filter_dropdown();
+
+		// Assertions
+		$this->assertArrayHasKey( 'comment', $dropdown_options );
+		$this->assertArrayHasKey( 'block_comment', $dropdown_options );
+		$this->assertEquals( 'Comments', $dropdown_options['comment'] );
+		$this->assertEquals( 'Block Comments', $dropdown_options['block_comment'] );
+	}
+}