class.jetpack-post-images.php — Jetpack – WP Security, Backup, Speed, & Growth 14.8.1

jetpack / class.jetpack-post-images.php

jetpack Last commit date

class.jetpack-post-images.php

1160 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* Useful for finding an image to display alongside/in representation of a specific post.
4	*
5	* @package automattic/jetpack
6	*/
7
8	use Automattic\Block_Delimiter;
9	use Automattic\Jetpack\Image_CDN\Image_CDN_Core;
10
11	/**
12	* Useful for finding an image to display alongside/in representation of a specific post.
13	*
14	* Includes a few different methods, all of which return a similar-format array containing
15	* details of any images found. Everything can (should) be called statically, it's just a
16	* function-bucket. You can also call Jetpack_PostImages::get_image() to cycle through all of the methods until
17	* one of them finds something useful.
18	*
19	* This file is included verbatim in Jetpack
20	*/
21	class Jetpack_PostImages {
22	/**
23	* If a slideshow is embedded within a post, then parse out the images involved and return them
24	*
25	* @param int $post_id Post ID.
26	* @param int $width Image width.
27	* @param int $height Image height.
28	* @return array Images.
29	*/
30	public static function from_slideshow( $post_id, $width = 200, $height = 200 ) {
31	$images = array();
32
33	$post = get_post( $post_id );
34
35	if ( ! $post ) {
36	return $images;
37	}
38
39	if ( ! empty( $post->post_password ) ) {
40	return $images;
41	}
42
43	if ( false === has_shortcode( $post->post_content, 'slideshow' ) ) {
44	return $images; // no slideshow - bail.
45	}
46
47	$permalink = get_permalink( $post->ID );
48
49	// Mechanic: Somebody set us up the bomb.
50	$old_post = $GLOBALS['post'] ?? null;
51	$GLOBALS['post'] = $post; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
52	$old_shortcodes = $GLOBALS['shortcode_tags'];
53	$GLOBALS['shortcode_tags'] = array( 'slideshow' => $old_shortcodes['slideshow'] ); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
54
55	// Find all the slideshows.
56	preg_match_all( '/' . get_shortcode_regex() . '/sx', $post->post_content, $slideshow_matches, PREG_SET_ORDER );
57
58	ob_start(); // The slideshow shortcode handler calls wp_print_scripts and wp_print_styles... not too happy about that.
59
60	foreach ( $slideshow_matches as $slideshow_match ) {
61	$slideshow = do_shortcode_tag( $slideshow_match );
62	$pos = stripos( $slideshow, 'jetpack-slideshow' );
63	if ( false === $pos ) { // must be something wrong - or we changed the output format in which case none of the following will work.
64	continue;
65	}
66	$start = strpos( $slideshow, '[', $pos );
67	$end = strpos( $slideshow, ']', $start );
68	$post_images = json_decode( wp_specialchars_decode( str_replace( "'", '"', substr( $slideshow, $start, $end - $start + 1 ) ), ENT_QUOTES ) ); // parse via JSON
69	// If the JSON didn't decode don't try and act on it.
70	if ( is_array( $post_images ) ) {
71	foreach ( $post_images as $post_image ) {
72	$post_image_id = absint( $post_image->id );
73	if ( ! $post_image_id ) {
74	continue;
75	}
76
77	$meta = wp_get_attachment_metadata( $post_image_id );
78
79	// Must be larger than 200x200 (or user-specified).
80	if ( ! isset( $meta['width'] ) \|\| $meta['width'] < $width ) {
81	continue;
82	}
83	if ( ! isset( $meta['height'] ) \|\| $meta['height'] < $height ) {
84	continue;
85	}
86
87	$url = wp_get_attachment_url( $post_image_id );
88
89	$images[] = array(
90	'type' => 'image',
91	'from' => 'slideshow',
92	'src' => $url,
93	'src_width' => $meta['width'],
94	'src_height' => $meta['height'],
95	'href' => $permalink,
96	);
97	}
98	}
99	}
100	ob_end_clean();
101
102	// Operator: Main screen turn on.
103	$GLOBALS['shortcode_tags'] = $old_shortcodes; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
104	$GLOBALS['post'] = $old_post; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
105
106	return $images;
107	}
108
109	/**
110	* Filtering out images with broken URL from galleries.
111	*
112	* @param array $galleries Galleries.
113	* @return array $filtered_galleries
114	*/
115	public static function filter_gallery_urls( $galleries ) {
116	$filtered_galleries = array();
117	foreach ( $galleries as $this_gallery ) {
118	if ( ! isset( $this_gallery['src'] ) ) {
119	continue;
120	}
121	$ids = isset( $this_gallery['ids'] ) ? explode( ',', $this_gallery['ids'] ) : array();
122	// Make sure 'src' array isn't associative and has no holes.
123	$this_gallery['src'] = array_values( $this_gallery['src'] );
124	foreach ( $this_gallery['src'] as $idx => $src_url ) {
125	if ( filter_var( $src_url, FILTER_VALIDATE_URL, FILTER_FLAG_PATH_REQUIRED ) === false ) {
126	unset( $this_gallery['src'][ $idx ] );
127	unset( $ids[ $idx ] );
128	}
129	}
130	if ( isset( $this_gallery['ids'] ) ) {
131	$this_gallery['ids'] = implode( ',', $ids );
132	}
133	// Remove any holes we introduced.
134	$this_gallery['src'] = array_values( $this_gallery['src'] );
135	$filtered_galleries[] = $this_gallery;
136	}
137
138	return $filtered_galleries;
139	}
140
141	/**
142	* If a gallery is detected, then get all the images from it.
143	*
144	* @param int $post_id Post ID.
145	* @param int $width Minimum image width to consider.
146	* @param int $height Minimum image height to consider.
147	* @return array Images.
148	*/
149	public static function from_gallery( $post_id, $width = 200, $height = 200 ) {
150	$images = array();
151
152	$post = get_post( $post_id );
153
154	if ( ! $post ) {
155	return $images;
156	}
157
158	if ( ! empty( $post->post_password ) ) {
159	return $images;
160	}
161	add_filter( 'get_post_galleries', array( __CLASS__, 'filter_gallery_urls' ), 999999 );
162
163	$permalink = get_permalink( $post->ID );
164
165	/**
166	* Juggle global post object because the gallery shortcode uses the
167	* global object.
168	*
169	* See core ticket:
170	* https://core.trac.wordpress.org/ticket/39304
171	*/
172	// phpcs:disable WordPress.WP.GlobalVariablesOverride.Prohibited
173	if ( isset( $GLOBALS['post'] ) ) {
174	$juggle_post = $GLOBALS['post'];
175	$GLOBALS['post'] = $post;
176	$galleries = get_post_galleries( $post->ID, false );
177	$GLOBALS['post'] = $juggle_post;
178	} else {
179	$GLOBALS['post'] = $post;
180	$galleries = get_post_galleries( $post->ID, false );
181	unset( $GLOBALS['post'] );
182	}
183	// phpcs:enable WordPress.WP.GlobalVariablesOverride.Prohibited
184
185	foreach ( $galleries as $gallery ) {
186	if ( ! empty( $gallery['ids'] ) ) {
187	$image_ids = explode( ',', $gallery['ids'] );
188	$image_size = isset( $gallery['size'] ) ? $gallery['size'] : 'thumbnail';
189	foreach ( $image_ids as $image_id ) {
190	$image = wp_get_attachment_image_src( $image_id, $image_size );
191	$meta = wp_get_attachment_metadata( $image_id );
192
193	if ( isset( $gallery['type'] ) && 'slideshow' === $gallery['type'] ) {
194	// Must be larger than 200x200 (or user-specified).
195	if ( ! isset( $meta['width'] ) \|\| $meta['width'] < $width ) {
196	continue;
197	}
198	if ( ! isset( $meta['height'] ) \|\| $meta['height'] < $height ) {
199	continue;
200	}
201	}
202
203	if ( ! empty( $image[0] ) ) {
204	list( $raw_src ) = explode( '?', $image[0] ); // pull off any Query string (?w=250).
205	$raw_src = wp_specialchars_decode( $raw_src ); // rawify it.
206	$raw_src = esc_url_raw( $raw_src ); // clean it.
207	$images[] = array(
208	'type' => 'image',
209	'from' => 'gallery',
210	'src' => $raw_src,
211	'src_width' => $meta['width'] ?? 0,
212	'src_height' => $meta['height'] ?? 0,
213	'href' => $permalink,
214	'alt_text' => self::get_alt_text( $image_id ),
215	);
216	}
217	}
218	} elseif ( ! empty( $gallery['src'] ) ) {
219	foreach ( $gallery['src'] as $src ) {
220	list( $raw_src ) = explode( '?', $src ); // pull off any Query string (?w=250).
221	$raw_src = wp_specialchars_decode( $raw_src ); // rawify it.
222	$raw_src = esc_url_raw( $raw_src ); // clean it.
223	$images[] = array(
224	'type' => 'image',
225	'from' => 'gallery',
226	'src' => $raw_src,
227	'href' => $permalink,
228	);
229	}
230	}
231	}
232
233	return $images;
234	}
235
236	/**
237	* Get attachment images for a specified post and return them. Also make sure
238	* their dimensions are at or above a required minimum.
239	*
240	* @param int $post_id The post ID to check.
241	* @param int $width Image width.
242	* @param int $height Image height.
243	* @return array Containing details of the image, or empty array if none.
244	*/
245	public static function from_attachment( $post_id, $width = 200, $height = 200 ) {
246	$images = array();
247
248	$post = get_post( $post_id );
249
250	if ( ! empty( $post->post_password ) ) {
251	return $images;
252	}
253
254	$post_images = get_posts(
255	array(
256	'post_parent' => $post_id, // Must be children of post.
257	'numberposts' => 5, // No more than 5.
258	'post_type' => 'attachment', // Must be attachments.
259	'post_mime_type' => 'image', // Must be images.
260	'suppress_filters' => false,
261	)
262	);
263
264	if ( ! $post_images ) {
265	return $images;
266	}
267
268	$permalink = get_permalink( $post_id );
269
270	foreach ( $post_images as $post_image ) {
271	$current_image = self::get_attachment_data( $post_image->ID, $permalink, $width, $height );
272	if ( false !== $current_image ) {
273	$images[] = $current_image;
274	}
275	}
276
277	/*
278	* We only want to pass back attached images that were actually inserted.
279	* We can load up all the images found in the HTML source and then
280	* compare URLs to see if an image is attached AND inserted.
281	*/
282	$html_images = self::from_html( $post_id );
283	$inserted_images = array();
284
285	foreach ( $html_images as $html_image ) {
286	$src = wp_parse_url( $html_image['src'] );
287	if ( ! $src \|\| empty( $src['path'] ) ) {
288	continue;
289	}
290
291	// strip off any query strings from src.
292	if ( ! empty( $src['scheme'] ) && ! empty( $src['host'] ) ) {
293	$inserted_images[] = $src['scheme'] . '://' . $src['host'] . $src['path'];
294	} elseif ( ! empty( $src['host'] ) ) {
295	$inserted_images[] = set_url_scheme( 'http://' . $src['host'] . $src['path'] );
296	} else {
297	$inserted_images[] = site_url( '/' ) . $src['path'];
298	}
299	}
300	foreach ( $images as $i => $image ) {
301	if ( ! in_array( $image['src'], $inserted_images, true ) ) {
302	unset( $images[ $i ] );
303	}
304	}
305
306	return $images;
307	}
308
309	/**
310	* Check if a Featured Image is set for this post, and return it in a similar
311	* format to the other images?_from_*() methods.
312	*
313	* @param int $post_id The post ID to check.
314	* @param int $width Image width.
315	* @param int $height Image height.
316	* @return array containing details of the Featured Image, or empty array if none.
317	*/
318	public static function from_thumbnail( $post_id, $width = 200, $height = 200 ) {
319	$images = array();
320
321	$post = get_post( $post_id );
322
323	if ( ! empty( $post->post_password ) ) {
324	return $images;
325	}
326
327	if ( 'attachment' === get_post_type( $post ) && wp_attachment_is_image( $post ) ) {
328	$thumb = $post_id;
329	} else {
330	$thumb = get_post_thumbnail_id( $post );
331	}
332
333	if ( $thumb ) {
334	$meta = wp_get_attachment_metadata( $thumb );
335	// Must be larger than requested minimums.
336	if ( ! isset( $meta['width'] ) \|\| $meta['width'] < $width ) {
337	return $images;
338	}
339	if ( ! isset( $meta['height'] ) \|\| $meta['height'] < $height ) {
340	return $images;
341	}
342	$max_dimension = self::get_max_thumbnail_dimension();
343	$too_big = ( ( ! empty( $meta['width'] ) && $meta['width'] > $max_dimension ) \|\| ( ! empty( $meta['height'] ) && $meta['height'] > $max_dimension ) );
344
345	if (
346	$too_big &&
347	(
348	( method_exists( 'Jetpack', 'is_module_active' ) && Jetpack::is_module_active( 'photon' ) ) \|\|
349	( defined( 'IS_WPCOM' ) && IS_WPCOM )
350	)
351	) {
352	$size = self::determine_thumbnail_size_for_photon( $meta['width'], $meta['height'] );
353	$photon_args = array(
354	'fit' => $size['width'] . ',' . $size['height'],
355	);
356	$img_src = array( Image_CDN_Core::cdn_url( wp_get_attachment_url( $thumb ), $photon_args ), $size['width'], $size['height'], true ); // Match the signature of wp_get_attachment_image_src
357	} else {
358	$img_src = wp_get_attachment_image_src( $thumb, 'full' );
359	}
360	if ( ! is_array( $img_src ) ) {
361	// If wp_get_attachment_image_src returns false but we know that there should be an image that could be used.
362	// we try a bit harder and user the data that we have.
363	$thumb_post_data = get_post( $thumb );
364	$img_src = array( $thumb_post_data->guid ?? null, $meta['width'], $meta['height'] );
365	}
366
367	// Let's try to use the postmeta if we can, since it seems to be
368	// more reliable
369	if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
370	$featured_image = get_post_meta( $post->ID, '_jetpack_featured_image' );
371	if ( $featured_image ) {
372	$url = $featured_image[0];
373	} else {
374	$url = $img_src[0];
375	}
376	} else {
377	$url = $img_src[0];
378	}
379	$images = array(
380	array( // Other methods below all return an array of arrays.
381	'type' => 'image',
382	'from' => 'thumbnail',
383	'src' => $url,
384	'src_width' => $img_src[1],
385	'src_height' => $img_src[2],
386	'href' => get_permalink( $thumb ),
387	'alt_text' => self::get_alt_text( $thumb ),
388	),
389	);
390
391	}
392
393	if ( empty( $images ) && ( defined( 'IS_WPCOM' ) && IS_WPCOM ) ) {
394	$meta_thumbnail = get_post_meta( $post_id, '_jetpack_post_thumbnail', true );
395	if ( ! empty( $meta_thumbnail ) ) {
396	if ( ! isset( $meta_thumbnail['width'] ) \|\| $meta_thumbnail['width'] < $width ) {
397	return $images;
398	}
399
400	if ( ! isset( $meta_thumbnail['height'] ) \|\| $meta_thumbnail['height'] < $height ) {
401	return $images;
402	}
403
404	$images = array(
405	array( // Other methods below all return an array of arrays.
406	'type' => 'image',
407	'from' => 'thumbnail',
408	'src' => $meta_thumbnail['URL'],
409	'src_width' => $meta_thumbnail['width'],
410	'src_height' => $meta_thumbnail['height'],
411	'href' => $meta_thumbnail['URL'],
412	'alt_text' => self::get_alt_text( $thumb ),
413	),
414	);
415	}
416	}
417
418	return $images;
419	}
420
421	/**
422	* Get images from Gutenberg Image blocks.
423	*
424	* @since 6.9.0
425	* @since 14.8 Updated to use Block_Delimiter for improved performance.
426	*
427	* @param mixed $html_or_id The HTML string to parse for images, or a post id.
428	* @param int $width Minimum Image width.
429	* @param int $height Minimum Image height.
430	*/
431	public static function from_blocks( $html_or_id, $width = 200, $height = 200 ) {
432	$images = array();
433
434	$html_info = self::get_post_html( $html_or_id );
435
436	if ( empty( $html_info['html'] ) ) {
437	return $images;
438	}
439
440	/*
441	* Use Block_Delimiter to parse our post content HTML,
442	* and find all the block delimiters for supported blocks,
443	* whether they're parent or nested blocks.
444	*/
445	$supported_blocks = array(
446	'core/image',
447	'core/media-text',
448	'core/gallery',
449	'jetpack/tiled-gallery',
450	'jetpack/slideshow',
451	'jetpack/story',
452	);
453
454	foreach ( Block_Delimiter::scan_delimiters( $html_info['html'] ) as $where => $delimiter ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
455	// Only process opening delimiters for supported block types.
456	if ( Block_Delimiter::OPENER !== $delimiter->get_delimiter_type() ) {
457	continue;
458	}
459
460	$block_type = $delimiter->allocate_and_return_block_type();
461	if ( ! in_array( $block_type, $supported_blocks, true ) ) {
462	continue;
463	}
464
465	$attributes = $delimiter->allocate_and_return_parsed_attributes() ?? array();
466	$block_images = self::get_images_from_block_attributes( $block_type, $attributes, $html_info, $width, $height );
467
468	if ( ! empty( $block_images ) ) {
469	$images = array_merge( $images, $block_images );
470	}
471	}
472
473	/**
474	* Returning a filtered array because get_attachment_data returns false
475	* for unsuccessful attempts.
476	*/
477	return array_filter( $images );
478	}
479
480	/**
481	* Extract images from block attributes based on block type.
482	*
483	* @since 14.8
484	*
485	* @param string $block_type Block type name.
486	* @param array $attributes Block attributes.
487	* @param array $html_info Info about the post where the block is found.
488	* @param int $width Desired image width.
489	* @param int $height Desired image height.
490	*
491	* @return array Array of images found.
492	*/
493	private static function get_images_from_block_attributes( $block_type, $attributes, $html_info, $width, $height ) {
494	$images = array();
495
496	switch ( $block_type ) {
497	case 'core/image':
498	case 'core/media-text':
499	$id_key = 'core/image' === $block_type ? 'id' : 'mediaId';
500	if ( ! empty( $attributes[ $id_key ] ) ) {
501	$image = self::get_attachment_data( $attributes[ $id_key ], $html_info['post_url'], $width, $height );
502	if ( false !== $image ) {
503	$images[] = $image;
504	}
505	}
506	break;
507
508	case 'core/gallery':
509	case 'jetpack/tiled-gallery':
510	case 'jetpack/slideshow':
511	if ( ! empty( $attributes['ids'] ) && is_array( $attributes['ids'] ) ) {
512	foreach ( $attributes['ids'] as $img_id ) {
513	$image = self::get_attachment_data( $img_id, $html_info['post_url'], $width, $height );
514	if ( false !== $image ) {
515	$images[] = $image;
516	}
517	}
518	}
519	break;
520
521	case 'jetpack/story':
522	if ( ! empty( $attributes['mediaFiles'] ) && is_array( $attributes['mediaFiles'] ) ) {
523	foreach ( $attributes['mediaFiles'] as $media_file ) {
524	if ( ! empty( $media_file['id'] ) ) {
525	$image = self::get_attachment_data( $media_file['id'], $html_info['post_url'], $width, $height );
526	if ( false !== $image ) {
527	$images[] = $image;
528	}
529	}
530	}
531	}
532	break;
533	}
534
535	return $images;
536	}
537
538	/**
539	* Very raw -- just parse the HTML and pull out any/all img tags and return their src
540	*
541	* @param mixed $html_or_id The HTML string to parse for images, or a post id.
542	* @param int $width Minimum Image width.
543	* @param int $height Minimum Image height.
544	*
545	* @uses DOMDocument
546	*
547	* @return array containing images
548	*/
549	public static function from_html( $html_or_id, $width = 200, $height = 200 ) {
550	$images = array();
551
552	$html_info = self::get_post_html( $html_or_id );
553
554	if ( empty( $html_info['html'] ) ) {
555	return $images;
556	}
557
558	// Do not go any further if DOMDocument is disabled on the server.
559	if ( ! class_exists( 'DOMDocument' ) ) {
560	return $images;
561	}
562
563	// Let's grab all image tags from the HTML.
564	$dom_doc = new DOMDocument();
565
566	// DOMDocument defaults to ISO-8859 because we're loading only the post content, without head tag.
567	// Fix: Enforce encoding with meta tag.
568	$charset = get_option( 'blog_charset' );
569	if ( empty( $charset ) \|\| ! preg_match( '/^[a-zA-Z0-9_-]+$/', $charset ) ) {
570	$charset = 'UTF-8';
571	}
572	$html_prefix = sprintf( '<meta http-equiv="Content-Type" content="text/html; charset=%s">', esc_attr( $charset ) );
573
574	// The @ is not enough to suppress errors when dealing with libxml,
575	// we have to tell it directly how we want to handle errors.
576	libxml_use_internal_errors( true );
577	@$dom_doc->loadHTML( $html_prefix . $html_info['html'] ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
578	libxml_use_internal_errors( false );
579
580	$image_tags = $dom_doc->getElementsByTagName( 'img' );
581
582	// For each image Tag, make sure it can be added to the $images array, and add it.
583	foreach ( $image_tags as $image_tag ) {
584	$img_src = $image_tag->getAttribute( 'src' );
585
586	if ( empty( $img_src ) ) {
587	continue;
588	}
589
590	// Do not grab smiley images that were automatically created by WP when entering text smilies.
591	if ( stripos( $img_src, '/smilies/' ) ) {
592	continue;
593	}
594
595	// Do not grab Gravatar images.
596	if ( stripos( $img_src, 'gravatar.com' ) ) {
597	continue;
598	}
599
600	// First try to get the width and height from the img attributes, but if they are not set, check to see if they are specified in the url. WordPress automatically names files like foo-1024x768.jpg during the upload process
601	$width = (int) $image_tag->getAttribute( 'width' );
602	$height = (int) $image_tag->getAttribute( 'height' );
603	if ( 0 === $width && 0 === $height ) {
604	preg_match( '/-([0-9]{1,5})x([0-9]{1,5})\.(?:jpg\|jpeg\|png\|gif\|webp)$/i', $img_src, $matches );
605	if ( ! empty( $matches[1] ) ) {
606	$width = (int) $matches[1];
607	}
608	if ( ! empty( $matches[2] ) ) {
609	$height = (int) $matches[2];
610	}
611	}
612	// If width and height are still 0, try to get the id of the image from the class, e.g. wp-image-1234
613	if ( 0 === $width && 0 === $height ) {
614
615	preg_match( '/wp-image-([0-9]+)/', $image_tag->getAttribute( 'class' ), $matches );
616	if ( ! empty( $matches[1] ) ) {
617	$attachment_id = $matches[1];
618	$meta = wp_get_attachment_metadata( $attachment_id );
619	$height = $meta['height'] ?? 0;
620	$width = $meta['width'] ?? 0;
621	}
622	}
623
624	$meta = array(
625	'width' => $width,
626	'height' => $height,
627	'alt_text' => $image_tag->getAttribute( 'alt' ),
628	);
629
630	/**
631	* Filters the switch to ignore minimum image size requirements. Can be used
632	* to add custom logic to image dimensions, like only enforcing one of the dimensions,
633	* or disabling it entirely.
634	*
635	* @since 6.4.0
636	*
637	* @param bool $ignore Should the image dimensions be ignored?
638	* @param array $meta Array containing image dimensions parsed from the markup.
639	*/
640	$ignore_dimensions = apply_filters( 'jetpack_postimages_ignore_minimum_dimensions', false, $meta );
641
642	// Must be larger than 200x200 (or user-specified).
643	if (
644	! $ignore_dimensions
645	&& (
646	empty( $meta['width'] )
647	\|\| empty( $meta['height'] )
648	\|\| $meta['width'] < $width
649	\|\| $meta['height'] < $height
650	)
651	) {
652	continue;
653	}
654
655	$image = array(
656	'type' => 'image',
657	'from' => 'html',
658	'src' => $img_src,
659	'src_width' => $meta['width'],
660	'src_height' => $meta['height'],
661	'href' => $html_info['post_url'],
662	);
663	if ( ! empty( $meta['alt_text'] ) ) {
664	$image['alt_text'] = $meta['alt_text'];
665	}
666	$images[] = $image;
667	}
668	return $images;
669	}
670
671	/**
672	* Data from blavatar.
673	*
674	* @param int $post_id The post ID to check.
675	* @param int $size Size.
676	* @return array containing details of the image, or empty array if none.
677	*/
678	public static function from_blavatar( $post_id, $size = 96 ) {
679
680	$permalink = get_permalink( $post_id );
681
682	if ( function_exists( 'blavatar_domain' ) && function_exists( 'blavatar_exists' ) && function_exists( 'blavatar_url' ) ) {
683	$domain = blavatar_domain( $permalink );
684
685	if ( ! blavatar_exists( $domain ) ) {
686	return array();
687	}
688
689	$url = blavatar_url( $domain, 'img', $size );
690	} else {
691	$url = get_site_icon_url( $size );
692	if ( ! $url ) {
693	return array();
694	}
695	}
696
697	return array(
698	array(
699	'type' => 'image',
700	'from' => 'blavatar',
701	'src' => $url,
702	'src_width' => $size,
703	'src_height' => $size,
704	'href' => $permalink,
705	'alt_text' => '',
706	),
707	);
708	}
709
710	/**
711	* Gets a post image from the author avatar.
712	*
713	* @param int $post_id The post ID to check.
714	* @param int $size The size of the avatar to get.
715	* @param string $default The default image to use.
716	* @return array containing details of the image, or empty array if none.
717	*/
718	public static function from_gravatar( $post_id, $size = 96, $default = false ) {
719	$post = get_post( $post_id );
720	$permalink = get_permalink( $post_id );
721
722	if ( ! $post instanceof WP_Post ) {
723	return array();
724	}
725
726	if ( function_exists( 'wpcom_get_avatar_url' ) ) {
727	$url = wpcom_get_avatar_url( $post->post_author, $size, $default, true );
728	if ( $url && is_array( $url ) ) {
729	$url = $url[0];
730	}
731	} else {
732	$url = get_avatar_url(
733	$post->post_author,
734	array(
735	'size' => $size,
736	'default' => $default,
737	)
738	);
739	}
740
741	return array(
742	array(
743	'type' => 'image',
744	'from' => 'gravatar',
745	'src' => $url,
746	'src_width' => $size,
747	'src_height' => $size,
748	'href' => $permalink,
749	'alt_text' => '',
750	),
751	);
752	}
753
754	/**
755	* Run through the different methods that we have available to try to find a single good
756	* display image for this post.
757	*
758	* @param int $post_id Post ID.
759	* @param array $args Other arguments (currently width and height required for images where possible to determine).
760	* @return array\|null containing details of the best image to be used, or null if no image is found.
761	*/
762	public static function get_image( $post_id, $args = array() ) {
763	$image = null;
764
765	/**
766	* Fires before we find a single good image for a specific post.
767	*
768	* @since 2.2.0
769	*
770	* @param int $post_id Post ID.
771	*/
772	do_action( 'jetpack_postimages_pre_get_image', $post_id );
773	$media = self::get_images( $post_id, $args );
774
775	if ( is_array( $media ) ) {
776	foreach ( $media as $item ) {
777	if ( 'image' === $item['type'] ) {
778	$image = $item;
779	break;
780	}
781	}
782	}
783
784	/**
785	* Fires after we find a single good image for a specific post.
786	*
787	* @since 2.2.0
788	*
789	* @param int $post_id Post ID.
790	*/
791	do_action( 'jetpack_postimages_post_get_image', $post_id );
792
793	return $image;
794	}
795
796	/**
797	* Get an array containing a collection of possible images for this post, stopping once we hit a method
798	* that returns something useful.
799	*
800	* @param int $post_id Post ID.
801	* @param array $args Optional args, see defaults list for details.
802	* @return array containing images that would be good for representing this post
803	*/
804	public static function get_images( $post_id, $args = array() ) {
805	// Figure out which image to attach to this post.
806	$media = array();
807
808	/**
809	* Filters the array of images that would be good for a specific post.
810	* This filter is applied before options ($args) filter the original array.
811	*
812	* @since 2.0.0
813	*
814	* @param array $media Array of images that would be good for a specific post.
815	* @param int $post_id Post ID.
816	* @param array $args Array of options to get images.
817	*/
818	$media = apply_filters( 'jetpack_images_pre_get_images', $media, $post_id, $args );
819	if ( $media ) {
820	return $media;
821	}
822
823	$defaults = array(
824	'width' => 200, // Required minimum width (if possible to determine).
825	'height' => 200, // Required minimum height (if possible to determine).
826
827	'fallback_to_avatars' => false, // Optionally include Blavatar and Gravatar (in that order) in the image stack.
828	'avatar_size' => 96, // Used for both Grav and Blav.
829	'gravatar_default' => false, // Default image to use if we end up with no Gravatar.
830
831	'from_thumbnail' => true, // Use these flags to specify which methods to use to find an image.
832	'from_slideshow' => true,
833	'from_gallery' => true,
834	'from_attachment' => true,
835	'from_blocks' => true,
836	'from_html' => true,
837
838	'html_content' => '', // HTML string to pass to from_html().
839	);
840	$args = wp_parse_args( $args, $defaults );
841
842	$media = array();
843	if ( $args['from_thumbnail'] ) {
844	$media = self::from_thumbnail( $post_id, $args['width'], $args['height'] );
845	}
846	if ( ! $media && $args['from_slideshow'] ) {
847	$media = self::from_slideshow( $post_id, $args['width'], $args['height'] );
848	}
849	if ( ! $media && $args['from_gallery'] ) {
850	$media = self::from_gallery( $post_id );
851	}
852	if ( ! $media && $args['from_attachment'] ) {
853	$media = self::from_attachment( $post_id, $args['width'], $args['height'] );
854	}
855	if ( ! $media && $args['from_blocks'] ) {
856	if ( empty( $args['html_content'] ) ) {
857	$media = self::from_blocks( $post_id, $args['width'], $args['height'] ); // Use the post_id, which will load the content.
858	} else {
859	$media = self::from_blocks( $args['html_content'], $args['width'], $args['height'] ); // If html_content is provided, use that.
860	}
861	}
862	if ( ! $media && $args['from_html'] ) {
863	if ( empty( $args['html_content'] ) ) {
864	$media = self::from_html( $post_id, $args['width'], $args['height'] ); // Use the post_id, which will load the content.
865	} else {
866	$media = self::from_html( $args['html_content'], $args['width'], $args['height'] ); // If html_content is provided, use that.
867	}
868	}
869
870	if ( ! $media && $args['fallback_to_avatars'] ) {
871	$media = self::from_blavatar( $post_id, $args['avatar_size'] );
872	if ( ! $media ) {
873	$media = self::from_gravatar( $post_id, $args['avatar_size'], $args['gravatar_default'] );
874	}
875	}
876
877	/**
878	* Filters the array of images that would be good for a specific post.
879	* This filter is applied after options ($args) filter the original array.
880	*
881	* @since 2.0.0
882	*
883	* @param array $media Array of images that would be good for a specific post.
884	* @param int $post_id Post ID.
885	* @param array $args Array of options to get images.
886	*/
887	return apply_filters( 'jetpack_images_get_images', $media, $post_id, $args );
888	}
889
890	/**
891	* Takes an image and base pixel dimensions and returns a srcset for the
892	* resized and cropped images, based on a fixed set of multipliers.
893	*
894	* @param array $image Array containing details of the image.
895	* @param int $base_width Base image width (i.e., the width at 1x).
896	* @param int $base_height Base image height (i.e., the height at 1x).
897	* @param bool $use_widths Whether to generate the srcset with widths instead of multipliers.
898	* @return string The srcset for the image.
899	*/
900	public static function generate_cropped_srcset( $image, $base_width, $base_height, $use_widths = false ) {
901	$srcset = '';
902
903	if ( ! is_array( $image ) \|\| empty( $image['src'] ) \|\| empty( $image['src_width'] ) ) {
904	return $srcset;
905	}
906
907	$multipliers = array( 1, 1.5, 2, 3, 4 );
908	$srcset_values = array();
909	foreach ( $multipliers as $multiplier ) {
910	$srcset_width = (int) ( $base_width * $multiplier );
911	$srcset_height = (int) ( $base_height * $multiplier );
912	if ( $srcset_width < 1 \|\| $srcset_width > $image['src_width'] ) {
913	break;
914	}
915
916	$srcset_url = self::fit_image_url(
917	$image['src'],
918	$srcset_width,
919	$srcset_height
920	);
921
922	if ( $use_widths ) {
923	$srcset_values[] = "{$srcset_url} {$srcset_width}w";
924	} else {
925	$srcset_values[] = "{$srcset_url} {$multiplier}x";
926	}
927	}
928
929	if ( count( $srcset_values ) > 1 ) {
930	$srcset = implode( ', ', $srcset_values );
931	}
932
933	return $srcset;
934	}
935
936	/**
937	* Takes an image URL and pixel dimensions then returns a URL for the
938	* resized and cropped image.
939	*
940	* @param string $src Image URL.
941	* @param int $width Image width.
942	* @param int $height Image height.
943	* @return string Transformed image URL
944	*/
945	public static function fit_image_url( $src, $width, $height ) {
946	$width = (int) $width;
947	$height = (int) $height;
948
949	if ( $width < 1 \|\| $height < 1 ) {
950	return $src;
951	}
952
953	// See if we should bypass WordPress.com SaaS resizing.
954	if ( has_filter( 'jetpack_images_fit_image_url_override' ) ) {
955	/**
956	* Filters the image URL used after dimensions are set by Photon.
957	*
958	* @since 3.3.0
959	*
960	* @param string $src Image URL.
961	* @param int $width Image width.
962	* @param int $width Image height.
963	*/
964	return apply_filters( 'jetpack_images_fit_image_url_override', $src, $width, $height );
965	}
966
967	// If WPCOM hosted image use native transformations.
968	$img_host = wp_parse_url( $src, PHP_URL_HOST );
969	if ( $img_host && str_ends_with( $img_host, '.files.wordpress.com' ) ) {
970	return add_query_arg(
971	array(
972	'w' => $width,
973	'h' => $height,
974	'crop' => 1,
975	),
976	set_url_scheme( $src )
977	);
978	}
979
980	// Use image cdn magic.
981	if ( class_exists( Image_CDN_Core::class ) && method_exists( Image_CDN_Core::class, 'cdn_url' ) ) {
982	return Image_CDN_Core::cdn_url( $src, array( 'resize' => "$width,$height" ) );
983	}
984
985	// Arg... no way to resize image using WordPress.com infrastructure!
986	return $src;
987	}
988
989	/**
990	* Get HTML from given post content.
991	*
992	* @since 6.9.0
993	*
994	* @param mixed $html_or_id The HTML string to parse for images, or a post id.
995	*
996	* @return array $html_info {
997	* @type string $html Post content.
998	* @type string $post_url Post URL.
999	* }
1000	*/
1001	public static function get_post_html( $html_or_id ) {
1002	if ( is_numeric( $html_or_id ) ) {
1003	$post = get_post( $html_or_id );
1004
1005	if ( empty( $post ) \|\| ! empty( $post->post_password ) ) {
1006	return '';
1007	}
1008
1009	$html_info = array(
1010	'html' => $post->post_content, // DO NOT apply the_content filters here, it will cause loops.
1011	'post_url' => get_permalink( $post->ID ),
1012	);
1013	} else {
1014	$html_info = array(
1015	'html' => $html_or_id,
1016	'post_url' => '',
1017	);
1018	}
1019	return $html_info;
1020	}
1021
1022	/**
1023	* Get info about a WordPress attachment.
1024	*
1025	* @since 6.9.0
1026	*
1027	* @param int $attachment_id Attachment ID.
1028	* @param string $post_url URL of the post, if we have one.
1029	* @param int $width Minimum Image width.
1030	* @param int $height Minimum Image height.
1031	* @return array\|bool Image data or false if unavailable.
1032	*/
1033	public static function get_attachment_data( $attachment_id, $post_url, $width, $height ) {
1034	if ( empty( $attachment_id ) ) {
1035	return false;
1036	}
1037
1038	$meta = wp_get_attachment_metadata( $attachment_id );
1039
1040	if ( empty( $meta ) ) {
1041	return false;
1042	}
1043
1044	if ( ! empty( $meta['videopress'] ) ) {
1045	// Use poster image for VideoPress videos.
1046	$url = $meta['videopress']['poster'];
1047	$meta_width = $meta['videopress']['width'];
1048	$meta_height = $meta['videopress']['height'];
1049	} elseif ( ! empty( $meta['thumb'] ) ) {
1050	// On WordPress.com, VideoPress videos have a 'thumb' property with the
1051	// poster image filename instead.
1052	$media_url = wp_get_attachment_url( $attachment_id );
1053	$url = str_replace( wp_basename( $media_url ), $meta['thumb'], $media_url );
1054	$meta_width = $meta['width'];
1055	$meta_height = $meta['height'];
1056	} elseif ( wp_attachment_is( 'video', $attachment_id ) ) {
1057	// We don't have thumbnail images for non-VideoPress videos - skip them.
1058	return false;
1059	} else {
1060	if ( ! isset( $meta['width'] ) \|\| ! isset( $meta['height'] ) ) {
1061	return false;
1062	}
1063	$url = wp_get_attachment_url( $attachment_id );
1064	$meta_width = $meta['width'];
1065	$meta_height = $meta['height'];
1066	}
1067
1068	if ( $meta_width < $width \|\| $meta_height < $height ) {
1069	return false;
1070	}
1071
1072	return array(
1073	'type' => 'image',
1074	'from' => 'attachment',
1075	'src' => $url,
1076	'src_width' => $meta_width,
1077	'src_height' => $meta_height,
1078	'href' => $post_url,
1079	'alt_text' => self::get_alt_text( $attachment_id ),
1080	);
1081	}
1082
1083	/**
1084	* Get the alt text for an image or other media from the Media Library.
1085	*
1086	* @since 7.1
1087	*
1088	* @param int $attachment_id The Post ID of the media.
1089	* @return string The alt text value or an empty string.
1090	*/
1091	public static function get_alt_text( $attachment_id ) {
1092	return (string) get_post_meta( $attachment_id, '_wp_attachment_image_alt', true );
1093	}
1094
1095	/**
1096	* Determine the size to use with Photon for a thumbnail image.
1097	* Images larger than the maximum thumbnail dimension in either dimension are resized to maintain aspect ratio.
1098	*
1099	* @since 14.6
1100	* @see https://github.com/Automattic/jetpack/issues/40349
1101	*
1102	* @param int $width Original image width.
1103	* @param int $height Original image height.
1104	* @return array Array containing the width and height to use with Photon (null means auto).
1105	*/
1106	public static function determine_thumbnail_size_for_photon( $width, $height ) {
1107	$max_dimension = self::get_max_thumbnail_dimension();
1108
1109	// If neither dimension exceeds max size, return original dimensions.
1110	if ( $width <= $max_dimension && $height <= $max_dimension ) {
1111	return array(
1112	'width' => $width,
1113	'height' => $height,
1114	);
1115	}
1116
1117	if ( $width >= $height ) {
1118	// For landscape or square images.
1119	$dims = image_resize_dimensions( $width, $height, $max_dimension, 0 ); // Height will be calculated automatically.
1120	} else {
1121	// For portrait images.
1122	$dims = image_resize_dimensions( $width, $height, 0, $max_dimension ); // Width will be calculated automatically.
1123	}
1124
1125	// $dims can be false if the image is virtually the same size as the max dimension, e.g. wp_fuzzy_number_match.
1126	if ( $dims && isset( $dims[4] ) && isset( $dims[5] ) ) {
1127	return array(
1128	'width' => $dims[4],
1129	'height' => $dims[5],
1130	);
1131	}
1132
1133	return array(
1134	'width' => $width,
1135	'height' => $height,
1136	);
1137	}
1138
1139	/**
1140	* Function to provide the maximum dimension for a thumbnail image.
1141	* Filterable via the `jetpack_post_images_max_dimension` filter.
1142	*
1143	* @since 14.6
1144	* @see https://github.com/Automattic/jetpack/issues/40349
1145	*
1146	* @return int The maximum dimension for a thumbnail image.
1147	*/
1148	public static function get_max_thumbnail_dimension() {
1149	/**
1150	* Filter the maximum dimension allowed for a thumbnail image.
1151	* The default value is 1200 pixels.
1152	*
1153	* @since 14.6
1154	*
1155	* @param int $max_dimension Maximum dimension in pixels.
1156	*/
1157	return (int) apply_filters( 'jetpack_post_images_max_thumbnail_dimension', 1200 );
1158	}
1159	}
1160