Completed
Push — try/remote-ui ( 69fd78 )
by
unknown
06:35
created

Jetpack_PostImages::from_thumbnail()   F

Complexity

Conditions 26
Paths 215

Size

Total Lines 81

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 26
nc 215
nop 3
dl 0
loc 81
rs 3.1458
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

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
Bug introduced by
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
		$blocks = parse_blocks( $html_info['html'] );
331
		if ( empty( $blocks ) ) {
332
			return $images;
333
		}
334
335
		foreach ( $blocks as $block ) {
336
			/**
337
			 * Parse content from Core Image blocks.
338
			 * If it is an image block for an image hosted on our site, it will have an ID.
339
			 * If it does not have an ID, let `from_html` parse that content later,
340
			 * and extract an image if it has size parameters.
341
			 */
342
			if (
343
				'core/image' === $block['blockName']
344
				&& ! empty( $block['attrs']['id'] )
345
			) {
346
				$images[] = self::get_attachment_data( $block['attrs']['id'], $html_info['post_url'], $width, $height );
347
			}
348
349
			/**
350
			 * Parse content from Core Gallery blocks as well from Jetpack's Tiled Gallery and Slideshow blocks.
351
			 * Gallery blocks include the ID of each one of the images in the gallery.
352
			 */
353
			if ( in_array( $block['blockName'], array( 'core/gallery', 'jetpack/tiled-gallery', 'jetpack/slideshow' ) )
354
				&& ! empty( $block['attrs']['ids'] )
355
			) {
356
				foreach ( $block['attrs']['ids'] as $img_id ) {
357
					$images[] = self::get_attachment_data( $img_id, $html_info['post_url'], $width, $height );
358
				}
359
			}
360
		}
361
362
		/**
363
		 * Returning a filtered array because get_attachment_data returns false
364
		 * for unsuccessful attempts.
365
		 */
366
		return array_filter( $images );
367
	}
368
369
	/**
370
	 * Very raw -- just parse the HTML and pull out any/all img tags and return their src
371
	 *
372
	 * @param mixed $html_or_id The HTML string to parse for images, or a post id.
373
	 * @param int   $width      Minimum Image width.
374
	 * @param int   $height     Minimum Image height.
375
	 *
376
	 * @uses DOMDocument
377
	 *
378
	 * @return Array containing images
379
	 */
380
	static function from_html( $html_or_id, $width = 200, $height = 200 ) {
381
		$images = array();
382
383
		$html_info = self::get_post_html( $html_or_id );
384
385
		if ( empty( $html_info['html'] ) ) {
386
			return $images;
387
		}
388
389
		// Do not go any further if DOMDocument is disabled on the server.
390
		if ( ! class_exists( 'DOMDocument' ) ) {
391
			return $images;
392
		}
393
394
		// Let's grab all image tags from the HTML.
395
		$dom_doc = new DOMDocument;
396
397
		// The @ is not enough to suppress errors when dealing with libxml,
398
		// we have to tell it directly how we want to handle errors.
399
		libxml_use_internal_errors( true );
400
		@$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...
401
		libxml_use_internal_errors( false );
402
403
		$image_tags = $dom_doc->getElementsByTagName( 'img' );
404
405
		// For each image Tag, make sure it can be added to the $images array, and add it.
406
		foreach ( $image_tags as $image_tag ) {
407
			$img_src = $image_tag->getAttribute( 'src' );
408
409
			if ( empty( $img_src ) ) {
410
				continue;
411
			}
412
413
			// Do not grab smiley images that were automatically created by WP when entering text smilies.
414
			if ( stripos( $img_src, '/smilies/' ) ) {
415
				continue;
416
			}
417
418
			$meta = array(
419
				'width'    => (int) $image_tag->getAttribute( 'width' ),
420
				'height'   => (int) $image_tag->getAttribute( 'height' ),
421
				'alt_text' => $image_tag->getAttribute( 'alt' ),
422
			);
423
424
			/**
425
			 * Filters the switch to ignore minimum image size requirements. Can be used
426
			 * to add custom logic to image dimensions, like only enforcing one of the dimensions,
427
			 * or disabling it entirely.
428
			 *
429
			 * @since 6.4.0
430
			 *
431
			 * @param bool $ignore Should the image dimensions be ignored?
432
			 * @param array $meta Array containing image dimensions parsed from the markup.
433
			 */
434
			$ignore_dimensions = apply_filters( 'jetpack_postimages_ignore_minimum_dimensions', false, $meta );
435
436
			// Must be larger than 200x200 (or user-specified).
437
			if (
438
				! $ignore_dimensions
439
				&& (
440
					empty( $meta['width'] )
441
					|| empty( $meta['height'] )
442
					|| $meta['width'] < $width
443
					|| $meta['height'] < $height
444
				)
445
			) {
446
				continue;
447
			}
448
449
			$images[] = array(
450
				'type'       => 'image',
451
				'from'       => 'html',
452
				'src'        => $img_src,
453
				'src_width'  => $meta['width'],
454
				'src_height' => $meta['height'],
455
				'href'       => $html_info['post_url'],
456
				'alt_text'   => $meta['alt_text'],
457
			);
458
		}
459
		return $images;
460
	}
