structured-data-blocks.php
12.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
<?php
namespace Yoast\WP\SEO\Integrations\Blocks;
use WPSEO_Admin_Asset_Manager;
use Yoast\WP\SEO\Conditionals\No_Conditionals;
use Yoast\WP\SEO\Helpers\Image_Helper;
use Yoast\WP\SEO\Integrations\Integration_Interface;
/**
* Class to load assets required for structured data blocks.
*/
class Structured_Data_Blocks implements Integration_Interface {
use No_Conditionals;
/**
* An instance of the WPSEO_Admin_Asset_Manager class.
*
* @var WPSEO_Admin_Asset_Manager
*/
protected $asset_manager;
/**
* An instance of the image helper class.
*
* @var Image_Helper
*/
protected $image_helper;
/**
* The image caches per post.
*
* @var array
*/
protected $caches = [];
/**
* The used cache keys per post.
*
* @var array
*/
protected $used_caches = [];
/**
* Whether or not we've registered our shutdown function.
*
* @var bool
*/
protected $registered_shutdown_function = false;
/**
* Structured_Data_Blocks constructor.
*
* @param WPSEO_Admin_Asset_Manager $asset_manager The asset manager.
* @param Image_Helper $image_helper The image helper.
*/
public function __construct(
WPSEO_Admin_Asset_Manager $asset_manager,
Image_Helper $image_helper
) {
$this->asset_manager = $asset_manager;
$this->image_helper = $image_helper;
}
/**
* Registers hooks for Structured Data Blocks with WordPress.
*/
public function register_hooks() {
\add_action( 'enqueue_block_editor_assets', [ $this, 'enqueue_block_editor_assets' ] );
$this->register_blocks();
}
/**
* Registers the blocks.
*
* @return void
*/
public function register_blocks() {
\register_block_type(
'yoast/faq-block',
[
'render_callback' => [ $this, 'optimize_faq_images' ],
'attributes' => [
'className' => [
'default' => '',
'type' => 'string',
],
'questions' => [
'type' => 'array',
],
'additionalListCssClasses' => [
'type' => 'string',
],
],
]
);
\register_block_type(
'yoast/how-to-block',
[
'render_callback' => [ $this, 'optimize_how_to_images' ],
'attributes' => [
'hasDuration' => [
'type' => 'boolean',
],
'days' => [
'type' => 'string',
],
'hours' => [
'type' => 'string',
],
'minutes' => [
'type' => 'string',
],
'description' => [
'type' => 'array',
'source' => 'children',
'selector' => '.schema-how-to-description',
],
'jsonDescription' => [
'type' => 'string',
],
'steps' => [
'type' => 'array',
],
'additionalListCssClasses' => [
'type' => 'string',
],
'unorderedList' => [
'type' => 'boolean',
],
'durationText' => [
'type' => 'string',
],
'defaultDurationText' => [
'type' => 'string',
],
],
]
);
}
/**
* Enqueue Gutenberg block assets for backend editor.
*/
public function enqueue_block_editor_assets() {
/**
* Filter: 'wpseo_enable_structured_data_blocks' - Allows disabling Yoast's schema blocks entirely.
*
* @api bool If false, our structured data blocks won't show.
*/
if ( ! \apply_filters( 'wpseo_enable_structured_data_blocks', true ) ) {
return;
}
$this->asset_manager->enqueue_script( 'structured-data-blocks' );
$this->asset_manager->enqueue_style( 'structured-data-blocks' );
}
/**
* Optimizes images in the FAQ blocks.
*
* @param array $attributes The attributes.
* @param string $content The content.
*
* @return string The content with images optimized.
*/
public function optimize_faq_images( $attributes, $content ) {
if ( ! isset( $attributes['questions'] ) ) {
return $content;
}
return $this->optimize_images( $attributes['questions'], 'answer', $content );
}
/**
* Transforms the durations into a translated string containing the count, and either singular or plural unit.
* For example (in en-US): If 'days' is 1, it returns "1 day". If 'days' is 2, it returns "2 days".
* If a number value is 0, we don't output the string.
*
* @param number $days Number of days.
* @param number $hours Number of hours.
* @param number $minutes Number of minutes.
* @return array Array of pluralized durations.
*/
private function transform_duration_to_string( $days, $hours, $minutes ) {
$strings = [];
if ( $days ) {
$strings[] = \sprintf(
/* translators: %d expands to the number of day/days. */
\_n( '%d day', '%d days', $days, 'wordpress-seo' ),
$days
);
}
if ( $hours ) {
$strings[] = \sprintf(
/* translators: %d expands to the number of hour/hours. */
\_n( '%d hour', '%d hours', $hours, 'wordpress-seo' ),
$hours
);
}
if ( $minutes ) {
$strings[] = \sprintf(
/* translators: %d expands to the number of minute/minutes. */
\_n( '%d minute', '%d minutes', $minutes, 'wordpress-seo' ),
$minutes
);
}
return $strings;
}
/**
* Formats the durations into a translated string.
*
* @param array $attributes The attributes.
* @return string The formatted duration.
*/
private function build_duration_string( $attributes ) {
$days = ( $attributes['days'] ?? 0 );
$hours = ( $attributes['hours'] ?? 0 );
$minutes = ( $attributes['minutes'] ?? 0 );
$elements = $this->transform_duration_to_string( $days, $hours, $minutes );
$elements_length = count( $elements );
switch ( $elements_length ) {
case 1:
return $elements[0];
case 2:
return \sprintf(
/* translators: %s expands to a unit of time (e.g. 1 day). */
\__( '%1$s and %2$s', 'wordpress-seo' ),
...$elements
);
case 3:
return \sprintf(
/* translators: %s expands to a unit of time (e.g. 1 day). */
\__( '%1$s, %2$s and %3$s', 'wordpress-seo' ),
...$elements
);
default:
return '';
}
}
/**
* Presents the duration text of the How-To block in the site language.
*
* @param array $attributes The attributes.
* @param string $content The content.
*
* @return string The content with the duration text in the site language.
*/
public function present_duration_text( $attributes, $content ) {
$duration = $this->build_duration_string( $attributes );
// 'Time needed:' is the default duration text that will be shown if a user doesn't add one.
$duration_text = \__( 'Time needed:', 'wordpress-seo' );
if ( isset( $attributes['durationText'] ) && $attributes['durationText'] !== '' ) {
$duration_text = $attributes['durationText'];
}
return \preg_replace(
'/(<p class="schema-how-to-total-time">)(<span class="schema-how-to-duration-time-text">.*<\/span>)(.[^\/p>]*)(<\/p>)/',
'<p class="schema-how-to-total-time"><span class="schema-how-to-duration-time-text">' . $duration_text . ' </span>' . $duration . '</p>',
$content,
1
);
}
/**
* Optimizes images in the How-To blocks.
*
* @param array $attributes The attributes.
* @param string $content The content.
*
* @return string The content with images optimized.
*/
public function optimize_how_to_images( $attributes, $content ) {
if ( ! isset( $attributes['steps'] ) ) {
return $content;
}
$content = $this->present_duration_text( $attributes, $content );
return $this->optimize_images( $attributes['steps'], 'text', $content );
}
/**
* Optimizes images in structured data blocks.
*
* @param array $elements The list of elements from the block attributes.
* @param string $key The key in the data to iterate over.
* @param string $content The content.
*
* @return string The content with images optimized.
*/
private function optimize_images( $elements, $key, $content ) {
global $post;
if ( ! $post ) {
return $content;
}
$this->add_images_from_attributes_to_used_cache( $post->ID, $elements, $key );
// Then replace all images with optimized versions in the content.
$content = \preg_replace_callback(
'/<img[^>]+>/',
function ( $matches ) {
\preg_match( '/src="([^"]+)"/', $matches[0], $src_matches );
if ( ! $src_matches || ! isset( $src_matches[1] ) ) {
return $matches[0];
}
$attachment_id = $this->attachment_src_to_id( $src_matches[1] );
if ( $attachment_id === 0 ) {
return $matches[0];
}
$image_size = 'full';
$image_style = [ 'style' => 'max-width: 100%; height: auto;' ];
\preg_match( '/style="[^"]*width:\s*(\d+)px[^"]*"/', $matches[0], $style_matches );
if ( $style_matches && isset( $style_matches[1] ) ) {
$width = (int) $style_matches[1];
$meta_data = \wp_get_attachment_metadata( $attachment_id );
if ( isset( $meta_data['height'] ) && isset( $meta_data['width'] ) && $meta_data['height'] > 0 && $meta_data['width'] > 0 ) {
$aspect_ratio = ( $meta_data['height'] / $meta_data['width'] );
$height = ( $width * $aspect_ratio );
$image_size = [ $width, $height ];
}
$image_style = '';
}
/**
* Filter: 'wpseo_structured_data_blocks_image_size' - Allows adjusting the image size in structured data blocks.
*
* @since 18.2
*
* @param string|int[] $image_size The image size. Accepts any registered image size name, or an array of width and height values in pixels (in that order).
* @param int $attachment_id The id of the attachment.
* @param string $attachment_src The attachment src.
*/
$image_size = \apply_filters(
'wpseo_structured_data_blocks_image_size',
$image_size,
$attachment_id,
$src_matches[1]
);
$image_html = \wp_get_attachment_image(
$attachment_id,
$image_size,
false,
$image_style
);
if ( empty( $image_html ) ) {
return $matches[0];
}
return $image_html;
},
$content
);
if ( ! $this->registered_shutdown_function ) {
\register_shutdown_function( [ $this, 'maybe_save_used_caches' ] );
$this->registered_shutdown_function = true;
}
return $content;
}
/**
* If the caches of structured data block images have been changed, saves them.
*
* @return void
*/
public function maybe_save_used_caches() {
foreach ( $this->used_caches as $post_id => $used_cache ) {
if ( isset( $this->caches[ $post_id ] ) && $used_cache === $this->caches[ $post_id ] ) {
continue;
}
\update_post_meta( $post_id, 'yoast-structured-data-blocks-images-cache', $used_cache );
}
}
/**
* Converts an attachment src to an attachment ID.
*
* @param string $src The attachment src.
*
* @return int The attachment ID. 0 if none was found.
*/
private function attachment_src_to_id( $src ) {
global $post;
if ( isset( $this->used_caches[ $post->ID ][ $src ] ) ) {
return $this->used_caches[ $post->ID ][ $src ];
}
$cache = $this->get_cache_for_post( $post->ID );
if ( isset( $cache[ $src ] ) ) {
$this->used_caches[ $post->ID ][ $src ] = $cache[ $src ];
return $cache[ $src ];
}
$this->used_caches[ $post->ID ][ $src ] = $this->image_helper->get_attachment_by_url( $src );
return $this->used_caches[ $post->ID ][ $src ];
}
/**
* Returns the cache from postmeta for a given post.
*
* @param int $post_id The post ID.
*
* @return array The images cache.
*/
private function get_cache_for_post( $post_id ) {
if ( isset( $this->caches[ $post_id ] ) ) {
return $this->caches[ $post_id ];
}
$cache = \get_post_meta( $post_id, 'yoast-structured-data-blocks-images-cache', true );
if ( ! $cache ) {
$cache = [];
}
$this->caches[ $post_id ] = $cache;
return $cache;
}
/**
* Adds any images that have their ID in the block attributes to the cache.
*
* @param int $post_id The post ID.
* @param array $elements The elements.
* @param string $key The key in the elements we should loop over.
*
* @return void
*/
private function add_images_from_attributes_to_used_cache( $post_id, $elements, $key ) {
// First grab all image IDs from the attributes.
$images = [];
foreach ( $elements as $element ) {
if ( ! isset( $element[ $key ] ) ) {
continue;
}
if ( isset( $element[ $key ] ) && \is_array( $element[ $key ] ) ) {
foreach ( $element[ $key ] as $part ) {
if ( ! \is_array( $part ) || ! isset( $part['type'] ) || $part['type'] !== 'img' ) {
continue;
}
if ( ! isset( $part['key'] ) || ! isset( $part['props']['src'] ) ) {
continue;
}
$images[ $part['props']['src'] ] = (int) $part['key'];
}
}
}
if ( isset( $this->used_caches[ $post_id ] ) ) {
$this->used_caches[ $post_id ] = \array_merge( $this->used_caches[ $post_id ], $images );
}
else {
$this->used_caches[ $post_id ] = $images;
}
}
}