Site Editor: Add new Comments Query Loop block

lib/blocks.php

@@ -21,6 +21,7 @@ function gutenberg_reregister_core_block_types() {
 				'code',
 				'column',
 				'columns',
+				'comments-query-loop',
 				'cover',
 				'gallery',
 				'group',
@@ -80,6 +81,7 @@ function gutenberg_reregister_core_block_types() {
 				'post-comments-count.php'        => 'core/post-comments-count',
 				'post-comments-form.php'         => 'core/post-comments-form',
 				'post-comments-link.php'         => 'core/post-comments-link',
+				'comment-template.php'           => 'core/comment-template',
 				'post-content.php'               => 'core/post-content',
 				'post-date.php'                  => 'core/post-date',
 				'post-excerpt.php'               => 'core/post-excerpt',

packages/block-library/src/comment-template/block.json

@@ -0,0 +1,15 @@
+{
+	"apiVersion": 2,
+	"name": "core/comment-template",
+	"title": "Comment Template",
+	"category": "design",
+	"parent": [ "core/comments-query-loop" ],
+	"description": "Contains the block elements used to render a comment, like the title, date, author, avatar and more.",
+	"textdomain": "default",
+	"usesContext": [ "queryId", "queryPerPage", "postId" ],
+	"supports": {
+		"reusable": false,
+		"html": false,
+		"align": true
+	}
+}

packages/block-library/src/comment-template/edit.js

@@ -0,0 +1,93 @@
+/**
+ * WordPress dependencies
+ */
+import { useState, useMemo } from '@wordpress/element';
+import { useSelect } from '@wordpress/data';
+import { __ } from '@wordpress/i18n';
+import {
+	BlockContextProvider,
+	BlockPreview,
+	useBlockProps,
+	__experimentalUseInnerBlocksProps as useInnerBlocksProps,
+	store as blockEditorStore,
+} from '@wordpress/block-editor';
+import { Spinner } from '@wordpress/components';
+import { store as coreStore } from '@wordpress/core-data';
+
+const TEMPLATE = [
+	[ 'core/post-comment-author' ],
+	[ 'core/post-comment-date' ],
+	[ 'core/post-comment-content' ],
+];
+
+export default function CommentTemplateEdit( {
+	clientId,
+	context: { postId, queryPerPage },
+} ) {
+	const innerBlocksProps = useInnerBlocksProps( {}, { template: TEMPLATE } );
+	const blockProps = useBlockProps();
+
+	const [ activeBlockContext, setActiveBlockContext ] = useState();
+
+	const { comments, blocks } = useSelect(
+		( select ) => {
+			const { getEntityRecords } = select( coreStore );
+			const { getBlocks } = select( blockEditorStore );
+
+			return {
+				comments: getEntityRecords( 'root', 'comment', {
+					post: postId,
+					status: 'approve',
+					per_page: queryPerPage,
+					order: 'asc',
+				} ),
+				blocks: getBlocks( clientId ),
+			};
+		},
+		[ queryPerPage, postId, clientId ]
+	);
+
+	const blockContexts = useMemo(
+		() => comments?.map( ( comment ) => ( { commentId: comment.id } ) ),
+		[ comments ]
+	);
+
+	if ( ! comments ) {
+		return (
+			<p { ...blockProps }>
+				<Spinner />
+			</p>
+		);
+	}
+
+	if ( ! comments.length ) {
+		return <p { ...blockProps }> { __( 'No results found.' ) }</p>;
+	}
+
+	return (
+		<ul { ...blockProps }>
+			{ blockContexts &&
+				blockContexts.map( ( blockContext ) => (
+					<BlockContextProvider
+						key={ blockContext.commentId }
+						value={ blockContext }
+					>
+						{ blockContext ===
+						( activeBlockContext || blockContexts[ 0 ] ) ? (
+							<li { ...innerBlocksProps } />
+						) : (
+							<li>
+								<BlockPreview
+									blocks={ blocks }
+									__experimentalLive
+									__experimentalOnClick={ () =>
+										setActiveBlockContext( blockContext )
+									}
+								/>
+							</li>
+						) }
+					</BlockContextProvider>
+				) ) }
+		</ul>
+	);
+}

packages/block-library/src/comment-template/index.js

@@ -0,0 +1,20 @@
+/**
+ * WordPress dependencies
+ */
+import { layout as icon } from '@wordpress/icons';
+
+/**
+ * Internal dependencies
+ */
+import metadata from './block.json';
+import edit from './edit';
+import save from './save';
+
+const { name } = metadata;
+export { metadata, name };
+
+export const settings = {
+	icon,
+	edit,
+	save,
+};

packages/block-library/src/comment-template/index.php

@@ -0,0 +1,65 @@
+<?php
+/**
+ * Server-side rendering of the `core/comment-template` block.
+ *
+ * @package WordPress
+ */
+
+/**
+ * Renders the `core/comment-template` block on the server.
+ *
+ * @param array    $attributes Block attributes.
+ * @param string   $content    Block default content.
+ * @param WP_Block $block      Block instance.
+ *
+ * @return string Returns the HTML representing the comments using the layout
+ * defined by the block's inner blocks.
+ */
+function render_block_core_comment_template( $attributes, $content, $block ) {
+
+	$post_id = $block->context['postId'];
+
+	// Bail out early if the post ID is not set for some reason.
+	if ( ! isset( $post_id ) ) {
+		return '';
+	}
+
+	$number = $block->context['queryPerPage'];
+
+	// Get an array of comments for the current post.
+	$comments = get_approved_comments( $post_id, array( 'number' => $number ) );
+
+	if ( count( $comments ) === 0 ) {
+		return '';
+	}
+
+	$content = '';
+	foreach ( $comments as $comment ) {
+		$block_content = ( new WP_Block(
+			$block->parsed_block,
+			array(
+				'commentId' => $comment->comment_ID,
+			)
+		) )->render( array( 'dynamic' => false ) );
+		$content      .= '<li>' . $block_content . '</li>';
+	}
+
+	return sprintf(
+		'<ul>%1$s</ul>',
+		$content
+	);
+}
+
+/**
+ * Registers the `core/comment-template` block on the server.
+ */
+function register_block_core_comment_template() {
+	register_block_type_from_metadata(
+		__DIR__ . '/comment-template',
+		array(
+			'render_callback'   => 'render_block_core_comment_template',
+			'skip_inner_blocks' => true,
+		)
+	);
+}
+add_action( 'init', 'register_block_core_comment_template' );

packages/block-library/src/comment-template/save.js

@@ -0,0 +1,8 @@
+/**
+ * WordPress dependencies
+ */
+import { InnerBlocks } from '@wordpress/block-editor';
+
+export default function CommentTemplateSave() {
+	return <InnerBlocks.Content />;
+}

packages/block-library/src/comments-query-loop/block.json

@@ -0,0 +1,33 @@
+{
+	"apiVersion": 2,
+	"name": "core/comments-query-loop",
+	"title": "Comments Query Loop",
+	"category": "theme",
+	"description": "An advanced block that allows displaying post comments based on different query parameters and visual configurations.",
+	"textdomain": "default",
+	"attributes": {
+		"queryId": {
+			"type": "number"
+		},
+		"queryPerPage": {
+			"type": "number",
+			"default": 4
+		},
+		"tagName": {
+			"type": "string",
+			"default": "div"
+		}
+	},
+	"providesContext": {
+		"queryId": "queryId",
+		"queryPerPage": "queryPerPage"
+	},
+	"supports": {
+		"align": [ "wide", "full" ],
+		"html": false,
+		"color": {
+			"gradients": true,
+			"link": true
+		}
+	}
+}

packages/block-library/src/comments-query-loop/edit.js

@@ -0,0 +1,53 @@
+/**
+ * WordPress dependencies
+ */
+import {
+	BlockControls,
+	InspectorControls,
+	useBlockProps,
+	__experimentalUseInnerBlocksProps as useInnerBlocksProps,
+} from '@wordpress/block-editor';
+import { SelectControl } from '@wordpress/components';
+import { __ } from '@wordpress/i18n';
+
+/**
+ * Internal dependencies
+ */
+import QueryToolbar from './toolbar';
+
+const TEMPLATE = [ [ 'core/comment-template' ] ];
+
+export default function CommentsQueryLoopEdit( { attributes, setAttributes } ) {
+	const { queryPerPage, tagName: TagName } = attributes;
+
+	const blockProps = useBlockProps();
+	const innerBlocksProps = useInnerBlocksProps( blockProps, {
+		template: TEMPLATE,
+	} );
+
+	return (
+		<>
+			<BlockControls>
+				<QueryToolbar
+					queryPerPage={ queryPerPage }
+					setQuery={ setAttributes }
+				/>
+			</BlockControls>
+			<InspectorControls __experimentalGroup="advanced">
+				<SelectControl
+					label={ __( 'HTML element' ) }
+					options={ [
+						{ label: __( 'Default (<div>)' ), value: 'div' },
+						{ label: '<section>', value: 'section' },
+						{ label: '<aside>', value: 'aside' },
+					] }
+					value={ TagName }
+					onChange={ ( value ) =>
+						setAttributes( { tagName: value } )
+					}
+				/>
+			</InspectorControls>
+			<TagName { ...innerBlocksProps } />
+		</>
+	);
+}

packages/block-library/src/comments-query-loop/index.js

@@ -0,0 +1,20 @@
+/**
+ * WordPress dependencies
+ */
+import { postComments as icon } from '@wordpress/icons';
+
+/**
+ * Internal dependencies
+ */
+import metadata from './block.json';
+import edit from './edit';
+import save from './save';
+
+const { name } = metadata;
+export { metadata, name };
+
+export const settings = {
+	icon,
+	edit,
+	save,
+};

packages/block-library/src/comments-query-loop/save.js

@@ -0,0 +1,14 @@
+/**
+ * WordPress dependencies
+ */
+import { InnerBlocks, useBlockProps } from '@wordpress/block-editor';
+
+export default function CommentsQueryLoopSave( {
+	attributes: { tagName: Tag },
+} ) {
+	return (
+		<Tag { ...useBlockProps.save() }>
+			<InnerBlocks.Content />
+		</Tag>
+	);
+}