latest-posts.php in Gutenberg 23.2.0, at build/scripts/block-library/latest-posts.php

276 lines 8.7 KB Raw Download Zip

1	<?php
2	/**
3	* Server-side rendering of the `core/latest-posts` block.
4	*
5	* @package WordPress
6	*/
7
8	/**
9	* The excerpt length set by the Latest Posts core block
10	* set at render time and used by the block itself.
11	*
12	* @var int
13	*/
14	global $block_core_latest_posts_excerpt_length;
15	$block_core_latest_posts_excerpt_length = 0;
16
17	/**
18	* Callback for the excerpt_length filter used by
19	* the Latest Posts block at render time.
20	*
21	* @since 5.4.0
22	*
23	* @global int $block_core_latest_posts_excerpt_length Excerpt length set by the Latest Posts core block.
24	*
25	* @return int Returns the global $block_core_latest_posts_excerpt_length variable
26	* to allow the excerpt_length filter respect the Latest Block setting.
27	*/
28	function gutenberg_block_core_latest_posts_get_excerpt_length() {
29	global $block_core_latest_posts_excerpt_length;
30	return $block_core_latest_posts_excerpt_length;
31	}
32
33	/**
34	* Renders the `core/latest-posts` block on server.
35	*
36	* @since 5.0.0
37	*
38	* @global WP_Post $post Global post object.
39	* @global int $block_core_latest_posts_excerpt_length Excerpt length set by the Latest Posts core block.
40	*
41	* @param array $attributes The block attributes.
42	*
43	* @return string Returns the post content with latest posts added.
44	*/
45	function gutenberg_render_block_core_latest_posts( $attributes ) {
46	global $post, $block_core_latest_posts_excerpt_length;
47
48	$args = array(
49	'posts_per_page' => $attributes['postsToShow'],
50	'post_status' => 'publish',
51	'order' => $attributes['order'],
52	'orderby' => $attributes['orderBy'],
53	'ignore_sticky_posts' => true,
54	'no_found_rows' => true,
55	);
56
57	$block_core_latest_posts_excerpt_length = $attributes['excerptLength'];
58	add_filter( 'excerpt_length', 'gutenberg_block_core_latest_posts_get_excerpt_length', 20 );
59
60	if ( ! empty( $attributes['categories'] ) ) {
61	$args['category__in'] = array_column( $attributes['categories'], 'id' );
62	}
63	if ( isset( $attributes['selectedAuthor'] ) ) {
64	$args['author'] = $attributes['selectedAuthor'];
65	}
66
67	$query = new WP_Query();
68	$recent_posts = $query->query( $args );
69
70	if ( isset( $attributes['displayFeaturedImage'] ) && $attributes['displayFeaturedImage'] ) {
71	update_post_thumbnail_cache( $query );
72	}
73
74	$list_items_markup = '';
75
76	foreach ( $recent_posts as $post ) {
77	$post_link = esc_url( get_permalink( $post ) );
78	$title = get_the_title( $post );
79
80	if ( ! $title ) {
81	$title = __( '(no title)' );
82	}
83
84	$list_items_markup .= '<li>';
85
86	if ( $attributes['displayFeaturedImage'] && has_post_thumbnail( $post ) ) {
87	$image_style = '';
88	if ( isset( $attributes['featuredImageSizeWidth'] ) ) {
89	$image_style .= sprintf( 'max-width:%spx;', $attributes['featuredImageSizeWidth'] );
90	}
91	if ( isset( $attributes['featuredImageSizeHeight'] ) ) {
92	$image_style .= sprintf( 'max-height:%spx;', $attributes['featuredImageSizeHeight'] );
93	}
94
95	$image_classes = 'wp-block-latest-posts__featured-image';
96	if ( isset( $attributes['featuredImageAlign'] ) ) {
97	$image_classes .= ' align' . $attributes['featuredImageAlign'];
98	}
99
100	$featured_image = get_the_post_thumbnail(
101	$post,
102	$attributes['featuredImageSizeSlug'],
103	array(
104	'style' => esc_attr( $image_style ),
105	)
106	);
107	if ( $attributes['addLinkToFeaturedImage'] ) {
108	$featured_image = sprintf(
109	'<a href="%1$s" aria-label="%2$s">%3$s</a>',
110	esc_url( $post_link ),
111	esc_attr( $title ),
112	$featured_image
113	);
114	}
115	$list_items_markup .= sprintf(
116	'<div class="%1$s">%2$s</div>',
117	esc_attr( $image_classes ),
118	$featured_image
119	);
120	}
121
122	$list_items_markup .= sprintf(
123	'<a class="wp-block-latest-posts__post-title" href="%1$s">%2$s</a>',
124	esc_url( $post_link ),
125	$title
126	);
127
128	if ( isset( $attributes['displayAuthor'] ) && $attributes['displayAuthor'] ) {
129	$author_display_name = get_the_author_meta( 'display_name', $post->post_author );
130
131	/* translators: byline. %s: author. */
132	$byline = sprintf( __( 'by %s' ), $author_display_name );
133
134	if ( ! empty( $author_display_name ) ) {
135	$list_items_markup .= sprintf(
136	'<div class="wp-block-latest-posts__post-author">%1$s</div>',
137	$byline
138	);
139	}
140	}
141
142	if ( isset( $attributes['displayPostDate'] ) && $attributes['displayPostDate'] ) {
143	$list_items_markup .= sprintf(
144	'<time datetime="%1$s" class="wp-block-latest-posts__post-date">%2$s</time>',
145	esc_attr( get_the_date( 'c', $post ) ),
146	get_the_date( '', $post )
147	);
148	}
149
150	if ( isset( $attributes['displayPostContent'] ) && $attributes['displayPostContent']
151	&& isset( $attributes['displayPostContentRadio'] ) && 'excerpt' === $attributes['displayPostContentRadio'] ) {
152
153	$trimmed_excerpt = get_the_excerpt( $post );
154
155	/*
156	* Adds a "Read more" link with screen reader text.
157	* […] is the default excerpt ending from wp_trim_excerpt() in Core.
158	*/
159	if ( str_ends_with( $trimmed_excerpt, ' […]' ) ) {
160	/** This filter is documented in wp-includes/formatting.php */
161	$excerpt_length = (int) apply_filters( 'excerpt_length', $block_core_latest_posts_excerpt_length );
162	if ( $excerpt_length <= $block_core_latest_posts_excerpt_length ) {
163	$trimmed_excerpt = substr( $trimmed_excerpt, 0, -11 );
164	$trimmed_excerpt .= sprintf(
165	/* translators: 1: A URL to a post, 2: Hidden accessibility text: Post title */
166	__( '… <a class="wp-block-latest-posts__read-more" href="%1$s" rel="noopener">Read more<span class="screen-reader-text">: %2$s</span></a>' ),
167	esc_url( $post_link ),
168	esc_html( $title )
169	);
170	}
171	}
172
173	if ( post_password_required( $post ) ) {
174	$trimmed_excerpt = __( 'This content is password protected.' );
175	}
176
177	$list_items_markup .= sprintf(
178	'<div class="wp-block-latest-posts__post-excerpt">%1$s</div>',
179	$trimmed_excerpt
180	);
181	}
182
183	if ( isset( $attributes['displayPostContent'] ) && $attributes['displayPostContent']
184	&& isset( $attributes['displayPostContentRadio'] ) && 'full_post' === $attributes['displayPostContentRadio'] ) {
185
186	$post_content = html_entity_decode( $post->post_content, ENT_QUOTES, get_option( 'blog_charset' ) );
187
188	if ( post_password_required( $post ) ) {
189	$post_content = __( 'This content is password protected.' );
190	}
191
192	$list_items_markup .= sprintf(
193	'<div class="wp-block-latest-posts__post-full-content">%1$s</div>',
194	wp_kses_post( $post_content )
195	);
196	}
197
198	$list_items_markup .= "</li>\n";
199	}
200
201	remove_filter( 'excerpt_length', 'gutenberg_block_core_latest_posts_get_excerpt_length', 20 );
202
203	$classes = array( 'wp-block-latest-posts__list' );
204	if ( isset( $attributes['postLayout'] ) && 'grid' === $attributes['postLayout'] ) {
205	$classes[] = 'is-grid';
206	}
207	if ( isset( $attributes['columns'] ) && 'grid' === $attributes['postLayout'] ) {
208	$classes[] = 'columns-' . $attributes['columns'];
209	}
210	if ( isset( $attributes['displayPostDate'] ) && $attributes['displayPostDate'] ) {
211	$classes[] = 'has-dates';
212	}
213	if ( isset( $attributes['displayAuthor'] ) && $attributes['displayAuthor'] ) {
214	$classes[] = 'has-author';
215	}
216	if ( isset( $attributes['style']['elements']['link']['color']['text'] ) ) {
217	$classes[] = 'has-link-color';
218	}
219
220	$wrapper_attributes = get_block_wrapper_attributes( array( 'class' => implode( ' ', $classes ) ) );
221
222	return sprintf(
223	'<ul %1$s>%2$s</ul>',
224	$wrapper_attributes,
225	$list_items_markup
226	);
227	}
228
229	/**
230	* Registers the `core/latest-posts` block on server.
231	*
232	* @since 5.0.0
233	*/
234	function gutenberg_register_block_core_latest_posts() {
235	register_block_type_from_metadata(
236	__DIR__ . '/latest-posts',
237	array(
238	'render_callback' => 'gutenberg_render_block_core_latest_posts',
239	)
240	);
241	}
242	add_action( 'init', 'gutenberg_register_block_core_latest_posts', 20 );
243
244	/**
245	* Handles outdated versions of the `core/latest-posts` block by converting
246	* attribute `categories` from a numeric string to an array with key `id`.
247	*
248	* This is done to accommodate the changes introduced in #20781 that sought to
249	* add support for multiple categories to the block. However, given that this
250	* block is dynamic, the usual provisions for block migration are insufficient,
251	* as they only act when a block is loaded in the editor.
252	*
253	* TODO: Remove when and if the bottom client-side deprecation for this block
254	* is removed.
255	*
256	* @since 5.5.0
257	*
258	* @param array $block A single parsed block object.
259	*
260	* @return array The migrated block object.
261	*/
262	function gutenberg_block_core_latest_posts_migrate_categories( $block ) {
263	if (
264	'core/latest-posts' === $block['blockName'] &&
265	! empty( $block['attrs']['categories'] ) &&
266	is_string( $block['attrs']['categories'] )
267	) {
268	$block['attrs']['categories'] = array(
269	array( 'id' => absint( $block['attrs']['categories'] ) ),
270	);
271	}
272
273	return $block;
274	}
275	add_filter( 'render_block_data', 'gutenberg_block_core_latest_posts_migrate_categories' );
276