Completed
Push — fix/ensure-no-parse-block-erro... ( f6564a...3450c9 )
by
unknown
06:51
created

class.jetpack-post-images.php (5 issues)

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

1
<?php
2
3
/**
4
 * Useful for finding an image to display alongside/in representation of a specific post.
5
 *
6
 * Includes a few different methods, all of which return a similar-format array containing
7
 * details of any images found. Everything can (should) be called statically, it's just a
8
 * function-bucket. You can also call Jetpack_PostImages::get_image() to cycle through all of the methods until
9
 * one of them finds something useful.
10
 *
11
 * This file is included verbatim in Jetpack
12
 */
13
class Jetpack_PostImages {
14
	/**
15
	 * If a slideshow is embedded within a post, then parse out the images involved and return them
16
	 */
17
	static function from_slideshow( $post_id, $width = 200, $height = 200 ) {
18
		$images = array();
19
20
		$post = get_post( $post_id );
21
22
		if ( ! $post ) {
23
			return $images;
24
		}
25
26
		if ( ! empty( $post->post_password ) ) {
27
			return $images;
28
		}
29
30
		if ( false === has_shortcode( $post->post_content, 'slideshow' ) ) {
31
			return $images; // no slideshow - bail
32
		}
33
34
		$permalink = get_permalink( $post->ID );
35
36
		// Mechanic: Somebody set us up the bomb
37
		$old_post = $GLOBALS['post'];
38
		$GLOBALS['post'] = $post;
39
		$old_shortcodes = $GLOBALS['shortcode_tags'];
40
		$GLOBALS['shortcode_tags'] = array( 'slideshow' => $old_shortcodes['slideshow'] );
41
42
		// Find all the slideshows
43
		preg_match_all( '/' . get_shortcode_regex() . '/sx', $post->post_content, $slideshow_matches, PREG_SET_ORDER );
44
45
		ob_start(); // The slideshow shortcode handler calls wp_print_scripts and wp_print_styles... not too happy about that
46
47
		foreach ( $slideshow_matches as $slideshow_match ) {
0 ignored issues
show
The expression $slideshow_matches of type null|array<integer,array<integer,string>> is not guaranteed to be traversable. How about adding an additional type check?

There are different options of fixing this problem.

  1. If you want to be on the safe side, you can add an additional type-check:

    $collection = json_decode($data, true);
    if ( ! is_array($collection)) {
        throw new \RuntimeException('$collection must be an array.');
    }
    
    foreach ($collection as $item) { /** ... */ }
    
  2. If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:

    /** @var array $collection */
    $collection = json_decode($data, true);
    
    foreach ($collection as $item) { /** .. */ }
    
  3. Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.

Loading history...
48
			$slideshow = do_shortcode_tag( $slideshow_match );
49
			if ( false === $pos = stripos( $slideshow, 'jetpack-slideshow' ) ) // must be something wrong - or we changed the output format in which case none of the following will work
50
				continue;
51
			$start = strpos( $slideshow, '[', $pos );
52
			$end = strpos( $slideshow, ']', $start );
53
			$post_images = json_decode( wp_specialchars_decode( str_replace( "'", '"', substr( $slideshow, $start, $end - $start + 1 ) ), ENT_QUOTES ) ); // parse via JSON
54
			// If the JSON didn't decode don't try and act on it.
55
			if ( is_array( $post_images ) ) {
56
				foreach ( $post_images as $post_image ) {
57
					if ( !$post_image_id = absint( $post_image->id ) )
58
						continue;
59
60
					$meta = wp_get_attachment_metadata( $post_image_id );
61
62
					// Must be larger than 200x200 (or user-specified)
63
					if ( !isset( $meta['width'] ) || $meta['width'] < $width )
64
						continue;
65
					if ( !isset( $meta['height'] ) || $meta['height'] < $height )
66
						continue;
67
68
					$url = wp_get_attachment_url( $post_image_id );
69
70
					$images[] = array(
71
						'type'       => 'image',
72
						'from'       => 'slideshow',
73
						'src'        => $url,
74
						'src_width'  => $meta['width'],
75
						'src_height' => $meta['height'],
76
						'href'       => $permalink,
77
					);
78
				}
79
			}
80
		}
81
		ob_end_clean();
82
83
		// Operator: Main screen turn on
84
		$GLOBALS['shortcode_tags'] = $old_shortcodes;
85
		$GLOBALS['post'] = $old_post;
86
87
		return $images;
88
	}
89
90
	/**
91
	 * If a gallery is detected, then get all the images from it.
92
	 */
93
	static function from_gallery( $post_id ) {
94
		$images = array();
95
96
		$post = get_post( $post_id );
97
98
		if ( ! $post ) {
99
			return $images;
100
		}
101
102
		if ( ! empty( $post->post_password ) ) {
103
			return $images;
104
		}
105
106
		$permalink = get_permalink( $post->ID );
107
108
		/**
109
		 *  Juggle global post object because the gallery shortcode uses the
110
		 *  global object.
111
		 *
112
		 *  See core ticket:
113
		 *  https://core.trac.wordpress.org/ticket/39304
114
		 */
115
		if ( isset( $GLOBALS['post'] ) ) {
116
			$juggle_post = $GLOBALS['post'];
117
			$GLOBALS['post'] = $post;
118
			$galleries = get_post_galleries( $post->ID, false );
119
			$GLOBALS['post'] = $juggle_post;
120
		} else {
121
			$GLOBALS['post'] = $post;
122
			$galleries = get_post_galleries( $post->ID, false );
123
			unset( $GLOBALS['post'] );
124
		}
125
126
		foreach ( $galleries as $gallery ) {
127
			if ( isset( $gallery['type'] ) && 'slideshow' === $gallery['type'] && ! empty( $gallery['ids'] ) ) {
128
				$image_ids = explode( ',', $gallery['ids'] );
129
				$image_size = isset( $gallery['size'] ) ? $gallery['size'] : 'thumbnail';
130
				foreach ( $image_ids as $image_id ) {
131
					$image = wp_get_attachment_image_src( $image_id, $image_size );
132 View Code Duplication
					if ( ! empty( $image[0] ) ) {
133
						list( $raw_src ) = explode( '?', $image[0] ); // pull off any Query string (?w=250)
134
						$raw_src = wp_specialchars_decode( $raw_src ); // rawify it
135
						$raw_src = esc_url_raw( $raw_src ); // clean it
136
						$images[] = array(
137
							'type'  => 'image',
138
							'from'  => 'gallery',
139
							'src'   => $raw_src,
140
							'href'  => $permalink,
141
						);
142
					}
143
				}
144 View Code Duplication
			} elseif ( ! empty( $gallery['src'] ) ) {
145
				foreach ( $gallery['src'] as $src ) {
146
					list( $raw_src ) = explode( '?', $src ); // pull off any Query string (?w=250)
147
					$raw_src = wp_specialchars_decode( $raw_src ); // rawify it
148
					$raw_src = esc_url_raw( $raw_src ); // clean it
149
					$images[] = array(
150
						'type'  => 'image',
151
						'from'  => 'gallery',
152
						'src'   => $raw_src,
153
						'href'  => $permalink,
154
					);
155
				}
156
			}
157
		}
158
159
		return $images;
160
	}
161
162
	/**
163
	 * Get attachment images for a specified post and return them. Also make sure
164
	 * their dimensions are at or above a required minimum.
165
	 */
166
	static function from_attachment( $post_id, $width = 200, $height = 200 ) {
167
		$images = array();
168
169
		$post = get_post( $post_id );
170
171
		if ( ! empty( $post->post_password ) ) {
172
			return $images;
173
		}
174
175
		$post_images = get_posts( array(
176
			'post_parent' => $post_id,   // Must be children of post
177
			'numberposts' => 5,          // No more than 5
178
			'post_type' => 'attachment', // Must be attachments
179
			'post_mime_type' => 'image', // Must be images
180
			'suppress_filters' => false,
181
		) );
182
183
		if ( ! $post_images ) {
184
			return $images;
185
		}
186
187
		$permalink = get_permalink( $post_id );
188
189
		foreach ( $post_images as $post_image ) {
190
			$current_image = self::get_attachment_data( $post_image->ID, $permalink, $width, $height );
191
			if ( false !== $current_image ) {
192
				$images[] = $current_image;
193
			}
194
		}
195
196
		/*
197
		* We only want to pass back attached images that were actually inserted.
198
		* We can load up all the images found in the HTML source and then
199
		* compare URLs to see if an image is attached AND inserted.
200
		*/
201
		$html_images = self::from_html( $post_id );
202
		$inserted_images = array();
203
204
		foreach( $html_images as $html_image ) {
205
			$src = parse_url( $html_image['src'] );
206
			// strip off any query strings from src
207
			if( ! empty( $src['scheme'] ) && ! empty( $src['host'] ) ) {
208
				$inserted_images[] = $src['scheme'] . '://' . $src['host'] . $src['path'];
209
			} elseif( ! empty( $src['host'] ) ) {
210
				$inserted_images[] = set_url_scheme( 'http://' . $src['host'] . $src['path'] );
211
			} else {
212
				$inserted_images[] = site_url( '/' ) . $src['path'];
213
			}
214
		}
215
		foreach( $images as $i => $image ) {
216
			if ( !in_array( $image['src'], $inserted_images ) )
217
				unset( $images[$i] );
218
		}
219
220
		return $images;
221
	}
222
223
	/**
224
	 * Check if a Featured Image is set for this post, and return it in a similar
225
	 * format to the other images?_from_*() methods.
226
	 * @param  int $post_id The post ID to check
227
	 * @return Array containing details of the Featured Image, or empty array if none.
228
	 */
229
	static function from_thumbnail( $post_id, $width = 200, $height = 200 ) {
230
		$images = array();
231
232
		$post = get_post( $post_id );
233
234
		if ( ! empty( $post->post_password ) ) {
235
			return $images;
236
		}
237
238
		if ( 'attachment' === get_post_type( $post ) && wp_attachment_is_image( $post ) ) {
239
			$thumb = $post_id;
240
		} else {
241
			$thumb = get_post_thumbnail_id( $post );
242
		}
243
244
		if ( $thumb ) {
245
			$meta = wp_get_attachment_metadata( $thumb );
246
			// Must be larger than requested minimums
247
			if ( !isset( $meta['width'] ) || $meta['width'] < $width )
248
				return $images;
249
			if ( !isset( $meta['height'] ) || $meta['height'] < $height )
250
				return $images;
251
252
			$too_big = ( ( ! empty( $meta['width'] ) && $meta['width'] > 1200 ) || ( ! empty( $meta['height'] ) && $meta['height'] > 1200 ) );
253
254
			if (
255
				$too_big &&
256
				(
257
					( method_exists( 'Jetpack', 'is_module_active' ) && Jetpack::is_module_active( 'photon' ) ) ||
258
					( defined( 'IS_WPCOM' ) && IS_WPCOM )
259
				)
260
			) {
261
				$img_src = wp_get_attachment_image_src( $thumb, array( 1200, 1200 ) );
262
			} else {
263
				$img_src = wp_get_attachment_image_src( $thumb, 'full' );
264
			}
265
			if ( ! is_array( $img_src ) ) {
266
				// If wp_get_attachment_image_src returns false but we know that there should be an image that could be used.
267
				// we try a bit harder and user the data that we have.
268
				$thumb_post_data = get_post( $thumb );
269
				$img_src = array( $thumb_post_data->guid, $meta['width'], $meta['height'] );
270
			}
271
272
			$url    = $img_src[0];
273
			$images = array( array( // Other methods below all return an array of arrays
274
				'type'       => 'image',
275
				'from'       => 'thumbnail',
276
				'src'        => $url,
277
				'src_width'  => $img_src[1],
278
				'src_height' => $img_src[2],
279
				'href'       => get_permalink( $thumb ),
280
				'alt_text'   => self::get_alt_text( $thumb ),
281
			) );
282
283
		}
284
285
		if ( empty( $images ) && ( defined( 'IS_WPCOM' ) && IS_WPCOM ) ) {
286
			$meta_thumbnail = get_post_meta( $post_id, '_jetpack_post_thumbnail', true );
287
			if ( ! empty( $meta_thumbnail ) ) {
288
				if ( ! isset( $meta_thumbnail['width'] ) || $meta_thumbnail['width'] < $width ) {
289
					return $images;
290
				}
291
292
				if ( ! isset( $meta_thumbnail['height'] ) || $meta_thumbnail['height'] < $height ) {
293
					return $images;
294
				}
295
296
				$images = array( array( // Other methods below all return an array of arrays
297
					'type'       => 'image',
298
					'from'       => 'thumbnail',
299
					'src'        => $meta_thumbnail['URL'],
300
					'src_width'  => $meta_thumbnail['width'],
301
					'src_height' => $meta_thumbnail['height'],
302
					'href'       => $meta_thumbnail['URL'],
303
					'alt_text'   => self::get_alt_text( $thumb ),
304
				) );
305
			}
306
		}
307
308
		return $images;
309
	}
310
311
	/**
312
	 * Get images from Gutenberg Image blocks.
313
	 *
314
	 * @since 6.9.0
315
	 *
316
	 * @param mixed $html_or_id The HTML string to parse for images, or a post id.
317
	 * @param int   $width      Minimum Image width.
318
	 * @param int   $height     Minimum Image height.
319
	 */
320
	public static function from_blocks( $html_or_id, $width = 200, $height = 200 ) {
321
		$images = array();
322
323
		$html_info = self::get_post_html( $html_or_id );
324
325
		if ( empty( $html_info['html'] ) ) {
326
			return $images;
327
		}
328
329
		// Look for block information in the HTML.
330
		if ( ! function_exists( 'parse_blocks' ) ) {
331
			return $images;
332
		}
333
		$blocks = parse_blocks( $html_info['html'] );
334
		if ( empty( $blocks ) ) {
335
			return $images;
336
		}
337
338
		foreach ( $blocks as $block ) {
339
			/**
340
			 * Parse content from Core Image blocks.
341
			 * If it is an image block for an image hosted on our site, it will have an ID.
342
			 * If it does not have an ID, let `from_html` parse that content later,
343
			 * and extract an image if it has size parameters.
344
			 */
345
			if (
346
				'core/image' === $block['blockName']
347
				&& ! empty( $block['attrs']['id'] )
348
			) {
349
				$images[] = self::get_attachment_data( $block['attrs']['id'], $html_info['post_url'], $width, $height );
350
			}
351
352
			/**
353
			 * Parse content from Core Gallery blocks and Jetpack's Tiled Gallery blocks.
354
			 * Gallery blocks include the ID of each one of the images in the gallery.
355
			 */
356
			if (
357
				( 'core/gallery' === $block['blockName'] || 'jetpack/tiled-gallery' === $block['blockName'] )
358
				&& ! empty( $block['attrs']['ids'] )
359
			) {
360
				foreach ( $block['attrs']['ids'] as $img_id ) {
361
					$images[] = self::get_attachment_data( $img_id, $html_info['post_url'], $width, $height );
362
				}
363
			}
364
		}
365
366
		/**
367
		 * Returning a filtered array because get_attachment_data returns false
368
		 * for unsuccessful attempts.
369
		 */
370
		return array_filter( $images );
371
	}
372
373
	/**
374
	 * Very raw -- just parse the HTML and pull out any/all img tags and return their src
375
	 *
376
	 * @param mixed $html_or_id The HTML string to parse for images, or a post id.
377
	 * @param int   $width      Minimum Image width.
378
	 * @param int   $height     Minimum Image height.
379
	 *
380
	 * @uses DOMDocument
381
	 *
382
	 * @return Array containing images
383
	 */
384
	static function from_html( $html_or_id, $width = 200, $height = 200 ) {
385
		$images = array();
386
387
		$html_info = self::get_post_html( $html_or_id );
388
389
		if ( empty( $html_info['html'] ) ) {
390
			return $images;
391
		}
392
393
		// Do not go any further if DOMDocument is disabled on the server.
394
		if ( ! class_exists( 'DOMDocument' ) ) {
395
			return $images;
396
		}
397
398
		// Let's grab all image tags from the HTML.
399
		$dom_doc = new DOMDocument;
400
401
		// The @ is not enough to suppress errors when dealing with libxml,
402
		// we have to tell it directly how we want to handle errors.
403
		libxml_use_internal_errors( true );
404
		@$dom_doc->loadHTML( $html_info['html'] );
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
405
		libxml_use_internal_errors( false );
406
407
		$image_tags = $dom_doc->getElementsByTagName( 'img' );
408
409
		// For each image Tag, make sure it can be added to the $images array, and add it.
410
		foreach ( $image_tags as $image_tag ) {
411
			$img_src = $image_tag->getAttribute( 'src' );
412
413
			if ( empty( $img_src ) ) {
414
				continue;
415
			}
416
417
			// Do not grab smiley images that were automatically created by WP when entering text smilies.
418
			if ( stripos( $img_src, '/smilies/' ) ) {
419
				continue;
420
			}
421
422
			$meta = array(
423
				'width'    => (int) $image_tag->getAttribute( 'width' ),
424
				'height'   => (int) $image_tag->getAttribute( 'height' ),
425
				'alt_text' => $image_tag->getAttribute( 'alt' ),
426
			);
427
428
			/**
429
			 * Filters the switch to ignore minimum image size requirements. Can be used
430
			 * to add custom logic to image dimensions, like only enforcing one of the dimensions,
431
			 * or disabling it entirely.
432
			 *
433
			 * @since 6.4.0
434
			 *
435
			 * @param bool $ignore Should the image dimensions be ignored?
436
			 * @param array $meta Array containing image dimensions parsed from the markup.
437
			 */
438
			$ignore_dimensions = apply_filters( 'jetpack_postimages_ignore_minimum_dimensions', false, $meta );
439
440
			// Must be larger than 200x200 (or user-specified).
441
			if (
442
				! $ignore_dimensions
443
				&& (
444
					empty( $meta['width'] )
445
					|| empty( $meta['height'] )
446
					|| $meta['width'] < $width
447
					|| $meta['height'] < $height
448
				)
449
			) {
450
				continue;
451
			}
452
453
			$images[] = array(
454
				'type'       => 'image',
455
				'from'       => 'html',
456
				'src'        => $img_src,
457
				'src_width'  => $meta['width'],
458
				'src_height' => $meta['height'],
459
				'href'       => $html_info['post_url'],
460
				'alt_text'   => $meta['alt_text'],
461
			);
462
		}
463
		return $images;
464
	}
465
466
	/**
467
	 * @param    int $post_id The post ID to check
468
	 * @param    int $size
469
	 * @return Array containing details of the image, or empty array if none.
470
	 */
471
	static function from_blavatar( $post_id, $size = 96 ) {
472
473
		$permalink = get_permalink( $post_id );
474
475
		if ( function_exists( 'blavatar_domain' ) && function_exists( 'blavatar_exists' ) && function_exists( 'blavatar_url' ) ) {
476
			$domain = blavatar_domain( $permalink );
477
478
			if ( ! blavatar_exists( $domain ) ) {
479
				return array();
480
			}
481
482
			$url = blavatar_url( $domain, 'img', $size );
483
		} else {
484
			$url = get_site_icon_url( $size );
485
			if ( ! $url ) {
486
				return array();
487
			}
488
		}
489
490
		return array( array(
491
			'type'       => 'image',
492
			'from'       => 'blavatar',
493
			'src'        => $url,
494
			'src_width'  => $size,
495
			'src_height' => $size,
496
			'href'       => $permalink,
497
			'alt_text'   => '',
498
		) );
499
	}
500
501
	/**
502
	 * Gets a post image from the author avatar.
503
	 *
504
	 * @param int    $post_id The post ID to check.
505
	 * @param int    $size The size of the avatar to get.
506
	 * @param string $default The default image to use.
0 ignored issues
show
Should the type for parameter $default not be false|string?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
507
	 * @return Array containing details of the image, or empty array if none.
508
	 */
509
	static function from_gravatar( $post_id, $size = 96, $default = false ) {
510
		$post = get_post( $post_id );
511
		$permalink = get_permalink( $post_id );
512
513
		if ( function_exists( 'wpcom_get_avatar_url' ) ) {
514
			$url = wpcom_get_avatar_url( $post->post_author, $size, $default, true );
515
			if ( $url && is_array( $url ) ) {
516
				$url = $url[0];
517
			}
518
		} else {
519
			$url = get_avatar_url( $post->post_author, array(
520
				'size' => $size,
521
				'default' => $default,
522
			) );
523
		}
524
525
		return array(
526
			array(
527
				'type'       => 'image',
528
				'from'       => 'gravatar',
529
				'src'        => $url,
530
				'src_width'  => $size,
531
				'src_height' => $size,
532
				'href'       => $permalink,
533
				'alt_text'   => '',
534
			),
535
		);
536
	}
537
538
	/**
539
	 * Run through the different methods that we have available to try to find a single good
540
	 * display image for this post.
541
	 * @param  int $post_id
542
	 * @param array $args Other arguments (currently width and height required for images where possible to determine)
543
	 * @return Array containing details of the best image to be used
544
	 */
545
	static function get_image( $post_id, $args = array() ) {
546
		$image = '';
547
548
		/**
549
		 * Fires before we find a single good image for a specific post.
550
		 *
551
		 * @since 2.2.0
552
		 *
553
		 * @param int $post_id Post ID.
554
		 */
555
		do_action( 'jetpack_postimages_pre_get_image', $post_id );
556
		$media = self::get_images( $post_id, $args );
557
558
559
		if ( is_array( $media ) ) {
560
			foreach ( $media as $item ) {
561
				if ( 'image' == $item['type'] ) {
562
					$image = $item;
563
					break;
564
				}
565
			}
566
		}
567
568
		/**
569
		 * Fires after we find a single good image for a specific post.
570
		 *
571
		 * @since 2.2.0
572
		 *
573
		 * @param int $post_id Post ID.
574
		 */
575
		do_action( 'jetpack_postimages_post_get_image', $post_id );
576
577
		return $image;
578
	}
579
580
	/**
581
	 * Get an array containing a collection of possible images for this post, stopping once we hit a method
582
	 * that returns something useful.
583
	 * @param  int $post_id
584
	 * @param  array  $args Optional args, see defaults list for details
585
	 * @return Array containing images that would be good for representing this post
586
	 */
587
	static function get_images( $post_id, $args = array() ) {
588
		// Figure out which image to attach to this post.
589
		$media = false;
590
591
		/**
592
		 * Filters the array of images that would be good for a specific post.
593
		 * This filter is applied before options ($args) filter the original array.
594
		 *
595
		 * @since 2.0.0
596
		 *
597
		 * @param array $media Array of images that would be good for a specific post.
598
		 * @param int $post_id Post ID.
599
		 * @param array $args Array of options to get images.
600
		 */
601
		$media = apply_filters( 'jetpack_images_pre_get_images', $media, $post_id, $args );
602
		if ( $media )
603
			return $media;
604
605
		$defaults = array(
606
			'width'               => 200, // Required minimum width (if possible to determine)
607
			'height'              => 200, // Required minimum height (if possible to determine)
608
609
			'fallback_to_avatars' => false, // Optionally include Blavatar and Gravatar (in that order) in the image stack
610
			'avatar_size'         => 96, // Used for both Grav and Blav
611
			'gravatar_default'    => false, // Default image to use if we end up with no Gravatar
612
613
			'from_thumbnail'      => true, // Use these flags to specify which methods to use to find an image
614
			'from_slideshow'      => true,
615
			'from_gallery'        => true,
616
			'from_attachment'     => true,
617
			'from_blocks'         => true,
618
			'from_html'           => true,
619
620
			'html_content'        => '' // HTML string to pass to from_html()
621
		);
622
		$args = wp_parse_args( $args, $defaults );
623
624
		$media = false;
625
		if ( $args['from_thumbnail'] )
626
			$media = self::from_thumbnail( $post_id, $args['width'], $args['height'] );
627 View Code Duplication
		if ( !$media && $args['from_slideshow'] )
628
			$media = self::from_slideshow( $post_id, $args['width'], $args['height'] );
629
		if ( !$media && $args['from_gallery'] )
630
			$media = self::from_gallery( $post_id );
631 View Code Duplication
		if ( !$media && $args['from_attachment'] )
632
			$media = self::from_attachment( $post_id, $args['width'], $args['height'] );
633 View Code Duplication
		if ( ! $media && $args['from_blocks'] ) {
634
			if ( empty( $args['html_content'] ) )
635
				$media = self::from_blocks( $post_id, $args['width'], $args['height'] ); // Use the post_id, which will load the content
636
			else
637
				$media = self::from_blocks( $args['html_content'], $args['width'], $args['height'] ); // If html_content is provided, use that
638
		}
639 View Code Duplication
		if ( !$media && $args['from_html'] ) {
640
			if ( empty( $args['html_content'] ) )
641
				$media = self::from_html( $post_id, $args['width'], $args['height'] ); // Use the post_id, which will load the content
642
			else
643
				$media = self::from_html( $args['html_content'], $args['width'], $args['height'] ); // If html_content is provided, use that
644
		}
645
646
		if ( !$media && $args['fallback_to_avatars'] ) {
647
			$media = self::from_blavatar( $post_id, $args['avatar_size'] );
648
			if ( !$media )
0 ignored issues
show
Bug Best Practice introduced by
The expression $media of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
649
				$media = self::from_gravatar( $post_id, $args['avatar_size'], $args['gravatar_default'] );
650
		}
651
652
		/**
653
		 * Filters the array of images that would be good for a specific post.
654
		 * This filter is applied after options ($args) filter the original array.
655
		 *
656
		 * @since 2.0.0
657
		 *
658
		 * @param array $media Array of images that would be good for a specific post.
659
		 * @param int $post_id Post ID.
660
		 * @param array $args Array of options to get images.
661
		 */
662
		return apply_filters( 'jetpack_images_get_images', $media, $post_id, $args );
663
	}
664
665
	/**
666
	 * Takes an image URL and pixel dimensions then returns a URL for the
667
	 * resized and cropped image.
668
	 *
669
	 * @param  string $src
670
	 * @param  int    $dimension
0 ignored issues
show
There is no parameter named $dimension. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
671
	 * @return string            Transformed image URL
672
	 */
673
	static function fit_image_url( $src, $width, $height ) {
674
		$width = (int) $width;
675
		$height = (int) $height;
676
677
		if ( $width < 1 || $height < 1 ) {
678
			return $src;
679
		}
680
681
		// See if we should bypass WordPress.com SaaS resizing
682
		if ( has_filter( 'jetpack_images_fit_image_url_override' ) ) {
683
			/**
684
			 * Filters the image URL used after dimensions are set by Photon.
685
			 *
686
			 * @since 3.3.0
687
			 *
688
			 * @param string $src Image URL.
689
			 * @param int $width Image width.
690
			 * @param int $width Image height.
691
			 */
692
			return apply_filters( 'jetpack_images_fit_image_url_override', $src, $width, $height );
693
		}
694
695
		// If WPCOM hosted image use native transformations
696
		$img_host = parse_url( $src, PHP_URL_HOST );
697
		if ( '.files.wordpress.com' == substr( $img_host, -20 ) ) {
698
			return add_query_arg( array( 'w' => $width, 'h' => $height, 'crop' => 1 ), set_url_scheme( $src ) );
699
		}
700
701
		// Use Photon magic
702
		if( function_exists( 'jetpack_photon_url' ) ) {
703
			return jetpack_photon_url( $src, array( 'resize' => "$width,$height" ) );
704
		}
705
706
		// Arg... no way to resize image using WordPress.com infrastructure!
707
		return $src;
708
	}
709
710
	/**
711
	 * Get HTML from given post content.
712
	 *
713
	 * @since 6.9.0
714
	 *
715
	 * @param mixed $html_or_id The HTML string to parse for images, or a post id.
716
	 *
717
	 * @return array $html_info {
718
	 * @type string $html     Post content.
719
	 * @type string $post_url Post URL.
720
	 * }
721
	 */
722
	static function get_post_html( $html_or_id ) {
723
		if ( is_numeric( $html_or_id ) ) {
724
			$post = get_post( $html_or_id );
725
726
			if ( empty( $post ) || ! empty( $post->post_password ) ) {
727
				return '';
728
			}
729
730
			$html_info = array(
731
				'html'     => $post->post_content, // DO NOT apply the_content filters here, it will cause loops.
732
				'post_url' => get_permalink( $post->ID ),
733
			);
734
		} else {
735
			$html_info = array(
736
				'html'     => $html_or_id,
737
				'post_url' => '',
738
			);
739
		}
740
		return $html_info;
741
	}
742
743
	/**
744
	 * Get info about a WordPress attachment.
745
	 *
746
	 * @since 6.9.0
747
	 *
748
	 * @param int    $attachment_id Attachment ID.
749
	 * @param string $post_url      URL of the post, if we have one.
750
	 * @param int    $width         Minimum Image width.
751
	 * @param int    $height        Minimum Image height.
752
	 * @return array|bool           Image data or false if unavailable.
753
	 */
754
	public static function get_attachment_data( $attachment_id, $post_url = '', $width, $height ) {
755
		if ( empty( $attachment_id ) ) {
756
			return false;
757
		}
758
759
		$meta = wp_get_attachment_metadata( $attachment_id );
760
761
		// The image must be larger than 200x200.
762
		if ( ! isset( $meta['width'] ) || $meta['width'] < $width ) {
763
			return false;
764
		}
765
		if ( ! isset( $meta['height'] ) || $meta['height'] < $height ) {
766
			return false;
767
		}
768
769
		$url = wp_get_attachment_url( $attachment_id );
770
771
		return array(
772
			'type'       => 'image',
773
			'from'       => 'attachment',
774
			'src'        => $url,
775
			'src_width'  => $meta['width'],
776
			'src_height' => $meta['height'],
777
			'href'       => $post_url,
778
			'alt_text'   => self::get_alt_text( $attachment_id ),
779
		);
780
	}
781
782
	/**
783
	 * Get the alt text for an image or other media from the Media Library.
784
	 *
785
	 * @since 7.1
786
	 *
787
	 * @param int $attachment_id The Post ID of the media.
788
	 * @return string The alt text value or an emptry string.
789
	 */
790
	public static function get_alt_text( $attachment_id ) {
791
		return get_post_meta( $attachment_id, '_wp_attachment_image_alt', true );
792
	}
793
}
794