1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
|
<?php
/**
* Useful for finding an image to display alongside/in representation of a specific post.
*
* Includes a few different methods, all of which return a similar-format array containing
* details of any images found. Everything can (should) be called statically, it's just a
* function-bucket. You can also call Jetpack_PostImages::get_image() to cycle through all of the methods until
* one of them finds something useful.
*
* This file is included verbatim in Jetpack
*/
class Jetpack_PostImages {
/**
* If a slideshow is embedded within a post, then parse out the images involved and return them
*/
static function from_slideshow( $post_id, $width = 200, $height = 200 ) {
$images = array();
$post = get_post( $post_id );
if ( ! $post ) {
return $images;
}
if ( ! empty( $post->post_password ) ) {
return $images;
}
if ( false === has_shortcode( $post->post_content, 'slideshow' ) ) {
return $images; // no slideshow - bail
}
$permalink = get_permalink( $post->ID );
// Mechanic: Somebody set us up the bomb
$old_post = $GLOBALS['post'];
$GLOBALS['post'] = $post;
$old_shortcodes = $GLOBALS['shortcode_tags'];
$GLOBALS['shortcode_tags'] = array( 'slideshow' => $old_shortcodes['slideshow'] );
// Find all the slideshows
preg_match_all( '/' . get_shortcode_regex() . '/sx', $post->post_content, $slideshow_matches, PREG_SET_ORDER );
ob_start(); // The slideshow shortcode handler calls wp_print_scripts and wp_print_styles... not too happy about that
foreach ( $slideshow_matches as $slideshow_match ) {
$slideshow = do_shortcode_tag( $slideshow_match );
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
continue;
$start = strpos( $slideshow, '[', $pos );
$end = strpos( $slideshow, ']', $start );
$post_images = json_decode( wp_specialchars_decode( str_replace( "'", '"', substr( $slideshow, $start, $end - $start + 1 ) ), ENT_QUOTES ) ); // parse via JSON
// If the JSON didn't decode don't try and act on it.
if ( is_array( $post_images ) ) {
foreach ( $post_images as $post_image ) {
if ( !$post_image_id = absint( $post_image->id ) )
continue;
$meta = wp_get_attachment_metadata( $post_image_id );
// Must be larger than 200x200 (or user-specified)
if ( !isset( $meta['width'] ) || $meta['width'] < $width )
continue;
if ( !isset( $meta['height'] ) || $meta['height'] < $height )
continue;
$url = wp_get_attachment_url( $post_image_id );
$images[] = array(
'type' => 'image',
'from' => 'slideshow',
'src' => $url,
'src_width' => $meta['width'],
'src_height' => $meta['height'],
'href' => $permalink,
);
}
}
}
ob_end_clean();
// Operator: Main screen turn on
$GLOBALS['shortcode_tags'] = $old_shortcodes;
$GLOBALS['post'] = $old_post;
return $images;
}
/**
* If a gallery is detected, then get all the images from it.
*/
static function from_gallery( $post_id ) {
$images = array();
$post = get_post( $post_id );
if ( ! $post ) {
return $images;
}
if ( ! empty( $post->post_password ) ) {
return $images;
}
$permalink = get_permalink( $post->ID );
/**
* Juggle global post object because the gallery shortcode uses the
* global object.
*
* See core ticket:
* https://core.trac.wordpress.org/ticket/39304
*/
if ( isset( $GLOBALS['post'] ) ) {
$juggle_post = $GLOBALS['post'];
$GLOBALS['post'] = $post;
$galleries = get_post_galleries( $post->ID, false );
$GLOBALS['post'] = $juggle_post;
} else {
$GLOBALS['post'] = $post;
$galleries = get_post_galleries( $post->ID, false );
unset( $GLOBALS['post'] );
}
foreach ( $galleries as $gallery ) {
if ( isset( $gallery['type'] ) && 'slideshow' === $gallery['type'] && ! empty( $gallery['ids'] ) ) {
$image_ids = explode( ',', $gallery['ids'] );
$image_size = isset( $gallery['size'] ) ? $gallery['size'] : 'thumbnail';
foreach ( $image_ids as $image_id ) {
$image = wp_get_attachment_image_src( $image_id, $image_size );
if ( ! empty( $image[0] ) ) {
list( $raw_src ) = explode( '?', $image[0] ); // pull off any Query string (?w=250)
$raw_src = wp_specialchars_decode( $raw_src ); // rawify it
$raw_src = esc_url_raw( $raw_src ); // clean it
$images[] = array(
'type' => 'image',
'from' => 'gallery',
'src' => $raw_src,
'href' => $permalink,
);
}
}
} elseif ( ! empty( $gallery['src'] ) ) {
foreach ( $gallery['src'] as $src ) {
list( $raw_src ) = explode( '?', $src ); // pull off any Query string (?w=250)
$raw_src = wp_specialchars_decode( $raw_src ); // rawify it
$raw_src = esc_url_raw( $raw_src ); // clean it
$images[] = array(
'type' => 'image',
'from' => 'gallery',
'src' => $raw_src,
'href' => $permalink,
);
}
}
}
return $images;
}
/**
* Get attachment images for a specified post and return them. Also make sure
* their dimensions are at or above a required minimum.
*/
static function from_attachment( $post_id, $width = 200, $height = 200 ) {
$images = array();
$post = get_post( $post_id );
if ( ! empty( $post->post_password ) ) {
return $images;
}
$post_images = get_posts( array(
'post_parent' => $post_id, // Must be children of post
'numberposts' => 5, // No more than 5
'post_type' => 'attachment', // Must be attachments
'post_mime_type' => 'image', // Must be images
'suppress_filters' => false,
) );
if ( ! $post_images ) {
return $images;
}
$permalink = get_permalink( $post_id );
foreach ( $post_images as $post_image ) {
$meta = wp_get_attachment_metadata( $post_image->ID );
// Must be larger than 200x200
if ( !isset( $meta['width'] ) || $meta['width'] < $width )
continue;
if ( !isset( $meta['height'] ) || $meta['height'] < $height )
continue;
$url = wp_get_attachment_url( $post_image->ID );
$images[] = array(
'type' => 'image',
'from' => 'attachment',
'src' => $url,
'src_width' => $meta['width'],
'src_height' => $meta['height'],
'href' => $permalink,
);
}
/*
* We only want to pass back attached images that were actually inserted.
* We can load up all the images found in the HTML source and then
* compare URLs to see if an image is attached AND inserted.
*/
$html_images = self::from_html( $post_id );
$inserted_images = array();
foreach( $html_images as $html_image ) {
$src = parse_url( $html_image['src'] );
// strip off any query strings from src
if( ! empty( $src['scheme'] ) && ! empty( $src['host'] ) ) {
$inserted_images[] = $src['scheme'] . '://' . $src['host'] . $src['path'];
} elseif( ! empty( $src['host'] ) ) {
$inserted_images[] = set_url_scheme( 'http://' . $src['host'] . $src['path'] );
} else {
$inserted_images[] = site_url( '/' ) . $src['path'];
}
}
foreach( $images as $i => $image ) {
if ( !in_array( $image['src'], $inserted_images ) )
unset( $images[$i] );
}
return $images;
}
/**
* Check if a Featured Image is set for this post, and return it in a similar
* format to the other images?_from_*() methods.
* @param int $post_id The post ID to check
* @return Array containing details of the Featured Image, or empty array if none.
*/
static function from_thumbnail( $post_id, $width = 200, $height = 200 ) {
$images = array();
$post = get_post( $post_id );
if ( ! empty( $post->post_password ) ) {
return $images;
}
if ( ! function_exists( 'get_post_thumbnail_id' ) ) {
return $images;
}
$thumb = get_post_thumbnail_id( $post_id );
if ( $thumb ) {
$meta = wp_get_attachment_metadata( $thumb );
// Must be larger than requested minimums
if ( !isset( $meta['width'] ) || $meta['width'] < $width )
return $images;
if ( !isset( $meta['height'] ) || $meta['height'] < $height )
return $images;
$too_big = ( ( ! empty( $meta['width'] ) && $meta['width'] > 1200 ) || ( ! empty( $meta['height'] ) && $meta['height'] > 1200 ) );
if (
$too_big &&
(
( method_exists( 'Jetpack', 'is_module_active' ) && Jetpack::is_module_active( 'photon' ) ) ||
( defined( 'IS_WPCOM' ) && IS_WPCOM )
)
) {
$img_src = wp_get_attachment_image_src( $thumb, array( 1200, 1200 ) );
} else {
$img_src = wp_get_attachment_image_src( $thumb, 'full' );
}
if ( ! is_array( $img_src ) ) {
// If wp_get_attachment_image_src returns false but we know that there should be an image that could be used.
// we try a bit harder and user the data that we have.
$thumb_post_data = get_post( $thumb );
$img_src = array( $thumb_post_data->guid, $meta['width'], $meta['height'] );
}
$url = $img_src[0];
$images = array( array( // Other methods below all return an array of arrays
'type' => 'image',
'from' => 'thumbnail',
'src' => $url,
'src_width' => $img_src[1],
'src_height' => $img_src[2],
'href' => get_permalink( $thumb ),
) );
}
if ( empty( $images ) && ( defined( 'IS_WPCOM' ) && IS_WPCOM ) ) {
$meta_thumbnail = get_post_meta( $post_id, '_jetpack_post_thumbnail', true );
if ( ! empty( $meta_thumbnail ) ) {
if ( ! isset( $meta_thumbnail['width'] ) || $meta_thumbnail['width'] < $width ) {
return $images;
}
if ( ! isset( $meta_thumbnail['height'] ) || $meta_thumbnail['height'] < $height ) {
return $images;
}
$images = array( array( // Other methods below all return an array of arrays
'type' => 'image',
'from' => 'thumbnail',
'src' => $meta_thumbnail['URL'],
'src_width' => $meta_thumbnail['width'],
'src_height' => $meta_thumbnail['height'],
'href' => $meta_thumbnail['URL'],
) );
}
}
return $images;
}
/**
* Very raw -- just parse the HTML and pull out any/all img tags and return their src
*
* @param mixed $html_or_id The HTML string to parse for images, or a post id.
* @param int $width Minimum Image width.
* @param int $height Minimum Image height.
*
* @uses DOMDocument
*
* @return Array containing images
*/
static function from_html( $html_or_id, $width = 200, $height = 200 ) {
$images = array();
if ( is_numeric( $html_or_id ) ) {
$post = get_post( $html_or_id );
if ( empty( $post ) || ! empty( $post->post_password ) ) {
return $images;
}
$html = $post->post_content; // DO NOT apply the_content filters here, it will cause loops.
} else {
$html = $html_or_id;
}
if ( ! $html ) {
return $images;
}
// Do not go any further if DOMDocument is disabled on the server.
if ( ! class_exists( 'DOMDocument' ) ) {
return $images;
}
// Let's grab all image tags from the HTML.
$dom_doc = new DOMDocument;
// The @ is not enough to suppress errors when dealing with libxml,
// we have to tell it directly how we want to handle errors.
libxml_use_internal_errors( true );
@$dom_doc->loadHTML( $html );
libxml_use_internal_errors( false );
$image_tags = $dom_doc->getElementsByTagName( 'img' );
// For each image Tag, make sure it can be added to the $images array, and add it.
foreach ( $image_tags as $image_tag ) {
$img_src = $image_tag->getAttribute( 'src' );
if ( empty( $img_src ) ) {
continue;
}
// Do not grab smiley images that were automatically created by WP when entering text smilies.
if ( stripos( $img_src, '/smilies/' ) ) {
continue;
}
$meta = array(
'width' => (int) $image_tag->getAttribute( 'width' ),
'height' => (int) $image_tag->getAttribute( 'height' ),
);
/**
* Filters the switch to ignore minimum image size requirements. Can be used
* to add custom logic to image dimensions, like only enforcing one of the dimensions,
* or disabling it entirely.
*
* @since 6.4.0
*
* @param bool $ignore Should the image dimensions be ignored?
* @param array $meta Array containing image dimensions parsed from the markup.
*/
$ignore_dimensions = apply_filters( 'jetpack_postimages_ignore_minimum_dimensions', false, $meta );
// Must be larger than 200x200 (or user-specified).
if (
! $ignore_dimensions
&& (
empty( $meta['width'] )
|| empty( $meta['height'] )
|| $meta['width'] < $width
|| $meta['height'] < $height
)
) {
continue;
}
$images[] = array(
'type' => 'image',
'from' => 'html',
'src' => $img_src,
'src_width' => $meta['width'],
'src_height' => $meta['height'],
'href' => '', // No link to apply to these. Might potentially parse for that as well, but not for now.
);
}
return $images;
}
/**
* @param int $post_id The post ID to check
* @param int $size
* @return Array containing details of the image, or empty array if none.
*/
static function from_blavatar( $post_id, $size = 96 ) {
$permalink = get_permalink( $post_id );
if ( function_exists( 'blavatar_domain' ) && function_exists( 'blavatar_exists' ) && function_exists( 'blavatar_url' ) ) {
$domain = blavatar_domain( $permalink );
if ( ! blavatar_exists( $domain ) ) {
return array();
}
$url = blavatar_url( $domain, 'img', $size );
} elseif ( function_exists( 'has_site_icon' ) && has_site_icon() ) {
$url = get_site_icon_url( $size );
} else {
return array();
}
return array( array(
'type' => 'image',
'from' => 'blavatar',
'src' => $url,
'src_width' => $size,
'src_height' => $size,
'href' => $permalink,
) );
}
/**
* Gets a post image from the author avatar.
*
* @param int $post_id The post ID to check.
* @param int $size The size of the avatar to get.
* @param string $default The default image to use.
* @return Array containing details of the image, or empty array if none.
*/
static function from_gravatar( $post_id, $size = 96, $default = false ) {
$post = get_post( $post_id );
$permalink = get_permalink( $post_id );
if ( function_exists( 'wpcom_get_avatar_url' ) ) {
$url = wpcom_get_avatar_url( $post->post_author, $size, $default, true );
if ( $url && is_array( $url ) ) {
$url = $url[0];
}
} else {
$url = get_avatar_url( $post->post_author, array(
'size' => $size,
'default' => $default,
) );
}
return array(
array(
'type' => 'image',
'from' => 'gravatar',
'src' => $url,
'src_width' => $size,
'src_height' => $size,
'href' => $permalink,
),
);
}
/**
* Run through the different methods that we have available to try to find a single good
* display image for this post.
* @param int $post_id
* @param array $args Other arguments (currently width and height required for images where possible to determine)
* @return Array containing details of the best image to be used
*/
static function get_image( $post_id, $args = array() ) {
$image = '';
/**
* Fires before we find a single good image for a specific post.
*
* @since 2.2.0
*
* @param int $post_id Post ID.
*/
do_action( 'jetpack_postimages_pre_get_image', $post_id );
$media = self::get_images( $post_id, $args );
if ( is_array( $media ) ) {
foreach ( $media as $item ) {
if ( 'image' == $item['type'] ) {
$image = $item;
break;
}
}
}
/**
* Fires after we find a single good image for a specific post.
*
* @since 2.2.0
*
* @param int $post_id Post ID.
*/
do_action( 'jetpack_postimages_post_get_image', $post_id );
return $image;
}
/**
* Get an array containing a collection of possible images for this post, stopping once we hit a method
* that returns something useful.
* @param int $post_id
* @param array $args Optional args, see defaults list for details
* @return Array containing images that would be good for representing this post
*/
static function get_images( $post_id, $args = array() ) {
// Figure out which image to attach to this post.
$media = false;
/**
* Filters the array of images that would be good for a specific post.
* This filter is applied before options ($args) filter the original array.
*
* @since 2.0.0
*
* @param array $media Array of images that would be good for a specific post.
* @param int $post_id Post ID.
* @param array $args Array of options to get images.
*/
$media = apply_filters( 'jetpack_images_pre_get_images', $media, $post_id, $args );
if ( $media )
return $media;
$defaults = array(
'width' => 200, // Required minimum width (if possible to determine)
'height' => 200, // Required minimum height (if possible to determine)
'fallback_to_avatars' => false, // Optionally include Blavatar and Gravatar (in that order) in the image stack
'avatar_size' => 96, // Used for both Grav and Blav
'gravatar_default' => false, // Default image to use if we end up with no Gravatar
'from_thumbnail' => true, // Use these flags to specify which methods to use to find an image
'from_slideshow' => true,
'from_gallery' => true,
'from_attachment' => true,
'from_html' => true,
'html_content' => '' // HTML string to pass to from_html()
);
$args = wp_parse_args( $args, $defaults );
$media = false;
if ( $args['from_thumbnail'] )
$media = self::from_thumbnail( $post_id, $args['width'], $args['height'] );
if ( !$media && $args['from_slideshow'] )
$media = self::from_slideshow( $post_id, $args['width'], $args['height'] );
if ( !$media && $args['from_gallery'] )
$media = self::from_gallery( $post_id );
if ( !$media && $args['from_attachment'] )
$media = self::from_attachment( $post_id, $args['width'], $args['height'] );
if ( !$media && $args['from_html'] ) {
if ( empty( $args['html_content'] ) )
$media = self::from_html( $post_id, $args['width'], $args['height'] ); // Use the post_id, which will load the content
else
$media = self::from_html( $args['html_content'], $args['width'], $args['height'] ); // If html_content is provided, use that
}
if ( !$media && $args['fallback_to_avatars'] ) {
$media = self::from_blavatar( $post_id, $args['avatar_size'] );
if ( !$media )
$media = self::from_gravatar( $post_id, $args['avatar_size'], $args['gravatar_default'] );
}
/**
* Filters the array of images that would be good for a specific post.
* This filter is applied after options ($args) filter the original array.
*
* @since 2.0.0
*
* @param array $media Array of images that would be good for a specific post.
* @param int $post_id Post ID.
* @param array $args Array of options to get images.
*/
return apply_filters( 'jetpack_images_get_images', $media, $post_id, $args );
}
/**
* Takes an image URL and pixel dimensions then returns a URL for the
* resized and cropped image.
*
* @param string $src
* @param int $dimension
* @return string Transformed image URL
*/
static function fit_image_url( $src, $width, $height ) {
$width = (int) $width;
$height = (int) $height;
if ( $width < 1 || $height < 1 ) {
return $src;
}
// See if we should bypass WordPress.com SaaS resizing
if ( has_filter( 'jetpack_images_fit_image_url_override' ) ) {
/**
* Filters the image URL used after dimensions are set by Photon.
*
* @since 3.3.0
*
* @param string $src Image URL.
* @param int $width Image width.
* @param int $width Image height.
*/
return apply_filters( 'jetpack_images_fit_image_url_override', $src, $width, $height );
}
// If WPCOM hosted image use native transformations
$img_host = parse_url( $src, PHP_URL_HOST );
if ( '.files.wordpress.com' == substr( $img_host, -20 ) ) {
return add_query_arg( array( 'w' => $width, 'h' => $height, 'crop' => 1 ), set_url_scheme( $src ) );
}
// Use Photon magic
if( function_exists( 'jetpack_photon_url' ) ) {
return jetpack_photon_url( $src, array( 'resize' => "$width,$height" ) );
}
// Arg... no way to resize image using WordPress.com infrastructure!
return $src;
}
}
|