461
462
	/**
463
	 * @param    int $post_id The post ID to check
464
	 * @param    int $size
465
	 * @return Array containing details of the image, or empty array if none.
466
	 */
467
	static function from_blavatar( $post_id, $size = 96 ) {
468
469
		$permalink = get_permalink( $post_id );
470
471
		if ( function_exists( 'blavatar_domain' ) && function_exists( 'blavatar_exists' ) && function_exists( 'blavatar_url' ) ) {
472
			$domain = blavatar_domain( $permalink );
473
474
			if ( ! blavatar_exists( $domain ) ) {
475
				return array();
476
			}
477
478
			$url = blavatar_url( $domain, 'img', $size );
479
		} else {
480
			$url = get_site_icon_url( $size );
481
			if ( ! $url ) {
482
				return array();
483
			}
484
		}
485
486
		return array( array(
487
			'type'       => 'image',
488
			'from'       => 'blavatar',
489
			'src'        => $url,
490
			'src_width'  => $size,
491
			'src_height' => $size,
492
			'href'       => $permalink,
493
			'alt_text'   => '',
494
		) );
495
	}
496
497
	/**
498
	 * Gets a post image from the author avatar.
499
	 *
500
	 * @param int    $post_id The post ID to check.
501
	 * @param int    $size The size of the avatar to get.
502
	 * @param string $default The default image to use.
0 ignored issues
show
Documentation introduced by
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...
503
	 * @return Array containing details of the image, or empty array if none.
504
	 */
505
	static function from_gravatar( $post_id, $size = 96, $default = false ) {
506
		$post = get_post( $post_id );
507
		$permalink = get_permalink( $post_id );
508
509
		if ( function_exists( 'wpcom_get_avatar_url' ) ) {
510
			$url = wpcom_get_avatar_url( $post->post_author, $size, $default, true );
511
			if ( $url && is_array( $url ) ) {
512
				$url = $url[0];
513
			}
514
		} else {
515
			$url = get_avatar_url( $post->post_author, array(
516
				'size' => $size,
517
				'default' => $default,
518
			) );
519
		}
520
521
		return array(
522
			array(
523
				'type'       => 'image',
524
				'from'       => 'gravatar',
525
				'src'        => $url,
526
				'src_width'  => $size,
527
				'src_height' => $size,
528
				'href'       => $permalink,
529
				'alt_text'   => '',
530
			),
531
		);
532
	}
533
534
	/**
535
	 * Run through the different methods that we have available to try to find a single good
536
	 * display image for this post.
537
	 * @param  int $post_id
538
	 * @param array $args Other arguments (currently width and height required for images where possible to determine)
539
	 * @return Array containing details of the best image to be used
540
	 */
541
	static function get_image( $post_id, $args = array() ) {
542
		$image = '';
543
544
		/**
545
		 * Fires before we find a single good image for a specific post.
546
		 *
547
		 * @since 2.2.0
548
		 *
549
		 * @param int $post_id Post ID.
550
		 */
551
		do_action( 'jetpack_postimages_pre_get_image', $post_id );
552
		$media = self::get_images( $post_id, $args );
553
554
555
		if ( is_array( $media ) ) {
556
			foreach ( $media as $item ) {
557
				if ( 'image' == $item['type'] ) {
558
					$image = $item;
559
					break;
560
				}
561
			}
562
		}
563
564
		/**
565
		 * Fires after we find a single good image for a specific post.
566
		 *
567
		 * @since 2.2.0
568
		 *
569
		 * @param int $post_id Post ID.
570
		 */
571
		do_action( 'jetpack_postimages_post_get_image', $post_id );
572
573
		return $image;
574
	}
