gutenberg / build / block-library / blocks / latest-comments.php

latest-comments.php in Gutenberg 12.1.0, at build/block-library/blocks/latest-comments.php

159 lines 5.0 KB

Raw Download Zip

1	<?php
2	/**
3	* Server-side rendering of the `core/latest-comments` block.
4	*
5	* @package WordPress
6	*/
7
8	/**
9	* Get the post title.
10	*
11	* The post title is fetched and if it is blank then a default string is
12	* returned.
13	*
14	* Copied from `wp-admin/includes/template.php`, but we can't include that
15	* file because:
16	*
17	* 1. It causes bugs with test fixture generation and strange Docker 255 error
18	* codes.
19	* 2. It's in the admin; ideally we shouldn't be including files from the
20	* admin for a block's output. It's a very small/simple function as well,
21	* so duplicating it isn't too terrible.
22	*
23	* @since 3.3.0
24	*
25	* @param int\|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
26	* @return string The post title if set; "(no title)" if no title is set.
27	*/
28	function gutenberg_latest_comments_draft_or_post_title( $post = 0 ) {
29	$title = get_the_title( $post );
30	if ( empty( $title ) ) {
31	$title = __( '(no title)' );
32	}
33	return esc_html( $title );
34	}
35
36	/**
37	* Renders the `core/latest-comments` block on server.
38	*
39	* @param array $attributes The block attributes.
40	*
41	* @return string Returns the post content with latest comments added.
42	*/
43	function gutenberg_render_block_core_latest_comments( $attributes = array() ) {
44	$comments = get_comments(
45	/** This filter is documented in wp-includes/widgets/class-wp-widget-recent-comments.php */
46	apply_filters(
47	'widget_comments_args',
48	array(
49	'number' => $attributes['commentsToShow'],
50	'status' => 'approve',
51	'post_status' => 'publish',
52	),
53	array()
54	)
55	);
56
57	$list_items_markup = '';
58	if ( ! empty( $comments ) ) {
59	// Prime the cache for associated posts. This is copied from \WP_Widget_Recent_Comments::widget().
60	$post_ids = array_unique( wp_list_pluck( $comments, 'comment_post_ID' ) );
61	_prime_post_caches( $post_ids, strpos( get_option( 'permalink_structure' ), '%category%' ), false );
62
63	foreach ( $comments as $comment ) {
64	$list_items_markup .= '<li class="wp-block-latest-comments__comment">';
65	if ( $attributes['displayAvatar'] ) {
66	$avatar = get_avatar(
67	$comment,
68	48,
69	'',
70	'',
71	array(
72	'class' => 'wp-block-latest-comments__comment-avatar',
73	)
74	);
75	if ( $avatar ) {
76	$list_items_markup .= $avatar;
77	}
78	}
79
80	$list_items_markup .= '<article>';
81	$list_items_markup .= '<footer class="wp-block-latest-comments__comment-meta">';
82	$author_url = get_comment_author_url( $comment );
83	if ( empty( $author_url ) && ! empty( $comment->user_id ) ) {
84	$author_url = get_author_posts_url( $comment->user_id );
85	}
86
87	$author_markup = '';
88	if ( $author_url ) {
89	$author_markup .= '<a class="wp-block-latest-comments__comment-author" href="' . esc_url( $author_url ) . '">' . get_comment_author( $comment ) . '</a>';
90	} else {
91	$author_markup .= '<span class="wp-block-latest-comments__comment-author">' . get_comment_author( $comment ) . '</span>';
92	}
93
94	// `_draft_or_post_title` calls `esc_html()` so we don't need to wrap that call in
95	// `esc_html`.
96	$post_title = '<a class="wp-block-latest-comments__comment-link" href="' . esc_url( get_comment_link( $comment ) ) . '">' . gutenberg_latest_comments_draft_or_post_title( $comment->comment_post_ID ) . '</a>';
97
98	$list_items_markup .= sprintf(
99	/* translators: 1: author name (inside <a> or <span> tag, based on if they have a URL), 2: post title related to this comment */
100	__( '%1$s on %2$s' ),
101	$author_markup,
102	$post_title
103	);
104
105	if ( $attributes['displayDate'] ) {
106	$list_items_markup .= sprintf(
107	'<time datetime="%1$s" class="wp-block-latest-comments__comment-date">%2$s</time>',
108	esc_attr( get_comment_date( 'c', $comment ) ),
109	date_i18n( get_option( 'date_format' ), get_comment_date( 'U', $comment ) )
110	);
111	}
112	$list_items_markup .= '</footer>';
113	if ( $attributes['displayExcerpt'] ) {
114	$list_items_markup .= '<div class="wp-block-latest-comments__comment-excerpt">' . wpautop( get_comment_excerpt( $comment ) ) . '</div>';
115	}
116	$list_items_markup .= '</article></li>';
117	}
118	}
119
120	$classnames = array();
121	if ( $attributes['displayAvatar'] ) {
122	$classnames[] = 'has-avatars';
123	}
124	if ( $attributes['displayDate'] ) {
125	$classnames[] = 'has-dates';
126	}
127	if ( $attributes['displayExcerpt'] ) {
128	$classnames[] = 'has-excerpts';
129	}
130	if ( empty( $comments ) ) {
131	$classnames[] = 'no-comments';
132	}
133	$wrapper_attributes = get_block_wrapper_attributes( array( 'class' => implode( ' ', $classnames ) ) );
134
135	return ! empty( $comments ) ? sprintf(
136	'<ol %1$s>%2$s</ol>',
137	$wrapper_attributes,
138	$list_items_markup
139	) : sprintf(
140	'<div %1$s>%2$s</div>',
141	$wrapper_attributes,
142	__( 'No comments to show.' )
143	);
144	}
145
146	/**
147	* Registers the `core/latest-comments` block.
148	*/
149	function gutenberg_register_block_core_latest_comments() {
150	register_block_type_from_metadata(
151	__DIR__ . '/latest-comments',
152	array(
153	'render_callback' => 'gutenberg_render_block_core_latest_comments',
154	)
155	);
156	}
157
158	add_action( 'init', 'gutenberg_register_block_core_latest_comments', 20 );
159