575
576
	/**
577
	 * Get an array containing a collection of possible images for this post, stopping once we hit a method
578
	 * that returns something useful.
579
	 * @param  int $post_id
580
	 * @param  array  $args Optional args, see defaults list for details
581
	 * @return Array containing images that would be good for representing this post
582
	 */
583
	static function get_images( $post_id, $args = array() ) {
584
		// Figure out which image to attach to this post.
585
		$media = false;
586
587
		/**
588
		 * Filters the array of images that would be good for a specific post.
589
		 * This filter is applied before options ($args) filter the original array.
590
		 *
591
		 * @since 2.0.0
592
		 *
593
		 * @param array $media Array of images that would be good for a specific post.
594
		 * @param int $post_id Post ID.
595
		 * @param array $args Array of options to get images.
596
		 */
597
		$media = apply_filters( 'jetpack_images_pre_get_images', $media, $post_id, $args );
598
		if ( $media )
599
			return $media;
600
601
		$defaults = array(
602
			'width'               => 200, // Required minimum width (if possible to determine)
603
			'height'              => 200, // Required minimum height (if possible to determine)
604
605
			'fallback_to_avatars' => false, // Optionally include Blavatar and Gravatar (in that order) in the image stack
606
			'avatar_size'         => 96, // Used for both Grav and Blav
607
			'gravatar_default'    => false, // Default image to use if we end up with no Gravatar
608
609
			'from_thumbnail'      => true, // Use these flags to specify which methods to use to find an image
610
			'from_slideshow'      => true,
611
			'from_gallery'        => true,
612
			'from_attachment'     => true,
613
			'from_blocks'         => true,
614
			'from_html'           => true,
615
616
			'html_content'        => '' // HTML string to pass to from_html()
617
		);
618
		$args = wp_parse_args( $args, $defaults );
619
620
		$media = false;
621
		if ( $args['from_thumbnail'] )
622
			$media = self::from_thumbnail( $post_id, $args['width'], $args['height'] );
623 View Code Duplication
		if ( !$media && $args['from_slideshow'] )
624
			$media = self::from_slideshow( $post_id, $args['width'], $args['height'] );
625
		if ( !$media && $args['from_gallery'] )
626
			$media = self::from_gallery( $post_id );
627 View Code Duplication
		if ( !$media && $args['from_attachment'] )
628
			$media = self::from_attachment( $post_id, $args['width'], $args['height'] );
629 View Code Duplication
		if ( ! $media && $args['from_blocks'] ) {
630
			if ( empty( $args['html_content'] ) )
631
				$media = self::from_blocks( $post_id, $args['width'], $args['height'] ); // Use the post_id, which will load the content
632
			else
633
				$media = self::from_blocks( $args['html_content'], $args['width'], $args['height'] ); // If html_content is provided, use that
634
		}
635 View Code Duplication
		if ( !$media && $args['from_html'] ) {
636
			if ( empty( $args['html_content'] ) )
637
				$media = self::from_html( $post_id, $args['width'], $args['height'] ); // Use the post_id, which will load the content
638
			else
639
				$media = self::from_html( $args['html_content'], $args['width'], $args['height'] ); // If html_content is provided, use that
640
		}
641
642
		if ( !$media && $args['fallback_to_avatars'] ) {
643
			$media = self::from_blavatar( $post_id, $args['avatar_size'] );
644
			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...
645
				$media = self::from_gravatar( $post_id, $args['avatar_size'], $args['gravatar_default'] );
646
		}
647
648
		/**
649
		 * Filters the array of images that would be good for a specific post.
650
		 * This filter is applied after options ($args) filter the original array.
651
		 *
652
		 * @since 2.0.0
653
		 *
654
		 * @param array $media Array of images that would be good for a specific post.
655
		 * @param int $post_id Post ID.
656
		 * @param array $args Array of options to get images.
657
		 */
658
		return apply_filters( 'jetpack_images_get_images', $media, $post_id, $args );
659
	}
660
661
	/**
662
	 * Takes an image URL and pixel dimensions then returns a URL for the
663
	 * resized and cropped image.
664
	 *
665
	 * @param  string $src
666
	 * @param  int    $dimension
0 ignored issues
show
Bug introduced by
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...
667
	 * @return string            Transformed image URL
668
	 */
669
	static function fit_image_url( $src, $width, $height ) {
670
		$width = (int) $width;
671
		$height = (int) $height;
672
673
		if ( $width < 1 || $height < 1 ) {
674
			return $src;
675
		}
676
677
		// See if we should bypass WordPress.com SaaS resizing
678
		if ( has_filter( 'jetpack_images_fit_image_url_override' ) ) {
679
			/**
680
			 * Filters the image URL used after dimensions are set by Photon.
681
			 *
682
			 * @since 3.3.0
683
			 *
684
			 * @param string $src Image URL.
685
			 * @param int $width Image width.
686
			 * @param int $width Image height.
687
			 */
688
			return apply_filters( 'jetpack_images_fit_image_url_override', $src, $width, $height );
689
		}
690
691
		// If WPCOM hosted image use native transformations
692
		$img_host = parse_url( $src, PHP_URL_HOST );
693
		if ( '.files.wordpress.com' == substr( $img_host, -20 ) ) {
694
			return add_query_arg( array( 'w' => $width, 'h' => $height, 'crop' => 1 ), set_url_scheme( $src ) );
695
		}
696
697
		// Use Photon magic
698
		if( function_exists( 'jetpack_photon_url' ) ) {
699
			return jetpack_photon_url( $src, array( 'resize' => "$width,$height" ) );
700
		}
701
702
		// Arg... no way to resize image using WordPress.com infrastructure!
703
		return $src;
704
	}
705
706
	/**
707
	 * Get HTML from given post content.
708
	 *
709
	 * @since 6.9.0
710
	 *
711
	 * @param mixed $html_or_id The HTML string to parse for images, or a post id.
712
	 *
713
	 * @return array $html_info {
714
	 * @type string $html     Post content.
715
	 * @type string $post_url Post URL.
716
	 * }
717
	 */
718
	static function get_post_html( $html_or_id ) {
719
		if ( is_numeric( $html_or_id ) ) {
720
			$post = get_post( $html_or_id );
721
722
			if ( empty( $post ) || ! empty( $post->post_password ) ) {
723
				return '';
724
			}
725
726
			$html_info = array(
727
				'html'     => $post->post_content, // DO NOT apply the_content filters here, it will cause loops.
728
				'post_url' => get_permalink( $post->ID ),
729
			);
730
		} else {
731
			$html_info = array(
732
				'html'     => $html_or_id,
733
				'post_url' => '',
734
			);
735
		}
736
		return $html_info;
737
	}
738
739
	/**
740
	 * Get info about a WordPress attachment.
741
	 *
742
	 * @since 6.9.0
743
	 *
744
	 * @param int    $attachment_id Attachment ID.
745
	 * @param string $post_url      URL of the post, if we have one.
746
	 * @param int    $width         Minimum Image width.
747
	 * @param int    $height        Minimum Image height.
748
	 * @return array|bool           Image data or false if unavailable.
749
	 */
750
	public static function get_attachment_data( $attachment_id, $post_url = '', $width, $height ) {
751
		if ( empty( $attachment_id ) ) {
752
			return false;
753
		}
754
755
		$meta = wp_get_attachment_metadata( $attachment_id );
756
757
		// The image must be larger than 200x200.
758
		if ( ! isset( $meta['width'] ) || $meta['width'] < $width ) {
759
			return false;
760
		}
761
		if ( ! isset( $meta['height'] ) || $meta['height'] < $height ) {
762
			return false;
763
		}
764
765
		$url = wp_get_attachment_url( $attachment_id );
766
767
		return array(
768
			'type'       => 'image',
769
			'from'       => 'attachment',
770
			'src'        => $url,
771
			'src_width'  => $meta['width'],
772
			'src_height' => $meta['height'],
773
			'href'       => $post_url,
774
			'alt_text'   => self::get_alt_text( $attachment_id ),
775
		);
776
	}
777
778
	/**
779
	 * Get the alt text for an image or other media from the Media Library.
780
	 *
781
	 * @since 7.1
782
	 *
783
	 * @param int $attachment_id The Post ID of the media.
784
	 * @return string The alt text value or an emptry string.
785
	 */
786
	public static function get_alt_text( $attachment_id ) {
787
		return get_post_meta( $attachment_id, '_wp_attachment_image_alt', true );
788
	}
789
}
790