WordPress 4.7
[autoinstalls/wordpress.git] / wp-includes / media.php
1 <?php
2 /**
3  * WordPress API for media display.
4  *
5  * @package WordPress
6  * @subpackage Media
7  */
8
9 /**
10  * Retrieve additional image sizes.
11  *
12  * @since 4.7.0
13  *
14  * @global array $_wp_additional_image_sizes
15  *
16  * @return array Additional images size data.
17  */
18 function wp_get_additional_image_sizes() {
19         global $_wp_additional_image_sizes;
20         if ( ! $_wp_additional_image_sizes ) {
21                 $_wp_additional_image_sizes = array();
22         }
23         return $_wp_additional_image_sizes;
24 }
25
26 /**
27  * Scale down the default size of an image.
28  *
29  * This is so that the image is a better fit for the editor and theme.
30  *
31  * The `$size` parameter accepts either an array or a string. The supported string
32  * values are 'thumb' or 'thumbnail' for the given thumbnail size or defaults at
33  * 128 width and 96 height in pixels. Also supported for the string value is
34  * 'medium', 'medium_large' and 'full'. The 'full' isn't actually supported, but any value other
35  * than the supported will result in the content_width size or 500 if that is
36  * not set.
37  *
38  * Finally, there is a filter named {@see 'editor_max_image_size'}, that will be
39  * called on the calculated array for width and height, respectively. The second
40  * parameter will be the value that was in the $size parameter. The returned
41  * type for the hook is an array with the width as the first element and the
42  * height as the second element.
43  *
44  * @since 2.5.0
45  *
46  * @global int   $content_width
47  *
48  * @param int          $width   Width of the image in pixels.
49  * @param int          $height  Height of the image in pixels.
50  * @param string|array $size    Optional. Image size. Accepts any valid image size, or an array
51  *                              of width and height values in pixels (in that order).
52  *                              Default 'medium'.
53  * @param string       $context Optional. Could be 'display' (like in a theme) or 'edit'
54  *                              (like inserting into an editor). Default null.
55  * @return array Width and height of what the result image should resize to.
56  */
57 function image_constrain_size_for_editor( $width, $height, $size = 'medium', $context = null ) {
58         global $content_width;
59
60         $_wp_additional_image_sizes = wp_get_additional_image_sizes();
61
62         if ( ! $context )
63                 $context = is_admin() ? 'edit' : 'display';
64
65         if ( is_array($size) ) {
66                 $max_width = $size[0];
67                 $max_height = $size[1];
68         }
69         elseif ( $size == 'thumb' || $size == 'thumbnail' ) {
70                 $max_width = intval(get_option('thumbnail_size_w'));
71                 $max_height = intval(get_option('thumbnail_size_h'));
72                 // last chance thumbnail size defaults
73                 if ( !$max_width && !$max_height ) {
74                         $max_width = 128;
75                         $max_height = 96;
76                 }
77         }
78         elseif ( $size == 'medium' ) {
79                 $max_width = intval(get_option('medium_size_w'));
80                 $max_height = intval(get_option('medium_size_h'));
81
82         }
83         elseif ( $size == 'medium_large' ) {
84                 $max_width = intval( get_option( 'medium_large_size_w' ) );
85                 $max_height = intval( get_option( 'medium_large_size_h' ) );
86
87                 if ( intval( $content_width ) > 0 ) {
88                         $max_width = min( intval( $content_width ), $max_width );
89                 }
90         }
91         elseif ( $size == 'large' ) {
92                 /*
93                  * We're inserting a large size image into the editor. If it's a really
94                  * big image we'll scale it down to fit reasonably within the editor
95                  * itself, and within the theme's content width if it's known. The user
96                  * can resize it in the editor if they wish.
97                  */
98                 $max_width = intval(get_option('large_size_w'));
99                 $max_height = intval(get_option('large_size_h'));
100                 if ( intval($content_width) > 0 ) {
101                         $max_width = min( intval($content_width), $max_width );
102                 }
103         } elseif ( ! empty( $_wp_additional_image_sizes ) && in_array( $size, array_keys( $_wp_additional_image_sizes ) ) ) {
104                 $max_width = intval( $_wp_additional_image_sizes[$size]['width'] );
105                 $max_height = intval( $_wp_additional_image_sizes[$size]['height'] );
106                 // Only in admin. Assume that theme authors know what they're doing.
107                 if ( intval( $content_width ) > 0 && 'edit' === $context ) {
108                         $max_width = min( intval( $content_width ), $max_width );
109                 }
110         }
111         // $size == 'full' has no constraint
112         else {
113                 $max_width = $width;
114                 $max_height = $height;
115         }
116
117         /**
118          * Filters the maximum image size dimensions for the editor.
119          *
120          * @since 2.5.0
121          *
122          * @param array        $max_image_size An array with the width as the first element,
123          *                                     and the height as the second element.
124          * @param string|array $size           Size of what the result image should be.
125          * @param string       $context        The context the image is being resized for.
126          *                                     Possible values are 'display' (like in a theme)
127          *                                     or 'edit' (like inserting into an editor).
128          */
129         list( $max_width, $max_height ) = apply_filters( 'editor_max_image_size', array( $max_width, $max_height ), $size, $context );
130
131         return wp_constrain_dimensions( $width, $height, $max_width, $max_height );
132 }
133
134 /**
135  * Retrieve width and height attributes using given width and height values.
136  *
137  * Both attributes are required in the sense that both parameters must have a
138  * value, but are optional in that if you set them to false or null, then they
139  * will not be added to the returned string.
140  *
141  * You can set the value using a string, but it will only take numeric values.
142  * If you wish to put 'px' after the numbers, then it will be stripped out of
143  * the return.
144  *
145  * @since 2.5.0
146  *
147  * @param int|string $width  Image width in pixels.
148  * @param int|string $height Image height in pixels.
149  * @return string HTML attributes for width and, or height.
150  */
151 function image_hwstring( $width, $height ) {
152         $out = '';
153         if ($width)
154                 $out .= 'width="'.intval($width).'" ';
155         if ($height)
156                 $out .= 'height="'.intval($height).'" ';
157         return $out;
158 }
159
160 /**
161  * Scale an image to fit a particular size (such as 'thumb' or 'medium').
162  *
163  * Array with image url, width, height, and whether is intermediate size, in
164  * that order is returned on success is returned. $is_intermediate is true if
165  * $url is a resized image, false if it is the original.
166  *
167  * The URL might be the original image, or it might be a resized version. This
168  * function won't create a new resized copy, it will just return an already
169  * resized one if it exists.
170  *
171  * A plugin may use the {@see 'image_downsize'} filter to hook into and offer image
172  * resizing services for images. The hook must return an array with the same
173  * elements that are returned in the function. The first element being the URL
174  * to the new image that was resized.
175  *
176  * @since 2.5.0
177  *
178  * @param int          $id   Attachment ID for image.
179  * @param array|string $size Optional. Image size to scale to. Accepts any valid image size,
180  *                           or an array of width and height values in pixels (in that order).
181  *                           Default 'medium'.
182  * @return false|array Array containing the image URL, width, height, and boolean for whether
183  *                     the image is an intermediate size. False on failure.
184  */
185 function image_downsize( $id, $size = 'medium' ) {
186         $is_image = wp_attachment_is_image( $id );
187
188         /**
189          * Filters whether to preempt the output of image_downsize().
190          *
191          * Passing a truthy value to the filter will effectively short-circuit
192          * down-sizing the image, returning that value as output instead.
193          *
194          * @since 2.5.0
195          *
196          * @param bool         $downsize Whether to short-circuit the image downsize. Default false.
197          * @param int          $id       Attachment ID for image.
198          * @param array|string $size     Size of image. Image size or array of width and height values (in that order).
199          *                               Default 'medium'.
200          */
201         if ( $out = apply_filters( 'image_downsize', false, $id, $size ) ) {
202                 return $out;
203         }
204
205         $img_url = wp_get_attachment_url($id);
206         $meta = wp_get_attachment_metadata($id);
207         $width = $height = 0;
208         $is_intermediate = false;
209         $img_url_basename = wp_basename($img_url);
210
211         // If the file isn't an image, attempt to replace its URL with a rendered image from its meta.
212         // Otherwise, a non-image type could be returned.
213         if ( ! $is_image ) {
214                 if ( ! empty( $meta['sizes'] ) ) {
215                         $img_url = str_replace( $img_url_basename, $meta['sizes']['full']['file'], $img_url );
216                         $img_url_basename = $meta['sizes']['full']['file'];
217                         $width = $meta['sizes']['full']['width'];
218                         $height = $meta['sizes']['full']['height'];
219                 } else {
220                         return false;
221                 }
222         }
223
224         // try for a new style intermediate size
225         if ( $intermediate = image_get_intermediate_size($id, $size) ) {
226                 $img_url = str_replace($img_url_basename, $intermediate['file'], $img_url);
227                 $width = $intermediate['width'];
228                 $height = $intermediate['height'];
229                 $is_intermediate = true;
230         }
231         elseif ( $size == 'thumbnail' ) {
232                 // fall back to the old thumbnail
233                 if ( ($thumb_file = wp_get_attachment_thumb_file($id)) && $info = getimagesize($thumb_file) ) {
234                         $img_url = str_replace($img_url_basename, wp_basename($thumb_file), $img_url);
235                         $width = $info[0];
236                         $height = $info[1];
237                         $is_intermediate = true;
238                 }
239         }
240         if ( !$width && !$height && isset( $meta['width'], $meta['height'] ) ) {
241                 // any other type: use the real image
242                 $width = $meta['width'];
243                 $height = $meta['height'];
244         }
245
246         if ( $img_url) {
247                 // we have the actual image size, but might need to further constrain it if content_width is narrower
248                 list( $width, $height ) = image_constrain_size_for_editor( $width, $height, $size );
249
250                 return array( $img_url, $width, $height, $is_intermediate );
251         }
252         return false;
253
254 }
255
256 /**
257  * Register a new image size.
258  *
259  * Cropping behavior for the image size is dependent on the value of $crop:
260  * 1. If false (default), images will be scaled, not cropped.
261  * 2. If an array in the form of array( x_crop_position, y_crop_position ):
262  *    - x_crop_position accepts 'left' 'center', or 'right'.
263  *    - y_crop_position accepts 'top', 'center', or 'bottom'.
264  *    Images will be cropped to the specified dimensions within the defined crop area.
265  * 3. If true, images will be cropped to the specified dimensions using center positions.
266  *
267  * @since 2.9.0
268  *
269  * @global array $_wp_additional_image_sizes Associative array of additional image sizes.
270  *
271  * @param string     $name   Image size identifier.
272  * @param int        $width  Image width in pixels.
273  * @param int        $height Image height in pixels.
274  * @param bool|array $crop   Optional. Whether to crop images to specified width and height or resize.
275  *                           An array can specify positioning of the crop area. Default false.
276  */
277 function add_image_size( $name, $width = 0, $height = 0, $crop = false ) {
278         global $_wp_additional_image_sizes;
279
280         $_wp_additional_image_sizes[ $name ] = array(
281                 'width'  => absint( $width ),
282                 'height' => absint( $height ),
283                 'crop'   => $crop,
284         );
285 }
286
287 /**
288  * Check if an image size exists.
289  *
290  * @since 3.9.0
291  *
292  * @param string $name The image size to check.
293  * @return bool True if the image size exists, false if not.
294  */
295 function has_image_size( $name ) {
296         $sizes = wp_get_additional_image_sizes();
297         return isset( $sizes[ $name ] );
298 }
299
300 /**
301  * Remove a new image size.
302  *
303  * @since 3.9.0
304  *
305  * @global array $_wp_additional_image_sizes
306  *
307  * @param string $name The image size to remove.
308  * @return bool True if the image size was successfully removed, false on failure.
309  */
310 function remove_image_size( $name ) {
311         global $_wp_additional_image_sizes;
312
313         if ( isset( $_wp_additional_image_sizes[ $name ] ) ) {
314                 unset( $_wp_additional_image_sizes[ $name ] );
315                 return true;
316         }
317
318         return false;
319 }
320
321 /**
322  * Registers an image size for the post thumbnail.
323  *
324  * @since 2.9.0
325  *
326  * @see add_image_size() for details on cropping behavior.
327  *
328  * @param int        $width  Image width in pixels.
329  * @param int        $height Image height in pixels.
330  * @param bool|array $crop   Optional. Whether to crop images to specified width and height or resize.
331  *                           An array can specify positioning of the crop area. Default false.
332  */
333 function set_post_thumbnail_size( $width = 0, $height = 0, $crop = false ) {
334         add_image_size( 'post-thumbnail', $width, $height, $crop );
335 }
336
337 /**
338  * Gets an img tag for an image attachment, scaling it down if requested.
339  *
340  * The {@see 'get_image_tag_class'} filter allows for changing the class name for the
341  * image without having to use regular expressions on the HTML content. The
342  * parameters are: what WordPress will use for the class, the Attachment ID,
343  * image align value, and the size the image should be.
344  *
345  * The second filter, {@see 'get_image_tag'}, has the HTML content, which can then be
346  * further manipulated by a plugin to change all attribute values and even HTML
347  * content.
348  *
349  * @since 2.5.0
350  *
351  * @param int          $id    Attachment ID.
352  * @param string       $alt   Image Description for the alt attribute.
353  * @param string       $title Image Description for the title attribute.
354  * @param string       $align Part of the class name for aligning the image.
355  * @param string|array $size  Optional. Registered image size to retrieve a tag for. Accepts any
356  *                            valid image size, or an array of width and height values in pixels
357  *                            (in that order). Default 'medium'.
358  * @return string HTML IMG element for given image attachment
359  */
360 function get_image_tag( $id, $alt, $title, $align, $size = 'medium' ) {
361
362         list( $img_src, $width, $height ) = image_downsize($id, $size);
363         $hwstring = image_hwstring($width, $height);
364
365         $title = $title ? 'title="' . esc_attr( $title ) . '" ' : '';
366
367         $class = 'align' . esc_attr($align) .' size-' . esc_attr($size) . ' wp-image-' . $id;
368
369         /**
370          * Filters the value of the attachment's image tag class attribute.
371          *
372          * @since 2.6.0
373          *
374          * @param string       $class CSS class name or space-separated list of classes.
375          * @param int          $id    Attachment ID.
376          * @param string       $align Part of the class name for aligning the image.
377          * @param string|array $size  Size of image. Image size or array of width and height values (in that order).
378          *                            Default 'medium'.
379          */
380         $class = apply_filters( 'get_image_tag_class', $class, $id, $align, $size );
381
382         $html = '<img src="' . esc_attr($img_src) . '" alt="' . esc_attr($alt) . '" ' . $title . $hwstring . 'class="' . $class . '" />';
383
384         /**
385          * Filters the HTML content for the image tag.
386          *
387          * @since 2.6.0
388          *
389          * @param string       $html  HTML content for the image.
390          * @param int          $id    Attachment ID.
391          * @param string       $alt   Alternate text.
392          * @param string       $title Attachment title.
393          * @param string       $align Part of the class name for aligning the image.
394          * @param string|array $size  Size of image. Image size or array of width and height values (in that order).
395          *                            Default 'medium'.
396          */
397         return apply_filters( 'get_image_tag', $html, $id, $alt, $title, $align, $size );
398 }
399
400 /**
401  * Calculates the new dimensions for a down-sampled image.
402  *
403  * If either width or height are empty, no constraint is applied on
404  * that dimension.
405  *
406  * @since 2.5.0
407  *
408  * @param int $current_width  Current width of the image.
409  * @param int $current_height Current height of the image.
410  * @param int $max_width      Optional. Max width in pixels to constrain to. Default 0.
411  * @param int $max_height     Optional. Max height in pixels to constrain to. Default 0.
412  * @return array First item is the width, the second item is the height.
413  */
414 function wp_constrain_dimensions( $current_width, $current_height, $max_width = 0, $max_height = 0 ) {
415         if ( !$max_width && !$max_height )
416                 return array( $current_width, $current_height );
417
418         $width_ratio = $height_ratio = 1.0;
419         $did_width = $did_height = false;
420
421         if ( $max_width > 0 && $current_width > 0 && $current_width > $max_width ) {
422                 $width_ratio = $max_width / $current_width;
423                 $did_width = true;
424         }
425
426         if ( $max_height > 0 && $current_height > 0 && $current_height > $max_height ) {
427                 $height_ratio = $max_height / $current_height;
428                 $did_height = true;
429         }
430
431         // Calculate the larger/smaller ratios
432         $smaller_ratio = min( $width_ratio, $height_ratio );
433         $larger_ratio  = max( $width_ratio, $height_ratio );
434
435         if ( (int) round( $current_width * $larger_ratio ) > $max_width || (int) round( $current_height * $larger_ratio ) > $max_height ) {
436                 // The larger ratio is too big. It would result in an overflow.
437                 $ratio = $smaller_ratio;
438         } else {
439                 // The larger ratio fits, and is likely to be a more "snug" fit.
440                 $ratio = $larger_ratio;
441         }
442
443         // Very small dimensions may result in 0, 1 should be the minimum.
444         $w = max ( 1, (int) round( $current_width  * $ratio ) );
445         $h = max ( 1, (int) round( $current_height * $ratio ) );
446
447         // Sometimes, due to rounding, we'll end up with a result like this: 465x700 in a 177x177 box is 117x176... a pixel short
448         // We also have issues with recursive calls resulting in an ever-changing result. Constraining to the result of a constraint should yield the original result.
449         // Thus we look for dimensions that are one pixel shy of the max value and bump them up
450
451         // Note: $did_width means it is possible $smaller_ratio == $width_ratio.
452         if ( $did_width && $w == $max_width - 1 ) {
453                 $w = $max_width; // Round it up
454         }
455
456         // Note: $did_height means it is possible $smaller_ratio == $height_ratio.
457         if ( $did_height && $h == $max_height - 1 ) {
458                 $h = $max_height; // Round it up
459         }
460
461         /**
462          * Filters dimensions to constrain down-sampled images to.
463          *
464          * @since 4.1.0
465          *
466          * @param array $dimensions     The image width and height.
467          * @param int   $current_width  The current width of the image.
468          * @param int   $current_height The current height of the image.
469          * @param int   $max_width      The maximum width permitted.
470          * @param int   $max_height     The maximum height permitted.
471          */
472         return apply_filters( 'wp_constrain_dimensions', array( $w, $h ), $current_width, $current_height, $max_width, $max_height );
473 }
474
475 /**
476  * Retrieves calculated resize dimensions for use in WP_Image_Editor.
477  *
478  * Calculates dimensions and coordinates for a resized image that fits
479  * within a specified width and height.
480  *
481  * Cropping behavior is dependent on the value of $crop:
482  * 1. If false (default), images will not be cropped.
483  * 2. If an array in the form of array( x_crop_position, y_crop_position ):
484  *    - x_crop_position accepts 'left' 'center', or 'right'.
485  *    - y_crop_position accepts 'top', 'center', or 'bottom'.
486  *    Images will be cropped to the specified dimensions within the defined crop area.
487  * 3. If true, images will be cropped to the specified dimensions using center positions.
488  *
489  * @since 2.5.0
490  *
491  * @param int        $orig_w Original width in pixels.
492  * @param int        $orig_h Original height in pixels.
493  * @param int        $dest_w New width in pixels.
494  * @param int        $dest_h New height in pixels.
495  * @param bool|array $crop   Optional. Whether to crop image to specified width and height or resize.
496  *                           An array can specify positioning of the crop area. Default false.
497  * @return false|array False on failure. Returned array matches parameters for `imagecopyresampled()`.
498  */
499 function image_resize_dimensions( $orig_w, $orig_h, $dest_w, $dest_h, $crop = false ) {
500
501         if ($orig_w <= 0 || $orig_h <= 0)
502                 return false;
503         // at least one of dest_w or dest_h must be specific
504         if ($dest_w <= 0 && $dest_h <= 0)
505                 return false;
506
507         /**
508          * Filters whether to preempt calculating the image resize dimensions.
509          *
510          * Passing a non-null value to the filter will effectively short-circuit
511          * image_resize_dimensions(), returning that value instead.
512          *
513          * @since 3.4.0
514          *
515          * @param null|mixed $null   Whether to preempt output of the resize dimensions.
516          * @param int        $orig_w Original width in pixels.
517          * @param int        $orig_h Original height in pixels.
518          * @param int        $dest_w New width in pixels.
519          * @param int        $dest_h New height in pixels.
520          * @param bool|array $crop   Whether to crop image to specified width and height or resize.
521          *                           An array can specify positioning of the crop area. Default false.
522          */
523         $output = apply_filters( 'image_resize_dimensions', null, $orig_w, $orig_h, $dest_w, $dest_h, $crop );
524         if ( null !== $output )
525                 return $output;
526
527         if ( $crop ) {
528                 // crop the largest possible portion of the original image that we can size to $dest_w x $dest_h
529                 $aspect_ratio = $orig_w / $orig_h;
530                 $new_w = min($dest_w, $orig_w);
531                 $new_h = min($dest_h, $orig_h);
532
533                 if ( ! $new_w ) {
534                         $new_w = (int) round( $new_h * $aspect_ratio );
535                 }
536
537                 if ( ! $new_h ) {
538                         $new_h = (int) round( $new_w / $aspect_ratio );
539                 }
540
541                 $size_ratio = max($new_w / $orig_w, $new_h / $orig_h);
542
543                 $crop_w = round($new_w / $size_ratio);
544                 $crop_h = round($new_h / $size_ratio);
545
546                 if ( ! is_array( $crop ) || count( $crop ) !== 2 ) {
547                         $crop = array( 'center', 'center' );
548                 }
549
550                 list( $x, $y ) = $crop;
551
552                 if ( 'left' === $x ) {
553                         $s_x = 0;
554                 } elseif ( 'right' === $x ) {
555                         $s_x = $orig_w - $crop_w;
556                 } else {
557                         $s_x = floor( ( $orig_w - $crop_w ) / 2 );
558                 }
559
560                 if ( 'top' === $y ) {
561                         $s_y = 0;
562                 } elseif ( 'bottom' === $y ) {
563                         $s_y = $orig_h - $crop_h;
564                 } else {
565                         $s_y = floor( ( $orig_h - $crop_h ) / 2 );
566                 }
567         } else {
568                 // don't crop, just resize using $dest_w x $dest_h as a maximum bounding box
569                 $crop_w = $orig_w;
570                 $crop_h = $orig_h;
571
572                 $s_x = 0;
573                 $s_y = 0;
574
575                 list( $new_w, $new_h ) = wp_constrain_dimensions( $orig_w, $orig_h, $dest_w, $dest_h );
576         }
577
578         // if the resulting image would be the same size or larger we don't want to resize it
579         if ( $new_w >= $orig_w && $new_h >= $orig_h && $dest_w != $orig_w && $dest_h != $orig_h ) {
580                 return false;
581         }
582
583         // the return array matches the parameters to imagecopyresampled()
584         // int dst_x, int dst_y, int src_x, int src_y, int dst_w, int dst_h, int src_w, int src_h
585         return array( 0, 0, (int) $s_x, (int) $s_y, (int) $new_w, (int) $new_h, (int) $crop_w, (int) $crop_h );
586
587 }
588
589 /**
590  * Resizes an image to make a thumbnail or intermediate size.
591  *
592  * The returned array has the file size, the image width, and image height. The
593  * {@see 'image_make_intermediate_size'} filter can be used to hook in and change the
594  * values of the returned array. The only parameter is the resized file path.
595  *
596  * @since 2.5.0
597  *
598  * @param string $file   File path.
599  * @param int    $width  Image width.
600  * @param int    $height Image height.
601  * @param bool   $crop   Optional. Whether to crop image to specified width and height or resize.
602  *                       Default false.
603  * @return false|array False, if no image was created. Metadata array on success.
604  */
605 function image_make_intermediate_size( $file, $width, $height, $crop = false ) {
606         if ( $width || $height ) {
607                 $editor = wp_get_image_editor( $file );
608
609                 if ( is_wp_error( $editor ) || is_wp_error( $editor->resize( $width, $height, $crop ) ) )
610                         return false;
611
612                 $resized_file = $editor->save();
613
614                 if ( ! is_wp_error( $resized_file ) && $resized_file ) {
615                         unset( $resized_file['path'] );
616                         return $resized_file;
617                 }
618         }
619         return false;
620 }
621
622 /**
623  * Helper function to test if aspect ratios for two images match.
624  *
625  * @since 4.6.0
626  *
627  * @param int $source_width  Width of the first image in pixels.
628  * @param int $source_height Height of the first image in pixels.
629  * @param int $target_width  Width of the second image in pixels.
630  * @param int $target_height Height of the second image in pixels.
631  * @return bool True if aspect ratios match within 1px. False if not.
632  */
633 function wp_image_matches_ratio( $source_width, $source_height, $target_width, $target_height ) {
634         /*
635          * To test for varying crops, we constrain the dimensions of the larger image
636          * to the dimensions of the smaller image and see if they match.
637          */
638         if ( $source_width > $target_width ) {
639                 $constrained_size = wp_constrain_dimensions( $source_width, $source_height, $target_width );
640                 $expected_size = array( $target_width, $target_height );
641         } else {
642                 $constrained_size = wp_constrain_dimensions( $target_width, $target_height, $source_width );
643                 $expected_size = array( $source_width, $source_height );
644         }
645
646         // If the image dimensions are within 1px of the expected size, we consider it a match.
647         $matched = ( abs( $constrained_size[0] - $expected_size[0] ) <= 1 && abs( $constrained_size[1] - $expected_size[1] ) <= 1 );
648
649         return $matched;
650 }
651
652 /**
653  * Retrieves the image's intermediate size (resized) path, width, and height.
654  *
655  * The $size parameter can be an array with the width and height respectively.
656  * If the size matches the 'sizes' metadata array for width and height, then it
657  * will be used. If there is no direct match, then the nearest image size larger
658  * than the specified size will be used. If nothing is found, then the function
659  * will break out and return false.
660  *
661  * The metadata 'sizes' is used for compatible sizes that can be used for the
662  * parameter $size value.
663  *
664  * The url path will be given, when the $size parameter is a string.
665  *
666  * If you are passing an array for the $size, you should consider using
667  * add_image_size() so that a cropped version is generated. It's much more
668  * efficient than having to find the closest-sized image and then having the
669  * browser scale down the image.
670  *
671  * @since 2.5.0
672  *
673  * @param int          $post_id Attachment ID.
674  * @param array|string $size    Optional. Image size. Accepts any valid image size, or an array
675  *                              of width and height values in pixels (in that order).
676  *                              Default 'thumbnail'.
677  * @return false|array $data {
678  *     Array of file relative path, width, and height on success. Additionally includes absolute
679  *     path and URL if registered size is passed to $size parameter. False on failure.
680  *
681  *     @type string $file   Image's path relative to uploads directory
682  *     @type int    $width  Width of image
683  *     @type int    $height Height of image
684  *     @type string $path   Image's absolute filesystem path.
685  *     @type string $url    Image's URL.
686  * }
687  */
688 function image_get_intermediate_size( $post_id, $size = 'thumbnail' ) {
689         if ( ! $size || ! is_array( $imagedata = wp_get_attachment_metadata( $post_id ) ) || empty( $imagedata['sizes'] )  ) {
690                 return false;
691         }
692
693         $data = array();
694
695         // Find the best match when '$size' is an array.
696         if ( is_array( $size ) ) {
697                 $candidates = array();
698
699                 if ( ! isset( $imagedata['file'] ) && isset( $imagedata['sizes']['full'] ) ) {
700                         $imagedata['height'] = $imagedata['sizes']['full']['height'];
701                         $imagedata['width']  = $imagedata['sizes']['full']['width'];
702                 }
703
704                 foreach ( $imagedata['sizes'] as $_size => $data ) {
705                         // If there's an exact match to an existing image size, short circuit.
706                         if ( $data['width'] == $size[0] && $data['height'] == $size[1] ) {
707                                 $candidates[ $data['width'] * $data['height'] ] = $data;
708                                 break;
709                         }
710
711                         // If it's not an exact match, consider larger sizes with the same aspect ratio.
712                         if ( $data['width'] >= $size[0] && $data['height'] >= $size[1] ) {
713                                 // If '0' is passed to either size, we test ratios against the original file.
714                                 if ( 0 === $size[0] || 0 === $size[1] ) {
715                                         $same_ratio = wp_image_matches_ratio( $data['width'], $data['height'], $imagedata['width'], $imagedata['height'] );
716                                 } else {
717                                         $same_ratio = wp_image_matches_ratio( $data['width'], $data['height'], $size[0], $size[1] );
718                                 }
719
720                                 if ( $same_ratio ) {
721                                         $candidates[ $data['width'] * $data['height'] ] = $data;
722                                 }
723                         }
724                 }
725
726                 if ( ! empty( $candidates ) ) {
727                         // Sort the array by size if we have more than one candidate.
728                         if ( 1 < count( $candidates ) ) {
729                                 ksort( $candidates );
730                         }
731
732                         $data = array_shift( $candidates );
733                 /*
734                  * When the size requested is smaller than the thumbnail dimensions, we
735                  * fall back to the thumbnail size to maintain backwards compatibility with
736                  * pre 4.6 versions of WordPress.
737                  */
738                 } elseif ( ! empty( $imagedata['sizes']['thumbnail'] ) && $imagedata['sizes']['thumbnail']['width'] >= $size[0] && $imagedata['sizes']['thumbnail']['width'] >= $size[1] ) {
739                         $data = $imagedata['sizes']['thumbnail'];
740                 } else {
741                         return false;
742                 }
743
744                 // Constrain the width and height attributes to the requested values.
745                 list( $data['width'], $data['height'] ) = image_constrain_size_for_editor( $data['width'], $data['height'], $size );
746
747         } elseif ( ! empty( $imagedata['sizes'][ $size ] ) ) {
748                 $data = $imagedata['sizes'][ $size ];
749         }
750
751         // If we still don't have a match at this point, return false.
752         if ( empty( $data ) ) {
753                 return false;
754         }
755
756         // include the full filesystem path of the intermediate file
757         if ( empty( $data['path'] ) && ! empty( $data['file'] ) && ! empty( $imagedata['file'] ) ) {
758                 $file_url = wp_get_attachment_url($post_id);
759                 $data['path'] = path_join( dirname($imagedata['file']), $data['file'] );
760                 $data['url'] = path_join( dirname($file_url), $data['file'] );
761         }
762
763         /**
764          * Filters the output of image_get_intermediate_size()
765          *
766          * @since 4.4.0
767          *
768          * @see image_get_intermediate_size()
769          *
770          * @param array        $data    Array of file relative path, width, and height on success. May also include
771          *                              file absolute path and URL.
772          * @param int          $post_id The post_id of the image attachment
773          * @param string|array $size    Registered image size or flat array of initially-requested height and width
774          *                              dimensions (in that order).
775          */
776         return apply_filters( 'image_get_intermediate_size', $data, $post_id, $size );
777 }
778
779 /**
780  * Gets the available intermediate image sizes.
781  *
782  * @since 3.0.0
783  *
784  * @return array Returns a filtered array of image size strings.
785  */
786 function get_intermediate_image_sizes() {
787         $_wp_additional_image_sizes = wp_get_additional_image_sizes();
788         $image_sizes = array('thumbnail', 'medium', 'medium_large', 'large'); // Standard sizes
789         if ( ! empty( $_wp_additional_image_sizes ) ) {
790                 $image_sizes = array_merge( $image_sizes, array_keys( $_wp_additional_image_sizes ) );
791         }
792
793         /**
794          * Filters the list of intermediate image sizes.
795          *
796          * @since 2.5.0
797          *
798          * @param array $image_sizes An array of intermediate image sizes. Defaults
799          *                           are 'thumbnail', 'medium', 'medium_large', 'large'.
800          */
801         return apply_filters( 'intermediate_image_sizes', $image_sizes );
802 }
803
804 /**
805  * Retrieve an image to represent an attachment.
806  *
807  * A mime icon for files, thumbnail or intermediate size for images.
808  *
809  * The returned array contains four values: the URL of the attachment image src,
810  * the width of the image file, the height of the image file, and a boolean
811  * representing whether the returned array describes an intermediate (generated)
812  * image size or the original, full-sized upload.
813  *
814  * @since 2.5.0
815  *
816  * @param int          $attachment_id Image attachment ID.
817  * @param string|array $size          Optional. Image size. Accepts any valid image size, or an array of width
818  *                                    and height values in pixels (in that order). Default 'thumbnail'.
819  * @param bool         $icon          Optional. Whether the image should be treated as an icon. Default false.
820  * @return false|array Returns an array (url, width, height, is_intermediate), or false, if no image is available.
821  */
822 function wp_get_attachment_image_src( $attachment_id, $size = 'thumbnail', $icon = false ) {
823         // get a thumbnail or intermediate image if there is one
824         $image = image_downsize( $attachment_id, $size );
825         if ( ! $image ) {
826                 $src = false;
827
828                 if ( $icon && $src = wp_mime_type_icon( $attachment_id ) ) {
829                         /** This filter is documented in wp-includes/post.php */
830                         $icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/media' );
831
832                         $src_file = $icon_dir . '/' . wp_basename( $src );
833                         @list( $width, $height ) = getimagesize( $src_file );
834                 }
835
836                 if ( $src && $width && $height ) {
837                         $image = array( $src, $width, $height );
838                 }
839         }
840         /**
841          * Filters the image src result.
842          *
843          * @since 4.3.0
844          *
845          * @param array|false  $image         Either array with src, width & height, icon src, or false.
846          * @param int          $attachment_id Image attachment ID.
847          * @param string|array $size          Size of image. Image size or array of width and height values
848          *                                    (in that order). Default 'thumbnail'.
849          * @param bool         $icon          Whether the image should be treated as an icon. Default false.
850          */
851         return apply_filters( 'wp_get_attachment_image_src', $image, $attachment_id, $size, $icon );
852 }
853
854 /**
855  * Get an HTML img element representing an image attachment
856  *
857  * While `$size` will accept an array, it is better to register a size with
858  * add_image_size() so that a cropped version is generated. It's much more
859  * efficient than having to find the closest-sized image and then having the
860  * browser scale down the image.
861  *
862  * @since 2.5.0
863  *
864  * @param int          $attachment_id Image attachment ID.
865  * @param string|array $size          Optional. Image size. Accepts any valid image size, or an array of width
866  *                                    and height values in pixels (in that order). Default 'thumbnail'.
867  * @param bool         $icon          Optional. Whether the image should be treated as an icon. Default false.
868  * @param string|array $attr          Optional. Attributes for the image markup. Default empty.
869  * @return string HTML img element or empty string on failure.
870  */
871 function wp_get_attachment_image($attachment_id, $size = 'thumbnail', $icon = false, $attr = '') {
872         $html = '';
873         $image = wp_get_attachment_image_src($attachment_id, $size, $icon);
874         if ( $image ) {
875                 list($src, $width, $height) = $image;
876                 $hwstring = image_hwstring($width, $height);
877                 $size_class = $size;
878                 if ( is_array( $size_class ) ) {
879                         $size_class = join( 'x', $size_class );
880                 }
881                 $attachment = get_post($attachment_id);
882                 $default_attr = array(
883                         'src'   => $src,
884                         'class' => "attachment-$size_class size-$size_class",
885                         'alt'   => trim( strip_tags( get_post_meta( $attachment_id, '_wp_attachment_image_alt', true ) ) ),
886                 );
887
888                 $attr = wp_parse_args( $attr, $default_attr );
889
890                 // Generate 'srcset' and 'sizes' if not already present.
891                 if ( empty( $attr['srcset'] ) ) {
892                         $image_meta = wp_get_attachment_metadata( $attachment_id );
893
894                         if ( is_array( $image_meta ) ) {
895                                 $size_array = array( absint( $width ), absint( $height ) );
896                                 $srcset = wp_calculate_image_srcset( $size_array, $src, $image_meta, $attachment_id );
897                                 $sizes = wp_calculate_image_sizes( $size_array, $src, $image_meta, $attachment_id );
898
899                                 if ( $srcset && ( $sizes || ! empty( $attr['sizes'] ) ) ) {
900                                         $attr['srcset'] = $srcset;
901
902                                         if ( empty( $attr['sizes'] ) ) {
903                                                 $attr['sizes'] = $sizes;
904                                         }
905                                 }
906                         }
907                 }
908
909                 /**
910                  * Filters the list of attachment image attributes.
911                  *
912                  * @since 2.8.0
913                  *
914                  * @param array        $attr       Attributes for the image markup.
915                  * @param WP_Post      $attachment Image attachment post.
916                  * @param string|array $size       Requested size. Image size or array of width and height values
917                  *                                 (in that order). Default 'thumbnail'.
918                  */
919                 $attr = apply_filters( 'wp_get_attachment_image_attributes', $attr, $attachment, $size );
920                 $attr = array_map( 'esc_attr', $attr );
921                 $html = rtrim("<img $hwstring");
922                 foreach ( $attr as $name => $value ) {
923                         $html .= " $name=" . '"' . $value . '"';
924                 }
925                 $html .= ' />';
926         }
927
928         return $html;
929 }
930
931 /**
932  * Get the URL of an image attachment.
933  *
934  * @since 4.4.0
935  *
936  * @param int          $attachment_id Image attachment ID.
937  * @param string|array $size          Optional. Image size to retrieve. Accepts any valid image size, or an array
938  *                                    of width and height values in pixels (in that order). Default 'thumbnail'.
939  * @param bool         $icon          Optional. Whether the image should be treated as an icon. Default false.
940  * @return string|false Attachment URL or false if no image is available.
941  */
942 function wp_get_attachment_image_url( $attachment_id, $size = 'thumbnail', $icon = false ) {
943         $image = wp_get_attachment_image_src( $attachment_id, $size, $icon );
944         return isset( $image['0'] ) ? $image['0'] : false;
945 }
946
947 /**
948  * Get the attachment path relative to the upload directory.
949  *
950  * @since 4.4.1
951  * @access private
952  *
953  * @param string $file Attachment file name.
954  * @return string Attachment path relative to the upload directory.
955  */
956 function _wp_get_attachment_relative_path( $file ) {
957         $dirname = dirname( $file );
958
959         if ( '.' === $dirname ) {
960                 return '';
961         }
962
963         if ( false !== strpos( $dirname, 'wp-content/uploads' ) ) {
964                 // Get the directory name relative to the upload directory (back compat for pre-2.7 uploads)
965                 $dirname = substr( $dirname, strpos( $dirname, 'wp-content/uploads' ) + 18 );
966                 $dirname = ltrim( $dirname, '/' );
967         }
968
969         return $dirname;
970 }
971
972 /**
973  * Get the image size as array from its meta data.
974  *
975  * Used for responsive images.
976  *
977  * @since 4.4.0
978  * @access private
979  *
980  * @param string $size_name  Image size. Accepts any valid image size name ('thumbnail', 'medium', etc.).
981  * @param array  $image_meta The image meta data.
982  * @return array|bool Array of width and height values in pixels (in that order)
983  *                    or false if the size doesn't exist.
984  */
985 function _wp_get_image_size_from_meta( $size_name, $image_meta ) {
986         if ( $size_name === 'full' ) {
987                 return array(
988                         absint( $image_meta['width'] ),
989                         absint( $image_meta['height'] ),
990                 );
991         } elseif ( ! empty( $image_meta['sizes'][$size_name] ) ) {
992                 return array(
993                         absint( $image_meta['sizes'][$size_name]['width'] ),
994                         absint( $image_meta['sizes'][$size_name]['height'] ),
995                 );
996         }
997
998         return false;
999 }
1000
1001 /**
1002  * Retrieves the value for an image attachment's 'srcset' attribute.
1003  *
1004  * @since 4.4.0
1005  *
1006  * @see wp_calculate_image_srcset()
1007  *
1008  * @param int          $attachment_id Image attachment ID.
1009  * @param array|string $size          Optional. Image size. Accepts any valid image size, or an array of
1010  *                                    width and height values in pixels (in that order). Default 'medium'.
1011  * @param array        $image_meta    Optional. The image meta data as returned by 'wp_get_attachment_metadata()'.
1012  *                                    Default null.
1013  * @return string|bool A 'srcset' value string or false.
1014  */
1015 function wp_get_attachment_image_srcset( $attachment_id, $size = 'medium', $image_meta = null ) {
1016         if ( ! $image = wp_get_attachment_image_src( $attachment_id, $size ) ) {
1017                 return false;
1018         }
1019
1020         if ( ! is_array( $image_meta ) ) {
1021                 $image_meta = wp_get_attachment_metadata( $attachment_id );
1022         }
1023
1024         $image_src = $image[0];
1025         $size_array = array(
1026                 absint( $image[1] ),
1027                 absint( $image[2] )
1028         );
1029
1030         return wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attachment_id );
1031 }
1032
1033 /**
1034  * A helper function to calculate the image sources to include in a 'srcset' attribute.
1035  *
1036  * @since 4.4.0
1037  *
1038  * @param array  $size_array    Array of width and height values in pixels (in that order).
1039  * @param string $image_src     The 'src' of the image.
1040  * @param array  $image_meta    The image meta data as returned by 'wp_get_attachment_metadata()'.
1041  * @param int    $attachment_id Optional. The image attachment ID to pass to the filter. Default 0.
1042  * @return string|bool          The 'srcset' attribute value. False on error or when only one source exists.
1043  */
1044 function wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attachment_id = 0 ) {
1045         /**
1046          * Let plugins pre-filter the image meta to be able to fix inconsistencies in the stored data.
1047          *
1048          * @param array  $image_meta    The image meta data as returned by 'wp_get_attachment_metadata()'.
1049          * @param array  $size_array    Array of width and height values in pixels (in that order).
1050          * @param string $image_src     The 'src' of the image.
1051          * @param int    $attachment_id The image attachment ID or 0 if not supplied.
1052          */
1053         $image_meta = apply_filters( 'wp_calculate_image_srcset_meta', $image_meta, $size_array, $image_src, $attachment_id );
1054
1055         if ( empty( $image_meta['sizes'] ) || ! isset( $image_meta['file'] ) || strlen( $image_meta['file'] ) < 4 ) {
1056                 return false;
1057         }
1058
1059         $image_sizes = $image_meta['sizes'];
1060
1061         // Get the width and height of the image.
1062         $image_width = (int) $size_array[0];
1063         $image_height = (int) $size_array[1];
1064
1065         // Bail early if error/no width.
1066         if ( $image_width < 1 ) {
1067                 return false;
1068         }
1069
1070         $image_basename = wp_basename( $image_meta['file'] );
1071
1072         /*
1073          * WordPress flattens animated GIFs into one frame when generating intermediate sizes.
1074          * To avoid hiding animation in user content, if src is a full size GIF, a srcset attribute is not generated.
1075          * If src is an intermediate size GIF, the full size is excluded from srcset to keep a flattened GIF from becoming animated.
1076          */
1077         if ( ! isset( $image_sizes['thumbnail']['mime-type'] ) || 'image/gif' !== $image_sizes['thumbnail']['mime-type'] ) {
1078                 $image_sizes[] = array(
1079                         'width'  => $image_meta['width'],
1080                         'height' => $image_meta['height'],
1081                         'file'   => $image_basename,
1082                 );
1083         } elseif ( strpos( $image_src, $image_meta['file'] ) ) {
1084                 return false;
1085         }
1086
1087         // Retrieve the uploads sub-directory from the full size image.
1088         $dirname = _wp_get_attachment_relative_path( $image_meta['file'] );
1089
1090         if ( $dirname ) {
1091                 $dirname = trailingslashit( $dirname );
1092         }
1093
1094         $upload_dir = wp_get_upload_dir();
1095         $image_baseurl = trailingslashit( $upload_dir['baseurl'] ) . $dirname;
1096
1097         /*
1098          * If currently on HTTPS, prefer HTTPS URLs when we know they're supported by the domain
1099          * (which is to say, when they share the domain name of the current request).
1100          */
1101         if ( is_ssl() && 'https' !== substr( $image_baseurl, 0, 5 ) && parse_url( $image_baseurl, PHP_URL_HOST ) === $_SERVER['HTTP_HOST'] ) {
1102                 $image_baseurl = set_url_scheme( $image_baseurl, 'https' );
1103         }
1104
1105         /*
1106          * Images that have been edited in WordPress after being uploaded will
1107          * contain a unique hash. Look for that hash and use it later to filter
1108          * out images that are leftovers from previous versions.
1109          */
1110         $image_edited = preg_match( '/-e[0-9]{13}/', wp_basename( $image_src ), $image_edit_hash );
1111
1112         /**
1113          * Filters the maximum image width to be included in a 'srcset' attribute.
1114          *
1115          * @since 4.4.0
1116          *
1117          * @param int   $max_width  The maximum image width to be included in the 'srcset'. Default '1600'.
1118          * @param array $size_array Array of width and height values in pixels (in that order).
1119          */
1120         $max_srcset_image_width = apply_filters( 'max_srcset_image_width', 1600, $size_array );
1121
1122         // Array to hold URL candidates.
1123         $sources = array();
1124
1125         /**
1126          * To make sure the ID matches our image src, we will check to see if any sizes in our attachment
1127          * meta match our $image_src. If no matches are found we don't return a srcset to avoid serving
1128          * an incorrect image. See #35045.
1129          */
1130         $src_matched = false;
1131
1132         /*
1133          * Loop through available images. Only use images that are resized
1134          * versions of the same edit.
1135          */
1136         foreach ( $image_sizes as $image ) {
1137                 $is_src = false;
1138
1139                 // Check if image meta isn't corrupted.
1140                 if ( ! is_array( $image ) ) {
1141                         continue;
1142                 }
1143
1144                 // If the file name is part of the `src`, we've confirmed a match.
1145                 if ( ! $src_matched && false !== strpos( $image_src, $dirname . $image['file'] ) ) {
1146                         $src_matched = $is_src = true;
1147                 }
1148
1149                 // Filter out images that are from previous edits.
1150                 if ( $image_edited && ! strpos( $image['file'], $image_edit_hash[0] ) ) {
1151                         continue;
1152                 }
1153
1154                 /*
1155                  * Filters out images that are wider than '$max_srcset_image_width' unless
1156                  * that file is in the 'src' attribute.
1157                  */
1158                 if ( $max_srcset_image_width && $image['width'] > $max_srcset_image_width && ! $is_src ) {
1159                         continue;
1160                 }
1161
1162                 // If the image dimensions are within 1px of the expected size, use it.
1163                 if ( wp_image_matches_ratio( $image_width, $image_height, $image['width'], $image['height'] ) ) {
1164                         // Add the URL, descriptor, and value to the sources array to be returned.
1165                         $source = array(
1166                                 'url'        => $image_baseurl . $image['file'],
1167                                 'descriptor' => 'w',
1168                                 'value'      => $image['width'],
1169                         );
1170
1171                         // The 'src' image has to be the first in the 'srcset', because of a bug in iOS8. See #35030.
1172                         if ( $is_src ) {
1173                                 $sources = array( $image['width'] => $source ) + $sources;
1174                         } else {
1175                                 $sources[ $image['width'] ] = $source;
1176                         }
1177                 }
1178         }
1179
1180         /**
1181          * Filters an image's 'srcset' sources.
1182          *
1183          * @since 4.4.0
1184          *
1185          * @param array  $sources {
1186          *     One or more arrays of source data to include in the 'srcset'.
1187          *
1188          *     @type array $width {
1189          *         @type string $url        The URL of an image source.
1190          *         @type string $descriptor The descriptor type used in the image candidate string,
1191          *                                  either 'w' or 'x'.
1192          *         @type int    $value      The source width if paired with a 'w' descriptor, or a
1193          *                                  pixel density value if paired with an 'x' descriptor.
1194          *     }
1195          * }
1196          * @param array  $size_array    Array of width and height values in pixels (in that order).
1197          * @param string $image_src     The 'src' of the image.
1198          * @param array  $image_meta    The image meta data as returned by 'wp_get_attachment_metadata()'.
1199          * @param int    $attachment_id Image attachment ID or 0.
1200          */
1201         $sources = apply_filters( 'wp_calculate_image_srcset', $sources, $size_array, $image_src, $image_meta, $attachment_id );
1202
1203         // Only return a 'srcset' value if there is more than one source.
1204         if ( ! $src_matched || count( $sources ) < 2 ) {
1205                 return false;
1206         }
1207
1208         $srcset = '';
1209
1210         foreach ( $sources as $source ) {
1211                 $srcset .= str_replace( ' ', '%20', $source['url'] ) . ' ' . $source['value'] . $source['descriptor'] . ', ';
1212         }
1213
1214         return rtrim( $srcset, ', ' );
1215 }
1216
1217 /**
1218  * Retrieves the value for an image attachment's 'sizes' attribute.
1219  *
1220  * @since 4.4.0
1221  *
1222  * @see wp_calculate_image_sizes()
1223  *
1224  * @param int          $attachment_id Image attachment ID.
1225  * @param array|string $size          Optional. Image size. Accepts any valid image size, or an array of width
1226  *                                    and height values in pixels (in that order). Default 'medium'.
1227  * @param array        $image_meta    Optional. The image meta data as returned by 'wp_get_attachment_metadata()'.
1228  *                                    Default null.
1229  * @return string|bool A valid source size value for use in a 'sizes' attribute or false.
1230  */
1231 function wp_get_attachment_image_sizes( $attachment_id, $size = 'medium', $image_meta = null ) {
1232         if ( ! $image = wp_get_attachment_image_src( $attachment_id, $size ) ) {
1233                 return false;
1234         }
1235
1236         if ( ! is_array( $image_meta ) ) {
1237                 $image_meta = wp_get_attachment_metadata( $attachment_id );
1238         }
1239
1240         $image_src = $image[0];
1241         $size_array = array(
1242                 absint( $image[1] ),
1243                 absint( $image[2] )
1244         );
1245
1246         return wp_calculate_image_sizes( $size_array, $image_src, $image_meta, $attachment_id );
1247 }
1248
1249 /**
1250  * Creates a 'sizes' attribute value for an image.
1251  *
1252  * @since 4.4.0
1253  *
1254  * @param array|string $size          Image size to retrieve. Accepts any valid image size, or an array
1255  *                                    of width and height values in pixels (in that order). Default 'medium'.
1256  * @param string       $image_src     Optional. The URL to the image file. Default null.
1257  * @param array        $image_meta    Optional. The image meta data as returned by 'wp_get_attachment_metadata()'.
1258  *                                    Default null.
1259  * @param int          $attachment_id Optional. Image attachment ID. Either `$image_meta` or `$attachment_id`
1260  *                                    is needed when using the image size name as argument for `$size`. Default 0.
1261  * @return string|bool A valid source size value for use in a 'sizes' attribute or false.
1262  */
1263 function wp_calculate_image_sizes( $size, $image_src = null, $image_meta = null, $attachment_id = 0 ) {
1264         $width = 0;
1265
1266         if ( is_array( $size ) ) {
1267                 $width = absint( $size[0] );
1268         } elseif ( is_string( $size ) ) {
1269                 if ( ! $image_meta && $attachment_id ) {
1270                         $image_meta = wp_get_attachment_metadata( $attachment_id );
1271                 }
1272
1273                 if ( is_array( $image_meta ) ) {
1274                         $size_array = _wp_get_image_size_from_meta( $size, $image_meta );
1275                         if ( $size_array ) {
1276                                 $width = absint( $size_array[0] );
1277                         }
1278                 }
1279         }
1280
1281         if ( ! $width ) {
1282                 return false;
1283         }
1284
1285         // Setup the default 'sizes' attribute.
1286         $sizes = sprintf( '(max-width: %1$dpx) 100vw, %1$dpx', $width );
1287
1288         /**
1289          * Filters the output of 'wp_calculate_image_sizes()'.
1290          *
1291          * @since 4.4.0
1292          *
1293          * @param string       $sizes         A source size value for use in a 'sizes' attribute.
1294          * @param array|string $size          Requested size. Image size or array of width and height values
1295          *                                    in pixels (in that order).
1296          * @param string|null  $image_src     The URL to the image file or null.
1297          * @param array|null   $image_meta    The image meta data as returned by wp_get_attachment_metadata() or null.
1298          * @param int          $attachment_id Image attachment ID of the original image or 0.
1299          */
1300         return apply_filters( 'wp_calculate_image_sizes', $sizes, $size, $image_src, $image_meta, $attachment_id );
1301 }
1302
1303 /**
1304  * Filters 'img' elements in post content to add 'srcset' and 'sizes' attributes.
1305  *
1306  * @since 4.4.0
1307  *
1308  * @see wp_image_add_srcset_and_sizes()
1309  *
1310  * @param string $content The raw post content to be filtered.
1311  * @return string Converted content with 'srcset' and 'sizes' attributes added to images.
1312  */
1313 function wp_make_content_images_responsive( $content ) {
1314         if ( ! preg_match_all( '/<img [^>]+>/', $content, $matches ) ) {
1315                 return $content;
1316         }
1317
1318         $selected_images = $attachment_ids = array();
1319
1320         foreach( $matches[0] as $image ) {
1321                 if ( false === strpos( $image, ' srcset=' ) && preg_match( '/wp-image-([0-9]+)/i', $image, $class_id ) &&
1322                         ( $attachment_id = absint( $class_id[1] ) ) ) {
1323
1324                         /*
1325                          * If exactly the same image tag is used more than once, overwrite it.
1326                          * All identical tags will be replaced later with 'str_replace()'.
1327                          */
1328                         $selected_images[ $image ] = $attachment_id;
1329                         // Overwrite the ID when the same image is included more than once.
1330                         $attachment_ids[ $attachment_id ] = true;
1331                 }
1332         }
1333
1334         if ( count( $attachment_ids ) > 1 ) {
1335                 /*
1336                  * Warm object cache for use with 'get_post_meta()'.
1337                  *
1338                  * To avoid making a database call for each image, a single query
1339                  * warms the object cache with the meta information for all images.
1340                  */
1341                 update_meta_cache( 'post', array_keys( $attachment_ids ) );
1342         }
1343
1344         foreach ( $selected_images as $image => $attachment_id ) {
1345                 $image_meta = wp_get_attachment_metadata( $attachment_id );
1346                 $content = str_replace( $image, wp_image_add_srcset_and_sizes( $image, $image_meta, $attachment_id ), $content );
1347         }
1348
1349         return $content;
1350 }
1351
1352 /**
1353  * Adds 'srcset' and 'sizes' attributes to an existing 'img' element.
1354  *
1355  * @since 4.4.0
1356  *
1357  * @see wp_calculate_image_srcset()
1358  * @see wp_calculate_image_sizes()
1359  *
1360  * @param string $image         An HTML 'img' element to be filtered.
1361  * @param array  $image_meta    The image meta data as returned by 'wp_get_attachment_metadata()'.
1362  * @param int    $attachment_id Image attachment ID.
1363  * @return string Converted 'img' element with 'srcset' and 'sizes' attributes added.
1364  */
1365 function wp_image_add_srcset_and_sizes( $image, $image_meta, $attachment_id ) {
1366         // Ensure the image meta exists.
1367         if ( empty( $image_meta['sizes'] ) ) {
1368                 return $image;
1369         }
1370
1371         $image_src = preg_match( '/src="([^"]+)"/', $image, $match_src ) ? $match_src[1] : '';
1372         list( $image_src ) = explode( '?', $image_src );
1373
1374         // Return early if we couldn't get the image source.
1375         if ( ! $image_src ) {
1376                 return $image;
1377         }
1378
1379         // Bail early if an image has been inserted and later edited.
1380         if ( preg_match( '/-e[0-9]{13}/', $image_meta['file'], $img_edit_hash ) &&
1381                 strpos( wp_basename( $image_src ), $img_edit_hash[0] ) === false ) {
1382
1383                 return $image;
1384         }
1385
1386         $width  = preg_match( '/ width="([0-9]+)"/',  $image, $match_width  ) ? (int) $match_width[1]  : 0;
1387         $height = preg_match( '/ height="([0-9]+)"/', $image, $match_height ) ? (int) $match_height[1] : 0;
1388
1389         if ( ! $width || ! $height ) {
1390                 /*
1391                  * If attempts to parse the size value failed, attempt to use the image meta data to match
1392                  * the image file name from 'src' against the available sizes for an attachment.
1393                  */
1394                 $image_filename = wp_basename( $image_src );
1395
1396                 if ( $image_filename === wp_basename( $image_meta['file'] ) ) {
1397                         $width = (int) $image_meta['width'];
1398                         $height = (int) $image_meta['height'];
1399                 } else {
1400                         foreach( $image_meta['sizes'] as $image_size_data ) {
1401                                 if ( $image_filename === $image_size_data['file'] ) {
1402                                         $width = (int) $image_size_data['width'];
1403                                         $height = (int) $image_size_data['height'];
1404                                         break;
1405                                 }
1406                         }
1407                 }
1408         }
1409
1410         if ( ! $width || ! $height ) {
1411                 return $image;
1412         }
1413
1414         $size_array = array( $width, $height );
1415         $srcset = wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attachment_id );
1416
1417         if ( $srcset ) {
1418                 // Check if there is already a 'sizes' attribute.
1419                 $sizes = strpos( $image, ' sizes=' );
1420
1421                 if ( ! $sizes ) {
1422                         $sizes = wp_calculate_image_sizes( $size_array, $image_src, $image_meta, $attachment_id );
1423                 }
1424         }
1425
1426         if ( $srcset && $sizes ) {
1427                 // Format the 'srcset' and 'sizes' string and escape attributes.
1428                 $attr = sprintf( ' srcset="%s"', esc_attr( $srcset ) );
1429
1430                 if ( is_string( $sizes ) ) {
1431                         $attr .= sprintf( ' sizes="%s"', esc_attr( $sizes ) );
1432                 }
1433
1434                 // Add 'srcset' and 'sizes' attributes to the image markup.
1435                 $image = preg_replace( '/<img ([^>]+?)[\/ ]*>/', '<img $1' . $attr . ' />', $image );
1436         }
1437
1438         return $image;
1439 }
1440
1441 /**
1442  * Adds a 'wp-post-image' class to post thumbnails. Internal use only.
1443  *
1444  * Uses the {@see 'begin_fetch_post_thumbnail_html'} and {@see 'end_fetch_post_thumbnail_html'}
1445  * action hooks to dynamically add/remove itself so as to only filter post thumbnails.
1446  *
1447  * @ignore
1448  * @since 2.9.0
1449  *
1450  * @param array $attr Thumbnail attributes including src, class, alt, title.
1451  * @return array Modified array of attributes including the new 'wp-post-image' class.
1452  */
1453 function _wp_post_thumbnail_class_filter( $attr ) {
1454         $attr['class'] .= ' wp-post-image';
1455         return $attr;
1456 }
1457
1458 /**
1459  * Adds '_wp_post_thumbnail_class_filter' callback to the 'wp_get_attachment_image_attributes'
1460  * filter hook. Internal use only.
1461  *
1462  * @ignore
1463  * @since 2.9.0
1464  *
1465  * @param array $attr Thumbnail attributes including src, class, alt, title.
1466  */
1467 function _wp_post_thumbnail_class_filter_add( $attr ) {
1468         add_filter( 'wp_get_attachment_image_attributes', '_wp_post_thumbnail_class_filter' );
1469 }
1470
1471 /**
1472  * Removes the '_wp_post_thumbnail_class_filter' callback from the 'wp_get_attachment_image_attributes'
1473  * filter hook. Internal use only.
1474  *
1475  * @ignore
1476  * @since 2.9.0
1477  *
1478  * @param array $attr Thumbnail attributes including src, class, alt, title.
1479  */
1480 function _wp_post_thumbnail_class_filter_remove( $attr ) {
1481         remove_filter( 'wp_get_attachment_image_attributes', '_wp_post_thumbnail_class_filter' );
1482 }
1483
1484 add_shortcode('wp_caption', 'img_caption_shortcode');
1485 add_shortcode('caption', 'img_caption_shortcode');
1486
1487 /**
1488  * Builds the Caption shortcode output.
1489  *
1490  * Allows a plugin to replace the content that would otherwise be returned. The
1491  * filter is {@see 'img_caption_shortcode'} and passes an empty string, the attr
1492  * parameter and the content parameter values.
1493  *
1494  * The supported attributes for the shortcode are 'id', 'align', 'width', and
1495  * 'caption'.
1496  *
1497  * @since 2.6.0
1498  *
1499  * @param array  $attr {
1500  *     Attributes of the caption shortcode.
1501  *
1502  *     @type string $id      ID of the div element for the caption.
1503  *     @type string $align   Class name that aligns the caption. Default 'alignnone'. Accepts 'alignleft',
1504  *                           'aligncenter', alignright', 'alignnone'.
1505  *     @type int    $width   The width of the caption, in pixels.
1506  *     @type string $caption The caption text.
1507  *     @type string $class   Additional class name(s) added to the caption container.
1508  * }
1509  * @param string $content Shortcode content.
1510  * @return string HTML content to display the caption.
1511  */
1512 function img_caption_shortcode( $attr, $content = null ) {
1513         // New-style shortcode with the caption inside the shortcode with the link and image tags.
1514         if ( ! isset( $attr['caption'] ) ) {
1515                 if ( preg_match( '#((?:<a [^>]+>\s*)?<img [^>]+>(?:\s*</a>)?)(.*)#is', $content, $matches ) ) {
1516                         $content = $matches[1];
1517                         $attr['caption'] = trim( $matches[2] );
1518                 }
1519         } elseif ( strpos( $attr['caption'], '<' ) !== false ) {
1520                 $attr['caption'] = wp_kses( $attr['caption'], 'post' );
1521         }
1522
1523         /**
1524          * Filters the default caption shortcode output.
1525          *
1526          * If the filtered output isn't empty, it will be used instead of generating
1527          * the default caption template.
1528          *
1529          * @since 2.6.0
1530          *
1531          * @see img_caption_shortcode()
1532          *
1533          * @param string $output  The caption output. Default empty.
1534          * @param array  $attr    Attributes of the caption shortcode.
1535          * @param string $content The image element, possibly wrapped in a hyperlink.
1536          */
1537         $output = apply_filters( 'img_caption_shortcode', '', $attr, $content );
1538         if ( $output != '' )
1539                 return $output;
1540
1541         $atts = shortcode_atts( array(
1542                 'id'      => '',
1543                 'align'   => 'alignnone',
1544                 'width'   => '',
1545                 'caption' => '',
1546                 'class'   => '',
1547         ), $attr, 'caption' );
1548
1549         $atts['width'] = (int) $atts['width'];
1550         if ( $atts['width'] < 1 || empty( $atts['caption'] ) )
1551                 return $content;
1552
1553         if ( ! empty( $atts['id'] ) )
1554                 $atts['id'] = 'id="' . esc_attr( sanitize_html_class( $atts['id'] ) ) . '" ';
1555
1556         $class = trim( 'wp-caption ' . $atts['align'] . ' ' . $atts['class'] );
1557
1558         $html5 = current_theme_supports( 'html5', 'caption' );
1559         // HTML5 captions never added the extra 10px to the image width
1560         $width = $html5 ? $atts['width'] : ( 10 + $atts['width'] );
1561
1562         /**
1563          * Filters the width of an image's caption.
1564          *
1565          * By default, the caption is 10 pixels greater than the width of the image,
1566          * to prevent post content from running up against a floated image.
1567          *
1568          * @since 3.7.0
1569          *
1570          * @see img_caption_shortcode()
1571          *
1572          * @param int    $width    Width of the caption in pixels. To remove this inline style,
1573          *                         return zero.
1574          * @param array  $atts     Attributes of the caption shortcode.
1575          * @param string $content  The image element, possibly wrapped in a hyperlink.
1576          */
1577         $caption_width = apply_filters( 'img_caption_shortcode_width', $width, $atts, $content );
1578
1579         $style = '';
1580         if ( $caption_width ) {
1581                 $style = 'style="width: ' . (int) $caption_width . 'px" ';
1582         }
1583
1584         if ( $html5 ) {
1585                 $html = '<figure ' . $atts['id'] . $style . 'class="' . esc_attr( $class ) . '">'
1586                 . do_shortcode( $content ) . '<figcaption class="wp-caption-text">' . $atts['caption'] . '</figcaption></figure>';
1587         } else {
1588                 $html = '<div ' . $atts['id'] . $style . 'class="' . esc_attr( $class ) . '">'
1589                 . do_shortcode( $content ) . '<p class="wp-caption-text">' . $atts['caption'] . '</p></div>';
1590         }
1591
1592         return $html;
1593 }
1594
1595 add_shortcode('gallery', 'gallery_shortcode');
1596
1597 /**
1598  * Builds the Gallery shortcode output.
1599  *
1600  * This implements the functionality of the Gallery Shortcode for displaying
1601  * WordPress images on a post.
1602  *
1603  * @since 2.5.0
1604  *
1605  * @staticvar int $instance
1606  *
1607  * @param array $attr {
1608  *     Attributes of the gallery shortcode.
1609  *
1610  *     @type string       $order      Order of the images in the gallery. Default 'ASC'. Accepts 'ASC', 'DESC'.
1611  *     @type string       $orderby    The field to use when ordering the images. Default 'menu_order ID'.
1612  *                                    Accepts any valid SQL ORDERBY statement.
1613  *     @type int          $id         Post ID.
1614  *     @type string       $itemtag    HTML tag to use for each image in the gallery.
1615  *                                    Default 'dl', or 'figure' when the theme registers HTML5 gallery support.
1616  *     @type string       $icontag    HTML tag to use for each image's icon.
1617  *                                    Default 'dt', or 'div' when the theme registers HTML5 gallery support.
1618  *     @type string       $captiontag HTML tag to use for each image's caption.
1619  *                                    Default 'dd', or 'figcaption' when the theme registers HTML5 gallery support.
1620  *     @type int          $columns    Number of columns of images to display. Default 3.
1621  *     @type string|array $size       Size of the images to display. Accepts any valid image size, or an array of width
1622  *                                    and height values in pixels (in that order). Default 'thumbnail'.
1623  *     @type string       $ids        A comma-separated list of IDs of attachments to display. Default empty.
1624  *     @type string       $include    A comma-separated list of IDs of attachments to include. Default empty.
1625  *     @type string       $exclude    A comma-separated list of IDs of attachments to exclude. Default empty.
1626  *     @type string       $link       What to link each image to. Default empty (links to the attachment page).
1627  *                                    Accepts 'file', 'none'.
1628  * }
1629  * @return string HTML content to display gallery.
1630  */
1631 function gallery_shortcode( $attr ) {
1632         $post = get_post();
1633
1634         static $instance = 0;
1635         $instance++;
1636
1637         if ( ! empty( $attr['ids'] ) ) {
1638                 // 'ids' is explicitly ordered, unless you specify otherwise.
1639                 if ( empty( $attr['orderby'] ) ) {
1640                         $attr['orderby'] = 'post__in';
1641                 }
1642                 $attr['include'] = $attr['ids'];
1643         }
1644
1645         /**
1646          * Filters the default gallery shortcode output.
1647          *
1648          * If the filtered output isn't empty, it will be used instead of generating
1649          * the default gallery template.
1650          *
1651          * @since 2.5.0
1652          * @since 4.2.0 The `$instance` parameter was added.
1653          *
1654          * @see gallery_shortcode()
1655          *
1656          * @param string $output   The gallery output. Default empty.
1657          * @param array  $attr     Attributes of the gallery shortcode.
1658          * @param int    $instance Unique numeric ID of this gallery shortcode instance.
1659          */
1660         $output = apply_filters( 'post_gallery', '', $attr, $instance );
1661         if ( $output != '' ) {
1662                 return $output;
1663         }
1664
1665         $html5 = current_theme_supports( 'html5', 'gallery' );
1666         $atts = shortcode_atts( array(
1667                 'order'      => 'ASC',
1668                 'orderby'    => 'menu_order ID',
1669                 'id'         => $post ? $post->ID : 0,
1670                 'itemtag'    => $html5 ? 'figure'     : 'dl',
1671                 'icontag'    => $html5 ? 'div'        : 'dt',
1672                 'captiontag' => $html5 ? 'figcaption' : 'dd',
1673                 'columns'    => 3,
1674                 'size'       => 'thumbnail',
1675                 'include'    => '',
1676                 'exclude'    => '',
1677                 'link'       => ''
1678         ), $attr, 'gallery' );
1679
1680         $id = intval( $atts['id'] );
1681
1682         if ( ! empty( $atts['include'] ) ) {
1683                 $_attachments = get_posts( array( 'include' => $atts['include'], 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $atts['order'], 'orderby' => $atts['orderby'] ) );
1684
1685                 $attachments = array();
1686                 foreach ( $_attachments as $key => $val ) {
1687                         $attachments[$val->ID] = $_attachments[$key];
1688                 }
1689         } elseif ( ! empty( $atts['exclude'] ) ) {
1690                 $attachments = get_children( array( 'post_parent' => $id, 'exclude' => $atts['exclude'], 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $atts['order'], 'orderby' => $atts['orderby'] ) );
1691         } else {
1692                 $attachments = get_children( array( 'post_parent' => $id, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $atts['order'], 'orderby' => $atts['orderby'] ) );
1693         }
1694
1695         if ( empty( $attachments ) ) {
1696                 return '';
1697         }
1698
1699         if ( is_feed() ) {
1700                 $output = "\n";
1701                 foreach ( $attachments as $att_id => $attachment ) {
1702                         $output .= wp_get_attachment_link( $att_id, $atts['size'], true ) . "\n";
1703                 }
1704                 return $output;
1705         }
1706
1707         $itemtag = tag_escape( $atts['itemtag'] );
1708         $captiontag = tag_escape( $atts['captiontag'] );
1709         $icontag = tag_escape( $atts['icontag'] );
1710         $valid_tags = wp_kses_allowed_html( 'post' );
1711         if ( ! isset( $valid_tags[ $itemtag ] ) ) {
1712                 $itemtag = 'dl';
1713         }
1714         if ( ! isset( $valid_tags[ $captiontag ] ) ) {
1715                 $captiontag = 'dd';
1716         }
1717         if ( ! isset( $valid_tags[ $icontag ] ) ) {
1718                 $icontag = 'dt';
1719         }
1720
1721         $columns = intval( $atts['columns'] );
1722         $itemwidth = $columns > 0 ? floor(100/$columns) : 100;
1723         $float = is_rtl() ? 'right' : 'left';
1724
1725         $selector = "gallery-{$instance}";
1726
1727         $gallery_style = '';
1728
1729         /**
1730          * Filters whether to print default gallery styles.
1731          *
1732          * @since 3.1.0
1733          *
1734          * @param bool $print Whether to print default gallery styles.
1735          *                    Defaults to false if the theme supports HTML5 galleries.
1736          *                    Otherwise, defaults to true.
1737          */
1738         if ( apply_filters( 'use_default_gallery_style', ! $html5 ) ) {
1739                 $gallery_style = "
1740                 <style type='text/css'>
1741                         #{$selector} {
1742                                 margin: auto;
1743                         }
1744                         #{$selector} .gallery-item {
1745                                 float: {$float};
1746                                 margin-top: 10px;
1747                                 text-align: center;
1748                                 width: {$itemwidth}%;
1749                         }
1750                         #{$selector} img {
1751                                 border: 2px solid #cfcfcf;
1752                         }
1753                         #{$selector} .gallery-caption {
1754                                 margin-left: 0;
1755                         }
1756                         /* see gallery_shortcode() in wp-includes/media.php */
1757                 </style>\n\t\t";
1758         }
1759
1760         $size_class = sanitize_html_class( $atts['size'] );
1761         $gallery_div = "<div id='$selector' class='gallery galleryid-{$id} gallery-columns-{$columns} gallery-size-{$size_class}'>";
1762
1763         /**
1764          * Filters the default gallery shortcode CSS styles.
1765          *
1766          * @since 2.5.0
1767          *
1768          * @param string $gallery_style Default CSS styles and opening HTML div container
1769          *                              for the gallery shortcode output.
1770          */
1771         $output = apply_filters( 'gallery_style', $gallery_style . $gallery_div );
1772
1773         $i = 0;
1774         foreach ( $attachments as $id => $attachment ) {
1775
1776                 $attr = ( trim( $attachment->post_excerpt ) ) ? array( 'aria-describedby' => "$selector-$id" ) : '';
1777                 if ( ! empty( $atts['link'] ) && 'file' === $atts['link'] ) {
1778                         $image_output = wp_get_attachment_link( $id, $atts['size'], false, false, false, $attr );
1779                 } elseif ( ! empty( $atts['link'] ) && 'none' === $atts['link'] ) {
1780                         $image_output = wp_get_attachment_image( $id, $atts['size'], false, $attr );
1781                 } else {
1782                         $image_output = wp_get_attachment_link( $id, $atts['size'], true, false, false, $attr );
1783                 }
1784                 $image_meta  = wp_get_attachment_metadata( $id );
1785
1786                 $orientation = '';
1787                 if ( isset( $image_meta['height'], $image_meta['width'] ) ) {
1788                         $orientation = ( $image_meta['height'] > $image_meta['width'] ) ? 'portrait' : 'landscape';
1789                 }
1790                 $output .= "<{$itemtag} class='gallery-item'>";
1791                 $output .= "
1792                         <{$icontag} class='gallery-icon {$orientation}'>
1793                                 $image_output
1794                         </{$icontag}>";
1795                 if ( $captiontag && trim($attachment->post_excerpt) ) {
1796                         $output .= "
1797                                 <{$captiontag} class='wp-caption-text gallery-caption' id='$selector-$id'>
1798                                 " . wptexturize($attachment->post_excerpt) . "
1799                                 </{$captiontag}>";
1800                 }
1801                 $output .= "</{$itemtag}>";
1802                 if ( ! $html5 && $columns > 0 && ++$i % $columns == 0 ) {
1803                         $output .= '<br style="clear: both" />';
1804                 }
1805         }
1806
1807         if ( ! $html5 && $columns > 0 && $i % $columns !== 0 ) {
1808                 $output .= "
1809                         <br style='clear: both' />";
1810         }
1811
1812         $output .= "
1813                 </div>\n";
1814
1815         return $output;
1816 }
1817
1818 /**
1819  * Outputs the templates used by playlists.
1820  *
1821  * @since 3.9.0
1822  */
1823 function wp_underscore_playlist_templates() {
1824 ?>
1825 <script type="text/html" id="tmpl-wp-playlist-current-item">
1826         <# if ( data.image ) { #>
1827         <img src="{{ data.thumb.src }}" alt="" />
1828         <# } #>
1829         <div class="wp-playlist-caption">
1830                 <span class="wp-playlist-item-meta wp-playlist-item-title"><?php
1831                         /* translators: playlist item title */
1832                         printf( _x( '&#8220;%s&#8221;', 'playlist item title' ), '{{ data.title }}' );
1833                 ?></span>
1834                 <# if ( data.meta.album ) { #><span class="wp-playlist-item-meta wp-playlist-item-album">{{ data.meta.album }}</span><# } #>
1835                 <# if ( data.meta.artist ) { #><span class="wp-playlist-item-meta wp-playlist-item-artist">{{ data.meta.artist }}</span><# } #>
1836         </div>
1837 </script>
1838 <script type="text/html" id="tmpl-wp-playlist-item">
1839         <div class="wp-playlist-item">
1840                 <a class="wp-playlist-caption" href="{{ data.src }}">
1841                         {{ data.index ? ( data.index + '. ' ) : '' }}
1842                         <# if ( data.caption ) { #>
1843                                 {{ data.caption }}
1844                         <# } else { #>
1845                                 <span class="wp-playlist-item-title"><?php
1846                                         /* translators: playlist item title */
1847                                         printf( _x( '&#8220;%s&#8221;', 'playlist item title' ), '{{{ data.title }}}' );
1848                                 ?></span>
1849                                 <# if ( data.artists && data.meta.artist ) { #>
1850                                 <span class="wp-playlist-item-artist"> &mdash; {{ data.meta.artist }}</span>
1851                                 <# } #>
1852                         <# } #>
1853                 </a>
1854                 <# if ( data.meta.length_formatted ) { #>
1855                 <div class="wp-playlist-item-length">{{ data.meta.length_formatted }}</div>
1856                 <# } #>
1857         </div>
1858 </script>
1859 <?php
1860 }
1861
1862 /**
1863  * Outputs and enqueue default scripts and styles for playlists.
1864  *
1865  * @since 3.9.0
1866  *
1867  * @param string $type Type of playlist. Accepts 'audio' or 'video'.
1868  */
1869 function wp_playlist_scripts( $type ) {
1870         wp_enqueue_style( 'wp-mediaelement' );
1871         wp_enqueue_script( 'wp-playlist' );
1872 ?>
1873 <!--[if lt IE 9]><script>document.createElement('<?php echo esc_js( $type ) ?>');</script><![endif]-->
1874 <?php
1875         add_action( 'wp_footer', 'wp_underscore_playlist_templates', 0 );
1876         add_action( 'admin_footer', 'wp_underscore_playlist_templates', 0 );
1877 }
1878
1879 /**
1880  * Builds the Playlist shortcode output.
1881  *
1882  * This implements the functionality of the playlist shortcode for displaying
1883  * a collection of WordPress audio or video files in a post.
1884  *
1885  * @since 3.9.0
1886  *
1887  * @global int $content_width
1888  * @staticvar int $instance
1889  *
1890  * @param array $attr {
1891  *     Array of default playlist attributes.
1892  *
1893  *     @type string  $type         Type of playlist to display. Accepts 'audio' or 'video'. Default 'audio'.
1894  *     @type string  $order        Designates ascending or descending order of items in the playlist.
1895  *                                 Accepts 'ASC', 'DESC'. Default 'ASC'.
1896  *     @type string  $orderby      Any column, or columns, to sort the playlist. If $ids are
1897  *                                 passed, this defaults to the order of the $ids array ('post__in').
1898  *                                 Otherwise default is 'menu_order ID'.
1899  *     @type int     $id           If an explicit $ids array is not present, this parameter
1900  *                                 will determine which attachments are used for the playlist.
1901  *                                 Default is the current post ID.
1902  *     @type array   $ids          Create a playlist out of these explicit attachment IDs. If empty,
1903  *                                 a playlist will be created from all $type attachments of $id.
1904  *                                 Default empty.
1905  *     @type array   $exclude      List of specific attachment IDs to exclude from the playlist. Default empty.
1906  *     @type string  $style        Playlist style to use. Accepts 'light' or 'dark'. Default 'light'.
1907  *     @type bool    $tracklist    Whether to show or hide the playlist. Default true.
1908  *     @type bool    $tracknumbers Whether to show or hide the numbers next to entries in the playlist. Default true.
1909  *     @type bool    $images       Show or hide the video or audio thumbnail (Featured Image/post
1910  *                                 thumbnail). Default true.
1911  *     @type bool    $artists      Whether to show or hide artist name in the playlist. Default true.
1912  * }
1913  *
1914  * @return string Playlist output. Empty string if the passed type is unsupported.
1915  */
1916 function wp_playlist_shortcode( $attr ) {
1917         global $content_width;
1918         $post = get_post();
1919
1920         static $instance = 0;
1921         $instance++;
1922
1923         if ( ! empty( $attr['ids'] ) ) {
1924                 // 'ids' is explicitly ordered, unless you specify otherwise.
1925                 if ( empty( $attr['orderby'] ) ) {
1926                         $attr['orderby'] = 'post__in';
1927                 }
1928                 $attr['include'] = $attr['ids'];
1929         }
1930
1931         /**
1932          * Filters the playlist output.
1933          *
1934          * Passing a non-empty value to the filter will short-circuit generation
1935          * of the default playlist output, returning the passed value instead.
1936          *
1937          * @since 3.9.0
1938          * @since 4.2.0 The `$instance` parameter was added.
1939          *
1940          * @param string $output   Playlist output. Default empty.
1941          * @param array  $attr     An array of shortcode attributes.
1942          * @param int    $instance Unique numeric ID of this playlist shortcode instance.
1943          */
1944         $output = apply_filters( 'post_playlist', '', $attr, $instance );
1945         if ( $output != '' ) {
1946                 return $output;
1947         }
1948
1949         $atts = shortcode_atts( array(
1950                 'type'          => 'audio',
1951                 'order'         => 'ASC',
1952                 'orderby'       => 'menu_order ID',
1953                 'id'            => $post ? $post->ID : 0,
1954                 'include'       => '',
1955                 'exclude'   => '',
1956                 'style'         => 'light',
1957                 'tracklist' => true,
1958                 'tracknumbers' => true,
1959                 'images'        => true,
1960                 'artists'       => true
1961         ), $attr, 'playlist' );
1962
1963         $id = intval( $atts['id'] );
1964
1965         if ( $atts['type'] !== 'audio' ) {
1966                 $atts['type'] = 'video';
1967         }
1968
1969         $args = array(
1970                 'post_status' => 'inherit',
1971                 'post_type' => 'attachment',
1972                 'post_mime_type' => $atts['type'],
1973                 'order' => $atts['order'],
1974                 'orderby' => $atts['orderby']
1975         );
1976
1977         if ( ! empty( $atts['include'] ) ) {
1978                 $args['include'] = $atts['include'];
1979                 $_attachments = get_posts( $args );
1980
1981                 $attachments = array();
1982                 foreach ( $_attachments as $key => $val ) {
1983                         $attachments[$val->ID] = $_attachments[$key];
1984                 }
1985         } elseif ( ! empty( $atts['exclude'] ) ) {
1986                 $args['post_parent'] = $id;
1987                 $args['exclude'] = $atts['exclude'];
1988                 $attachments = get_children( $args );
1989         } else {
1990                 $args['post_parent'] = $id;
1991                 $attachments = get_children( $args );
1992         }
1993
1994         if ( empty( $attachments ) ) {
1995                 return '';
1996         }
1997
1998         if ( is_feed() ) {
1999                 $output = "\n";
2000                 foreach ( $attachments as $att_id => $attachment ) {
2001                         $output .= wp_get_attachment_link( $att_id ) . "\n";
2002                 }
2003                 return $output;
2004         }
2005
2006         $outer = 22; // default padding and border of wrapper
2007
2008         $default_width = 640;
2009         $default_height = 360;
2010
2011         $theme_width = empty( $content_width ) ? $default_width : ( $content_width - $outer );
2012         $theme_height = empty( $content_width ) ? $default_height : round( ( $default_height * $theme_width ) / $default_width );
2013
2014         $data = array(
2015                 'type' => $atts['type'],
2016                 // don't pass strings to JSON, will be truthy in JS
2017                 'tracklist' => wp_validate_boolean( $atts['tracklist'] ),
2018                 'tracknumbers' => wp_validate_boolean( $atts['tracknumbers'] ),
2019                 'images' => wp_validate_boolean( $atts['images'] ),
2020                 'artists' => wp_validate_boolean( $atts['artists'] ),
2021         );
2022
2023         $tracks = array();
2024         foreach ( $attachments as $attachment ) {
2025                 $url = wp_get_attachment_url( $attachment->ID );
2026                 $ftype = wp_check_filetype( $url, wp_get_mime_types() );
2027                 $track = array(
2028                         'src' => $url,
2029                         'type' => $ftype['type'],
2030                         'title' => $attachment->post_title,
2031                         'caption' => $attachment->post_excerpt,
2032                         'description' => $attachment->post_content
2033                 );
2034
2035                 $track['meta'] = array();
2036                 $meta = wp_get_attachment_metadata( $attachment->ID );
2037                 if ( ! empty( $meta ) ) {
2038
2039                         foreach ( wp_get_attachment_id3_keys( $attachment ) as $key => $label ) {
2040                                 if ( ! empty( $meta[ $key ] ) ) {
2041                                         $track['meta'][ $key ] = $meta[ $key ];
2042                                 }
2043                         }
2044
2045                         if ( 'video' === $atts['type'] ) {
2046                                 if ( ! empty( $meta['width'] ) && ! empty( $meta['height'] ) ) {
2047                                         $width = $meta['width'];
2048                                         $height = $meta['height'];
2049                                         $theme_height = round( ( $height * $theme_width ) / $width );
2050                                 } else {
2051                                         $width = $default_width;
2052                                         $height = $default_height;
2053                                 }
2054
2055                                 $track['dimensions'] = array(
2056                                         'original' => compact( 'width', 'height' ),
2057                                         'resized' => array(
2058                                                 'width' => $theme_width,
2059                                                 'height' => $theme_height
2060                                         )
2061                                 );
2062                         }
2063                 }
2064
2065                 if ( $atts['images'] ) {
2066                         $thumb_id = get_post_thumbnail_id( $attachment->ID );
2067                         if ( ! empty( $thumb_id ) ) {
2068                                 list( $src, $width, $height ) = wp_get_attachment_image_src( $thumb_id, 'full' );
2069                                 $track['image'] = compact( 'src', 'width', 'height' );
2070                                 list( $src, $width, $height ) = wp_get_attachment_image_src( $thumb_id, 'thumbnail' );
2071                                 $track['thumb'] = compact( 'src', 'width', 'height' );
2072                         } else {
2073                                 $src = wp_mime_type_icon( $attachment->ID );
2074                                 $width = 48;
2075                                 $height = 64;
2076                                 $track['image'] = compact( 'src', 'width', 'height' );
2077                                 $track['thumb'] = compact( 'src', 'width', 'height' );
2078                         }
2079                 }
2080
2081                 $tracks[] = $track;
2082         }
2083         $data['tracks'] = $tracks;
2084
2085         $safe_type = esc_attr( $atts['type'] );
2086         $safe_style = esc_attr( $atts['style'] );
2087
2088         ob_start();
2089
2090         if ( 1 === $instance ) {
2091                 /**
2092                  * Prints and enqueues playlist scripts, styles, and JavaScript templates.
2093                  *
2094                  * @since 3.9.0
2095                  *
2096                  * @param string $type  Type of playlist. Possible values are 'audio' or 'video'.
2097                  * @param string $style The 'theme' for the playlist. Core provides 'light' and 'dark'.
2098                  */
2099                 do_action( 'wp_playlist_scripts', $atts['type'], $atts['style'] );
2100         } ?>
2101 <div class="wp-playlist wp-<?php echo $safe_type ?>-playlist wp-playlist-<?php echo $safe_style ?>">
2102         <?php if ( 'audio' === $atts['type'] ): ?>
2103         <div class="wp-playlist-current-item"></div>
2104         <?php endif ?>
2105         <<?php echo $safe_type ?> controls="controls" preload="none" width="<?php
2106                 echo (int) $theme_width;
2107         ?>"<?php if ( 'video' === $safe_type ):
2108                 echo ' height="', (int) $theme_height, '"';
2109         endif; ?>></<?php echo $safe_type ?>>
2110         <div class="wp-playlist-next"></div>
2111         <div class="wp-playlist-prev"></div>
2112         <noscript>
2113         <ol><?php
2114         foreach ( $attachments as $att_id => $attachment ) {
2115                 printf( '<li>%s</li>', wp_get_attachment_link( $att_id ) );
2116         }
2117         ?></ol>
2118         </noscript>
2119         <script type="application/json" class="wp-playlist-script"><?php echo wp_json_encode( $data ) ?></script>
2120 </div>
2121         <?php
2122         return ob_get_clean();
2123 }
2124 add_shortcode( 'playlist', 'wp_playlist_shortcode' );
2125
2126 /**
2127  * Provides a No-JS Flash fallback as a last resort for audio / video.
2128  *
2129  * @since 3.6.0
2130  *
2131  * @param string $url The media element URL.
2132  * @return string Fallback HTML.
2133  */
2134 function wp_mediaelement_fallback( $url ) {
2135         /**
2136          * Filters the Mediaelement fallback output for no-JS.
2137          *
2138          * @since 3.6.0
2139          *
2140          * @param string $output Fallback output for no-JS.
2141          * @param string $url    Media file URL.
2142          */
2143         return apply_filters( 'wp_mediaelement_fallback', sprintf( '<a href="%1$s">%1$s</a>', esc_url( $url ) ), $url );
2144 }
2145
2146 /**
2147  * Returns a filtered list of WP-supported audio formats.
2148  *
2149  * @since 3.6.0
2150  *
2151  * @return array Supported audio formats.
2152  */
2153 function wp_get_audio_extensions() {
2154         /**
2155          * Filters the list of supported audio formats.
2156          *
2157          * @since 3.6.0
2158          *
2159          * @param array $extensions An array of support audio formats. Defaults are
2160          *                          'mp3', 'ogg', 'wma', 'm4a', 'wav'.
2161          */
2162         return apply_filters( 'wp_audio_extensions', array( 'mp3', 'ogg', 'wma', 'm4a', 'wav' ) );
2163 }
2164
2165 /**
2166  * Returns useful keys to use to lookup data from an attachment's stored metadata.
2167  *
2168  * @since 3.9.0
2169  *
2170  * @param WP_Post $attachment The current attachment, provided for context.
2171  * @param string  $context    Optional. The context. Accepts 'edit', 'display'. Default 'display'.
2172  * @return array Key/value pairs of field keys to labels.
2173  */
2174 function wp_get_attachment_id3_keys( $attachment, $context = 'display' ) {
2175         $fields = array(
2176                 'artist' => __( 'Artist' ),
2177                 'album' => __( 'Album' ),
2178         );
2179
2180         if ( 'display' === $context ) {
2181                 $fields['genre']            = __( 'Genre' );
2182                 $fields['year']             = __( 'Year' );
2183                 $fields['length_formatted'] = _x( 'Length', 'video or audio' );
2184         } elseif ( 'js' === $context ) {
2185                 $fields['bitrate']          = __( 'Bitrate' );
2186                 $fields['bitrate_mode']     = __( 'Bitrate Mode' );
2187         }
2188
2189         /**
2190          * Filters the editable list of keys to look up data from an attachment's metadata.
2191          *
2192          * @since 3.9.0
2193          *
2194          * @param array   $fields     Key/value pairs of field keys to labels.
2195          * @param WP_Post $attachment Attachment object.
2196          * @param string  $context    The context. Accepts 'edit', 'display'. Default 'display'.
2197          */
2198         return apply_filters( 'wp_get_attachment_id3_keys', $fields, $attachment, $context );
2199 }
2200 /**
2201  * Builds the Audio shortcode output.
2202  *
2203  * This implements the functionality of the Audio Shortcode for displaying
2204  * WordPress mp3s in a post.
2205  *
2206  * @since 3.6.0
2207  *
2208  * @staticvar int $instance
2209  *
2210  * @param array  $attr {
2211  *     Attributes of the audio shortcode.
2212  *
2213  *     @type string $src      URL to the source of the audio file. Default empty.
2214  *     @type string $loop     The 'loop' attribute for the `<audio>` element. Default empty.
2215  *     @type string $autoplay The 'autoplay' attribute for the `<audio>` element. Default empty.
2216  *     @type string $preload  The 'preload' attribute for the `<audio>` element. Default 'none'.
2217  *     @type string $class    The 'class' attribute for the `<audio>` element. Default 'wp-audio-shortcode'.
2218  *     @type string $style    The 'style' attribute for the `<audio>` element. Default 'width: 100%;'.
2219  * }
2220  * @param string $content Shortcode content.
2221  * @return string|void HTML content to display audio.
2222  */
2223 function wp_audio_shortcode( $attr, $content = '' ) {
2224         $post_id = get_post() ? get_the_ID() : 0;
2225
2226         static $instance = 0;
2227         $instance++;
2228
2229         /**
2230          * Filters the default audio shortcode output.
2231          *
2232          * If the filtered output isn't empty, it will be used instead of generating the default audio template.
2233          *
2234          * @since 3.6.0
2235          *
2236          * @param string $html     Empty variable to be replaced with shortcode markup.
2237          * @param array  $attr     Attributes of the shortcode. @see wp_audio_shortcode()
2238          * @param string $content  Shortcode content.
2239          * @param int    $instance Unique numeric ID of this audio shortcode instance.
2240          */
2241         $override = apply_filters( 'wp_audio_shortcode_override', '', $attr, $content, $instance );
2242         if ( '' !== $override ) {
2243                 return $override;
2244         }
2245
2246         $audio = null;
2247
2248         $default_types = wp_get_audio_extensions();
2249         $defaults_atts = array(
2250                 'src'      => '',
2251                 'loop'     => '',
2252                 'autoplay' => '',
2253                 'preload'  => 'none',
2254                 'class'    => 'wp-audio-shortcode',
2255                 'style'    => 'width: 100%;'
2256         );
2257         foreach ( $default_types as $type ) {
2258                 $defaults_atts[$type] = '';
2259         }
2260
2261         $atts = shortcode_atts( $defaults_atts, $attr, 'audio' );
2262
2263         $primary = false;
2264         if ( ! empty( $atts['src'] ) ) {
2265                 $type = wp_check_filetype( $atts['src'], wp_get_mime_types() );
2266                 if ( ! in_array( strtolower( $type['ext'] ), $default_types ) ) {
2267                         return sprintf( '<a class="wp-embedded-audio" href="%s">%s</a>', esc_url( $atts['src'] ), esc_html( $atts['src'] ) );
2268                 }
2269                 $primary = true;
2270                 array_unshift( $default_types, 'src' );
2271         } else {
2272                 foreach ( $default_types as $ext ) {
2273                         if ( ! empty( $atts[ $ext ] ) ) {
2274                                 $type = wp_check_filetype( $atts[ $ext ], wp_get_mime_types() );
2275                                 if ( strtolower( $type['ext'] ) === $ext ) {
2276                                         $primary = true;
2277                                 }
2278                         }
2279                 }
2280         }
2281
2282         if ( ! $primary ) {
2283                 $audios = get_attached_media( 'audio', $post_id );
2284                 if ( empty( $audios ) ) {
2285                         return;
2286                 }
2287
2288                 $audio = reset( $audios );
2289                 $atts['src'] = wp_get_attachment_url( $audio->ID );
2290                 if ( empty( $atts['src'] ) ) {
2291                         return;
2292                 }
2293
2294                 array_unshift( $default_types, 'src' );
2295         }
2296
2297         /**
2298          * Filters the media library used for the audio shortcode.
2299          *
2300          * @since 3.6.0
2301          *
2302          * @param string $library Media library used for the audio shortcode.
2303          */
2304         $library = apply_filters( 'wp_audio_shortcode_library', 'mediaelement' );
2305         if ( 'mediaelement' === $library && did_action( 'init' ) ) {
2306                 wp_enqueue_style( 'wp-mediaelement' );
2307                 wp_enqueue_script( 'wp-mediaelement' );
2308         }
2309
2310         /**
2311          * Filters the class attribute for the audio shortcode output container.
2312          *
2313          * @since 3.6.0
2314          *
2315          * @param string $class CSS class or list of space-separated classes.
2316          */
2317         $atts['class'] = apply_filters( 'wp_audio_shortcode_class', $atts['class'] );
2318
2319         $html_atts = array(
2320                 'class'    => $atts['class'],
2321                 'id'       => sprintf( 'audio-%d-%d', $post_id, $instance ),
2322                 'loop'     => wp_validate_boolean( $atts['loop'] ),
2323                 'autoplay' => wp_validate_boolean( $atts['autoplay'] ),
2324                 'preload'  => $atts['preload'],
2325                 'style'    => $atts['style'],
2326         );
2327
2328         // These ones should just be omitted altogether if they are blank
2329         foreach ( array( 'loop', 'autoplay', 'preload' ) as $a ) {
2330                 if ( empty( $html_atts[$a] ) ) {
2331                         unset( $html_atts[$a] );
2332                 }
2333         }
2334
2335         $attr_strings = array();
2336         foreach ( $html_atts as $k => $v ) {
2337                 $attr_strings[] = $k . '="' . esc_attr( $v ) . '"';
2338         }
2339
2340         $html = '';
2341         if ( 'mediaelement' === $library && 1 === $instance ) {
2342                 $html .= "<!--[if lt IE 9]><script>document.createElement('audio');</script><![endif]-->\n";
2343         }
2344         $html .= sprintf( '<audio %s controls="controls">', join( ' ', $attr_strings ) );
2345
2346         $fileurl = '';
2347         $source = '<source type="%s" src="%s" />';
2348         foreach ( $default_types as $fallback ) {
2349                 if ( ! empty( $atts[ $fallback ] ) ) {
2350                         if ( empty( $fileurl ) ) {
2351                                 $fileurl = $atts[ $fallback ];
2352                         }
2353                         $type = wp_check_filetype( $atts[ $fallback ], wp_get_mime_types() );
2354                         $url = add_query_arg( '_', $instance, $atts[ $fallback ] );
2355                         $html .= sprintf( $source, $type['type'], esc_url( $url ) );
2356                 }
2357         }
2358
2359         if ( 'mediaelement' === $library ) {
2360                 $html .= wp_mediaelement_fallback( $fileurl );
2361         }
2362         $html .= '</audio>';
2363
2364         /**
2365          * Filters the audio shortcode output.
2366          *
2367          * @since 3.6.0
2368          *
2369          * @param string $html    Audio shortcode HTML output.
2370          * @param array  $atts    Array of audio shortcode attributes.
2371          * @param string $audio   Audio file.
2372          * @param int    $post_id Post ID.
2373          * @param string $library Media library used for the audio shortcode.
2374          */
2375         return apply_filters( 'wp_audio_shortcode', $html, $atts, $audio, $post_id, $library );
2376 }
2377 add_shortcode( 'audio', 'wp_audio_shortcode' );
2378
2379 /**
2380  * Returns a filtered list of WP-supported video formats.
2381  *
2382  * @since 3.6.0
2383  *
2384  * @return array List of supported video formats.
2385  */
2386 function wp_get_video_extensions() {
2387         /**
2388          * Filters the list of supported video formats.
2389          *
2390          * @since 3.6.0
2391          *
2392          * @param array $extensions An array of support video formats. Defaults are
2393          *                          'mp4', 'm4v', 'webm', 'ogv', 'wmv', 'flv'.
2394          */
2395         return apply_filters( 'wp_video_extensions', array( 'mp4', 'm4v', 'webm', 'ogv', 'wmv', 'flv' ) );
2396 }
2397
2398 /**
2399  * Builds the Video shortcode output.
2400  *
2401  * This implements the functionality of the Video Shortcode for displaying
2402  * WordPress mp4s in a post.
2403  *
2404  * @since 3.6.0
2405  *
2406  * @global int $content_width
2407  * @staticvar int $instance
2408  *
2409  * @param array  $attr {
2410  *     Attributes of the shortcode.
2411  *
2412  *     @type string $src      URL to the source of the video file. Default empty.
2413  *     @type int    $height   Height of the video embed in pixels. Default 360.
2414  *     @type int    $width    Width of the video embed in pixels. Default $content_width or 640.
2415  *     @type string $poster   The 'poster' attribute for the `<video>` element. Default empty.
2416  *     @type string $loop     The 'loop' attribute for the `<video>` element. Default empty.
2417  *     @type string $autoplay The 'autoplay' attribute for the `<video>` element. Default empty.
2418  *     @type string $preload  The 'preload' attribute for the `<video>` element.
2419  *                            Default 'metadata'.
2420  *     @type string $class    The 'class' attribute for the `<video>` element.
2421  *                            Default 'wp-video-shortcode'.
2422  * }
2423  * @param string $content Shortcode content.
2424  * @return string|void HTML content to display video.
2425  */
2426 function wp_video_shortcode( $attr, $content = '' ) {
2427         global $content_width;
2428         $post_id = get_post() ? get_the_ID() : 0;
2429
2430         static $instance = 0;
2431         $instance++;
2432
2433         /**
2434          * Filters the default video shortcode output.
2435          *
2436          * If the filtered output isn't empty, it will be used instead of generating
2437          * the default video template.
2438          *
2439          * @since 3.6.0
2440          *
2441          * @see wp_video_shortcode()
2442          *
2443          * @param string $html     Empty variable to be replaced with shortcode markup.
2444          * @param array  $attr     Attributes of the video shortcode.
2445          * @param string $content  Video shortcode content.
2446          * @param int    $instance Unique numeric ID of this video shortcode instance.
2447          */
2448         $override = apply_filters( 'wp_video_shortcode_override', '', $attr, $content, $instance );
2449         if ( '' !== $override ) {
2450                 return $override;
2451         }
2452
2453         $video = null;
2454
2455         $default_types = wp_get_video_extensions();
2456         $defaults_atts = array(
2457                 'src'      => '',
2458                 'poster'   => '',
2459                 'loop'     => '',
2460                 'autoplay' => '',
2461                 'preload'  => 'metadata',
2462                 'width'    => 640,
2463                 'height'   => 360,
2464                 'class'    => 'wp-video-shortcode',
2465         );
2466
2467         foreach ( $default_types as $type ) {
2468                 $defaults_atts[$type] = '';
2469         }
2470
2471         $atts = shortcode_atts( $defaults_atts, $attr, 'video' );
2472
2473         if ( is_admin() ) {
2474                 // shrink the video so it isn't huge in the admin
2475                 if ( $atts['width'] > $defaults_atts['width'] ) {
2476                         $atts['height'] = round( ( $atts['height'] * $defaults_atts['width'] ) / $atts['width'] );
2477                         $atts['width'] = $defaults_atts['width'];
2478                 }
2479         } else {
2480                 // if the video is bigger than the theme
2481                 if ( ! empty( $content_width ) && $atts['width'] > $content_width ) {
2482                         $atts['height'] = round( ( $atts['height'] * $content_width ) / $atts['width'] );
2483                         $atts['width'] = $content_width;
2484                 }
2485         }
2486
2487         $is_vimeo = $is_youtube = false;
2488         $yt_pattern = '#^https?://(?:www\.)?(?:youtube\.com/watch|youtu\.be/)#';
2489         $vimeo_pattern = '#^https?://(.+\.)?vimeo\.com/.*#';
2490
2491         $primary = false;
2492         if ( ! empty( $atts['src'] ) ) {
2493                 $is_vimeo = ( preg_match( $vimeo_pattern, $atts['src'] ) );
2494                 $is_youtube = (  preg_match( $yt_pattern, $atts['src'] ) );
2495                 if ( ! $is_youtube && ! $is_vimeo ) {
2496                         $type = wp_check_filetype( $atts['src'], wp_get_mime_types() );
2497                         if ( ! in_array( strtolower( $type['ext'] ), $default_types ) ) {
2498                                 return sprintf( '<a class="wp-embedded-video" href="%s">%s</a>', esc_url( $atts['src'] ), esc_html( $atts['src'] ) );
2499                         }
2500                 }
2501
2502                 if ( $is_vimeo ) {
2503                         wp_enqueue_script( 'froogaloop' );
2504                 }
2505
2506                 $primary = true;
2507                 array_unshift( $default_types, 'src' );
2508         } else {
2509                 foreach ( $default_types as $ext ) {
2510                         if ( ! empty( $atts[ $ext ] ) ) {
2511                                 $type = wp_check_filetype( $atts[ $ext ], wp_get_mime_types() );
2512                                 if ( strtolower( $type['ext'] ) === $ext ) {
2513                                         $primary = true;
2514                                 }
2515                         }
2516                 }
2517         }
2518
2519         if ( ! $primary ) {
2520                 $videos = get_attached_media( 'video', $post_id );
2521                 if ( empty( $videos ) ) {
2522                         return;
2523                 }
2524
2525                 $video = reset( $videos );
2526                 $atts['src'] = wp_get_attachment_url( $video->ID );
2527                 if ( empty( $atts['src'] ) ) {
2528                         return;
2529                 }
2530
2531                 array_unshift( $default_types, 'src' );
2532         }
2533
2534         /**
2535          * Filters the media library used for the video shortcode.
2536          *
2537          * @since 3.6.0
2538          *
2539          * @param string $library Media library used for the video shortcode.
2540          */
2541         $library = apply_filters( 'wp_video_shortcode_library', 'mediaelement' );
2542         if ( 'mediaelement' === $library && did_action( 'init' ) ) {
2543                 wp_enqueue_style( 'wp-mediaelement' );
2544                 wp_enqueue_script( 'wp-mediaelement' );
2545         }
2546
2547         /**
2548          * Filters the class attribute for the video shortcode output container.
2549          *
2550          * @since 3.6.0
2551          *
2552          * @param string $class CSS class or list of space-separated classes.
2553          */
2554         $atts['class'] = apply_filters( 'wp_video_shortcode_class', $atts['class'] );
2555
2556         $html_atts = array(
2557                 'class'    => $atts['class'],
2558                 'id'       => sprintf( 'video-%d-%d', $post_id, $instance ),
2559                 'width'    => absint( $atts['width'] ),
2560                 'height'   => absint( $atts['height'] ),
2561                 'poster'   => esc_url( $atts['poster'] ),
2562                 'loop'     => wp_validate_boolean( $atts['loop'] ),
2563                 'autoplay' => wp_validate_boolean( $atts['autoplay'] ),
2564                 'preload'  => $atts['preload'],
2565         );
2566
2567         // These ones should just be omitted altogether if they are blank
2568         foreach ( array( 'poster', 'loop', 'autoplay', 'preload' ) as $a ) {
2569                 if ( empty( $html_atts[$a] ) ) {
2570                         unset( $html_atts[$a] );
2571                 }
2572         }
2573
2574         $attr_strings = array();
2575         foreach ( $html_atts as $k => $v ) {
2576                 $attr_strings[] = $k . '="' . esc_attr( $v ) . '"';
2577         }
2578
2579         $html = '';
2580         if ( 'mediaelement' === $library && 1 === $instance ) {
2581                 $html .= "<!--[if lt IE 9]><script>document.createElement('video');</script><![endif]-->\n";
2582         }
2583         $html .= sprintf( '<video %s controls="controls">', join( ' ', $attr_strings ) );
2584
2585         $fileurl = '';
2586         $source = '<source type="%s" src="%s" />';
2587         foreach ( $default_types as $fallback ) {
2588                 if ( ! empty( $atts[ $fallback ] ) ) {
2589                         if ( empty( $fileurl ) ) {
2590                                 $fileurl = $atts[ $fallback ];
2591                         }
2592                         if ( 'src' === $fallback && $is_youtube ) {
2593                                 $type = array( 'type' => 'video/youtube' );
2594                         } elseif ( 'src' === $fallback && $is_vimeo ) {
2595                                 $type = array( 'type' => 'video/vimeo' );
2596                         } else {
2597                                 $type = wp_check_filetype( $atts[ $fallback ], wp_get_mime_types() );
2598                         }
2599                         $url = add_query_arg( '_', $instance, $atts[ $fallback ] );
2600                         $html .= sprintf( $source, $type['type'], esc_url( $url ) );
2601                 }
2602         }
2603
2604         if ( ! empty( $content ) ) {
2605                 if ( false !== strpos( $content, "\n" ) ) {
2606                         $content = str_replace( array( "\r\n", "\n", "\t" ), '', $content );
2607                 }
2608                 $html .= trim( $content );
2609         }
2610
2611         if ( 'mediaelement' === $library ) {
2612                 $html .= wp_mediaelement_fallback( $fileurl );
2613         }
2614         $html .= '</video>';
2615
2616         $width_rule = '';
2617         if ( ! empty( $atts['width'] ) ) {
2618                 $width_rule = sprintf( 'width: %dpx;', $atts['width'] );
2619         }
2620         $output = sprintf( '<div style="%s" class="wp-video">%s</div>', $width_rule, $html );
2621
2622         /**
2623          * Filters the output of the video shortcode.
2624          *
2625          * @since 3.6.0
2626          *
2627          * @param string $output  Video shortcode HTML output.
2628          * @param array  $atts    Array of video shortcode attributes.
2629          * @param string $video   Video file.
2630          * @param int    $post_id Post ID.
2631          * @param string $library Media library used for the video shortcode.
2632          */
2633         return apply_filters( 'wp_video_shortcode', $output, $atts, $video, $post_id, $library );
2634 }
2635 add_shortcode( 'video', 'wp_video_shortcode' );
2636
2637 /**
2638  * Displays previous image link that has the same post parent.
2639  *
2640  * @since 2.5.0
2641  *
2642  * @see adjacent_image_link()
2643  *
2644  * @param string|array $size Optional. Image size. Accepts any valid image size, an array of width and
2645  *                           height values in pixels (in that order), 0, or 'none'. 0 or 'none' will
2646  *                           default to 'post_title' or `$text`. Default 'thumbnail'.
2647  * @param string       $text Optional. Link text. Default false.
2648  */
2649 function previous_image_link( $size = 'thumbnail', $text = false ) {
2650         adjacent_image_link(true, $size, $text);
2651 }
2652
2653 /**
2654  * Displays next image link that has the same post parent.
2655  *
2656  * @since 2.5.0
2657  *
2658  * @see adjacent_image_link()
2659  *
2660  * @param string|array $size Optional. Image size. Accepts any valid image size, an array of width and
2661  *                           height values in pixels (in that order), 0, or 'none'. 0 or 'none' will
2662  *                           default to 'post_title' or `$text`. Default 'thumbnail'.
2663  * @param string       $text Optional. Link text. Default false.
2664  */
2665 function next_image_link( $size = 'thumbnail', $text = false ) {
2666         adjacent_image_link(false, $size, $text);
2667 }
2668
2669 /**
2670  * Displays next or previous image link that has the same post parent.
2671  *
2672  * Retrieves the current attachment object from the $post global.
2673  *
2674  * @since 2.5.0
2675  *
2676  * @param bool         $prev Optional. Whether to display the next (false) or previous (true) link. Default true.
2677  * @param string|array $size Optional. Image size. Accepts any valid image size, or an array of width and height
2678  *                           values in pixels (in that order). Default 'thumbnail'.
2679  * @param bool         $text Optional. Link text. Default false.
2680  */
2681 function adjacent_image_link( $prev = true, $size = 'thumbnail', $text = false ) {
2682         $post = get_post();
2683         $attachments = array_values( get_children( array( 'post_parent' => $post->post_parent, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => 'ASC', 'orderby' => 'menu_order ID' ) ) );
2684
2685         foreach ( $attachments as $k => $attachment ) {
2686                 if ( $attachment->ID == $post->ID ) {
2687                         break;
2688                 }
2689         }
2690
2691         $output = '';
2692         $attachment_id = 0;
2693
2694         if ( $attachments ) {
2695                 $k = $prev ? $k - 1 : $k + 1;
2696
2697                 if ( isset( $attachments[ $k ] ) ) {
2698                         $attachment_id = $attachments[ $k ]->ID;
2699                         $output = wp_get_attachment_link( $attachment_id, $size, true, false, $text );
2700                 }
2701         }
2702
2703         $adjacent = $prev ? 'previous' : 'next';
2704
2705         /**
2706          * Filters the adjacent image link.
2707          *
2708          * The dynamic portion of the hook name, `$adjacent`, refers to the type of adjacency,
2709          * either 'next', or 'previous'.
2710          *
2711          * @since 3.5.0
2712          *
2713          * @param string $output        Adjacent image HTML markup.
2714          * @param int    $attachment_id Attachment ID
2715          * @param string $size          Image size.
2716          * @param string $text          Link text.
2717          */
2718         echo apply_filters( "{$adjacent}_image_link", $output, $attachment_id, $size, $text );
2719 }
2720
2721 /**
2722  * Retrieves taxonomies attached to given the attachment.
2723  *
2724  * @since 2.5.0
2725  * @since 4.7.0 Introduced the `$output` parameter.
2726  *
2727  * @param int|array|object $attachment Attachment ID, data array, or data object.
2728  * @param string           $output     Output type. 'names' to return an array of taxonomy names,
2729  *                                     or 'objects' to return an array of taxonomy objects.
2730  *                                     Default is 'names'.
2731  * @return array Empty array on failure. List of taxonomies on success.
2732  */
2733 function get_attachment_taxonomies( $attachment, $output = 'names' ) {
2734         if ( is_int( $attachment ) ) {
2735                 $attachment = get_post( $attachment );
2736         } elseif ( is_array( $attachment ) ) {
2737                 $attachment = (object) $attachment;
2738         }
2739         if ( ! is_object($attachment) )
2740                 return array();
2741
2742         $file = get_attached_file( $attachment->ID );
2743         $filename = basename( $file );
2744
2745         $objects = array('attachment');
2746
2747         if ( false !== strpos($filename, '.') )
2748                 $objects[] = 'attachment:' . substr($filename, strrpos($filename, '.') + 1);
2749         if ( !empty($attachment->post_mime_type) ) {
2750                 $objects[] = 'attachment:' . $attachment->post_mime_type;
2751                 if ( false !== strpos($attachment->post_mime_type, '/') )
2752                         foreach ( explode('/', $attachment->post_mime_type) as $token )
2753                                 if ( !empty($token) )
2754                                         $objects[] = "attachment:$token";
2755         }
2756
2757         $taxonomies = array();
2758         foreach ( $objects as $object ) {
2759                 if ( $taxes = get_object_taxonomies( $object, $output ) ) {
2760                         $taxonomies = array_merge( $taxonomies, $taxes );
2761                 }
2762         }
2763
2764         if ( 'names' === $output ) {
2765                 $taxonomies = array_unique( $taxonomies );
2766         }
2767
2768         return $taxonomies;
2769 }
2770
2771 /**
2772  * Retrieves all of the taxonomy names that are registered for attachments.
2773  *
2774  * Handles mime-type-specific taxonomies such as attachment:image and attachment:video.
2775  *
2776  * @since 3.5.0
2777  *
2778  * @see get_taxonomies()
2779  *
2780  * @param string $output Optional. The type of taxonomy output to return. Accepts 'names' or 'objects'.
2781  *                       Default 'names'.
2782  * @return array The names of all taxonomy of $object_type.
2783  */
2784 function get_taxonomies_for_attachments( $output = 'names' ) {
2785         $taxonomies = array();
2786         foreach ( get_taxonomies( array(), 'objects' ) as $taxonomy ) {
2787                 foreach ( $taxonomy->object_type as $object_type ) {
2788                         if ( 'attachment' == $object_type || 0 === strpos( $object_type, 'attachment:' ) ) {
2789                                 if ( 'names' == $output )
2790                                         $taxonomies[] = $taxonomy->name;
2791                                 else
2792                                         $taxonomies[ $taxonomy->name ] = $taxonomy;
2793                                 break;
2794                         }
2795                 }
2796         }
2797
2798         return $taxonomies;
2799 }
2800
2801 /**
2802  * Create new GD image resource with transparency support
2803  *
2804  * @todo: Deprecate if possible.
2805  *
2806  * @since 2.9.0
2807  *
2808  * @param int $width  Image width in pixels.
2809  * @param int $height Image height in pixels..
2810  * @return resource The GD image resource.
2811  */
2812 function wp_imagecreatetruecolor($width, $height) {
2813         $img = imagecreatetruecolor($width, $height);
2814         if ( is_resource($img) && function_exists('imagealphablending') && function_exists('imagesavealpha') ) {
2815                 imagealphablending($img, false);
2816                 imagesavealpha($img, true);
2817         }
2818         return $img;
2819 }
2820
2821 /**
2822  * Based on a supplied width/height example, return the biggest possible dimensions based on the max width/height.
2823  *
2824  * @since 2.9.0
2825  *
2826  * @see wp_constrain_dimensions()
2827  *
2828  * @param int $example_width  The width of an example embed.
2829  * @param int $example_height The height of an example embed.
2830  * @param int $max_width      The maximum allowed width.
2831  * @param int $max_height     The maximum allowed height.
2832  * @return array The maximum possible width and height based on the example ratio.
2833  */
2834 function wp_expand_dimensions( $example_width, $example_height, $max_width, $max_height ) {
2835         $example_width  = (int) $example_width;
2836         $example_height = (int) $example_height;
2837         $max_width      = (int) $max_width;
2838         $max_height     = (int) $max_height;
2839
2840         return wp_constrain_dimensions( $example_width * 1000000, $example_height * 1000000, $max_width, $max_height );
2841 }
2842
2843 /**
2844  * Determines the maximum upload size allowed in php.ini.
2845  *
2846  * @since 2.5.0
2847  *
2848  * @return int Allowed upload size.
2849  */
2850 function wp_max_upload_size() {
2851         $u_bytes = wp_convert_hr_to_bytes( ini_get( 'upload_max_filesize' ) );
2852         $p_bytes = wp_convert_hr_to_bytes( ini_get( 'post_max_size' ) );
2853
2854         /**
2855          * Filters the maximum upload size allowed in php.ini.
2856          *
2857          * @since 2.5.0
2858          *
2859          * @param int $size    Max upload size limit in bytes.
2860          * @param int $u_bytes Maximum upload filesize in bytes.
2861          * @param int $p_bytes Maximum size of POST data in bytes.
2862          */
2863         return apply_filters( 'upload_size_limit', min( $u_bytes, $p_bytes ), $u_bytes, $p_bytes );
2864 }
2865
2866 /**
2867  * Returns a WP_Image_Editor instance and loads file into it.
2868  *
2869  * @since 3.5.0
2870  *
2871  * @param string $path Path to the file to load.
2872  * @param array  $args Optional. Additional arguments for retrieving the image editor.
2873  *                     Default empty array.
2874  * @return WP_Image_Editor|WP_Error The WP_Image_Editor object if successful, an WP_Error
2875  *                                  object otherwise.
2876  */
2877 function wp_get_image_editor( $path, $args = array() ) {
2878         $args['path'] = $path;
2879
2880         if ( ! isset( $args['mime_type'] ) ) {
2881                 $file_info = wp_check_filetype( $args['path'] );
2882
2883                 // If $file_info['type'] is false, then we let the editor attempt to
2884                 // figure out the file type, rather than forcing a failure based on extension.
2885                 if ( isset( $file_info ) && $file_info['type'] )
2886                         $args['mime_type'] = $file_info['type'];
2887         }
2888
2889         $implementation = _wp_image_editor_choose( $args );
2890
2891         if ( $implementation ) {
2892                 $editor = new $implementation( $path );
2893                 $loaded = $editor->load();
2894
2895                 if ( is_wp_error( $loaded ) )
2896                         return $loaded;
2897
2898                 return $editor;
2899         }
2900
2901         return new WP_Error( 'image_no_editor', __('No editor could be selected.') );
2902 }
2903
2904 /**
2905  * Tests whether there is an editor that supports a given mime type or methods.
2906  *
2907  * @since 3.5.0
2908  *
2909  * @param string|array $args Optional. Array of arguments to retrieve the image editor supports.
2910  *                           Default empty array.
2911  * @return bool True if an eligible editor is found; false otherwise.
2912  */
2913 function wp_image_editor_supports( $args = array() ) {
2914         return (bool) _wp_image_editor_choose( $args );
2915 }
2916
2917 /**
2918  * Tests which editors are capable of supporting the request.
2919  *
2920  * @ignore
2921  * @since 3.5.0
2922  *
2923  * @param array $args Optional. Array of arguments for choosing a capable editor. Default empty array.
2924  * @return string|false Class name for the first editor that claims to support the request. False if no
2925  *                     editor claims to support the request.
2926  */
2927 function _wp_image_editor_choose( $args = array() ) {
2928         require_once ABSPATH . WPINC . '/class-wp-image-editor.php';
2929         require_once ABSPATH . WPINC . '/class-wp-image-editor-gd.php';
2930         require_once ABSPATH . WPINC . '/class-wp-image-editor-imagick.php';
2931         /**
2932          * Filters the list of image editing library classes.
2933          *
2934          * @since 3.5.0
2935          *
2936          * @param array $image_editors List of available image editors. Defaults are
2937          *                             'WP_Image_Editor_Imagick', 'WP_Image_Editor_GD'.
2938          */
2939         $implementations = apply_filters( 'wp_image_editors', array( 'WP_Image_Editor_Imagick', 'WP_Image_Editor_GD' ) );
2940
2941         foreach ( $implementations as $implementation ) {
2942                 if ( ! call_user_func( array( $implementation, 'test' ), $args ) )
2943                         continue;
2944
2945                 if ( isset( $args['mime_type'] ) &&
2946                         ! call_user_func(
2947                                 array( $implementation, 'supports_mime_type' ),
2948                                 $args['mime_type'] ) ) {
2949                         continue;
2950                 }
2951
2952                 if ( isset( $args['methods'] ) &&
2953                          array_diff( $args['methods'], get_class_methods( $implementation ) ) ) {
2954                         continue;
2955                 }
2956
2957                 return $implementation;
2958         }
2959
2960         return false;
2961 }
2962
2963 /**
2964  * Prints default Plupload arguments.
2965  *
2966  * @since 3.4.0
2967  */
2968 function wp_plupload_default_settings() {
2969         $wp_scripts = wp_scripts();
2970
2971         $data = $wp_scripts->get_data( 'wp-plupload', 'data' );
2972         if ( $data && false !== strpos( $data, '_wpPluploadSettings' ) )
2973                 return;
2974
2975         $max_upload_size = wp_max_upload_size();
2976         $allowed_extensions = array_keys( get_allowed_mime_types() );
2977         $extensions = array();
2978         foreach ( $allowed_extensions as $extension ) {
2979                 $extensions = array_merge( $extensions, explode( '|', $extension ) );
2980         }
2981
2982         $defaults = array(
2983                 'runtimes'            => 'html5,flash,silverlight,html4',
2984                 'file_data_name'      => 'async-upload', // key passed to $_FILE.
2985                 'url'                 => admin_url( 'async-upload.php', 'relative' ),
2986                 'flash_swf_url'       => includes_url( 'js/plupload/plupload.flash.swf' ),
2987                 'silverlight_xap_url' => includes_url( 'js/plupload/plupload.silverlight.xap' ),
2988                 'filters' => array(
2989                         'max_file_size'   => $max_upload_size . 'b',
2990                         'mime_types'      => array( array( 'extensions' => implode( ',', $extensions ) ) ),
2991                 ),
2992         );
2993
2994         // Currently only iOS Safari supports multiple files uploading but iOS 7.x has a bug that prevents uploading of videos
2995         // when enabled. See #29602.
2996         if ( wp_is_mobile() && strpos( $_SERVER['HTTP_USER_AGENT'], 'OS 7_' ) !== false &&
2997                 strpos( $_SERVER['HTTP_USER_AGENT'], 'like Mac OS X' ) !== false ) {
2998
2999                 $defaults['multi_selection'] = false;
3000         }
3001
3002         /**
3003          * Filters the Plupload default settings.
3004          *
3005          * @since 3.4.0
3006          *
3007          * @param array $defaults Default Plupload settings array.
3008          */
3009         $defaults = apply_filters( 'plupload_default_settings', $defaults );
3010
3011         $params = array(
3012                 'action' => 'upload-attachment',
3013         );
3014
3015         /**
3016          * Filters the Plupload default parameters.
3017          *
3018          * @since 3.4.0
3019          *
3020          * @param array $params Default Plupload parameters array.
3021          */
3022         $params = apply_filters( 'plupload_default_params', $params );
3023         $params['_wpnonce'] = wp_create_nonce( 'media-form' );
3024         $defaults['multipart_params'] = $params;
3025
3026         $settings = array(
3027                 'defaults' => $defaults,
3028                 'browser'  => array(
3029                         'mobile'    => wp_is_mobile(),
3030                         'supported' => _device_can_upload(),
3031                 ),
3032                 'limitExceeded' => is_multisite() && ! is_upload_space_available()
3033         );
3034
3035         $script = 'var _wpPluploadSettings = ' . wp_json_encode( $settings ) . ';';
3036
3037         if ( $data )
3038                 $script = "$data\n$script";
3039
3040         $wp_scripts->add_data( 'wp-plupload', 'data', $script );
3041 }
3042
3043 /**
3044  * Prepares an attachment post object for JS, where it is expected
3045  * to be JSON-encoded and fit into an Attachment model.
3046  *
3047  * @since 3.5.0
3048  *
3049  * @param mixed $attachment Attachment ID or object.
3050  * @return array|void Array of attachment details.
3051  */
3052 function wp_prepare_attachment_for_js( $attachment ) {
3053         if ( ! $attachment = get_post( $attachment ) )
3054                 return;
3055
3056         if ( 'attachment' != $attachment->post_type )
3057                 return;
3058
3059         $meta = wp_get_attachment_metadata( $attachment->ID );
3060         if ( false !== strpos( $attachment->post_mime_type, '/' ) )
3061                 list( $type, $subtype ) = explode( '/', $attachment->post_mime_type );
3062         else
3063                 list( $type, $subtype ) = array( $attachment->post_mime_type, '' );
3064
3065         $attachment_url = wp_get_attachment_url( $attachment->ID );
3066
3067         $response = array(
3068                 'id'          => $attachment->ID,
3069                 'title'       => $attachment->post_title,
3070                 'filename'    => wp_basename( get_attached_file( $attachment->ID ) ),
3071                 'url'         => $attachment_url,
3072                 'link'        => get_attachment_link( $attachment->ID ),
3073                 'alt'         => get_post_meta( $attachment->ID, '_wp_attachment_image_alt', true ),
3074                 'author'      => $attachment->post_author,
3075                 'description' => $attachment->post_content,
3076                 'caption'     => $attachment->post_excerpt,
3077                 'name'        => $attachment->post_name,
3078                 'status'      => $attachment->post_status,
3079                 'uploadedTo'  => $attachment->post_parent,
3080                 'date'        => strtotime( $attachment->post_date_gmt ) * 1000,
3081                 'modified'    => strtotime( $attachment->post_modified_gmt ) * 1000,
3082                 'menuOrder'   => $attachment->menu_order,
3083                 'mime'        => $attachment->post_mime_type,
3084                 'type'        => $type,
3085                 'subtype'     => $subtype,
3086                 'icon'        => wp_mime_type_icon( $attachment->ID ),
3087                 'dateFormatted' => mysql2date( __( 'F j, Y' ), $attachment->post_date ),
3088                 'nonces'      => array(
3089                         'update' => false,
3090                         'delete' => false,
3091                         'edit'   => false
3092                 ),
3093                 'editLink'   => false,
3094                 'meta'       => false,
3095         );
3096
3097         $author = new WP_User( $attachment->post_author );
3098         $response['authorName'] = $author->display_name;
3099
3100         if ( $attachment->post_parent ) {
3101                 $post_parent = get_post( $attachment->post_parent );
3102         } else {
3103                 $post_parent = false;
3104         }
3105
3106         if ( $post_parent ) {
3107                 $parent_type = get_post_type_object( $post_parent->post_type );
3108
3109                 if ( $parent_type && $parent_type->show_ui && current_user_can( 'edit_post', $attachment->post_parent ) ) {
3110                         $response['uploadedToLink'] = get_edit_post_link( $attachment->post_parent, 'raw' );
3111                 }
3112
3113                 if ( $parent_type && current_user_can( 'read_post', $attachment->post_parent ) ) {
3114                         $response['uploadedToTitle'] = $post_parent->post_title ? $post_parent->post_title : __( '(no title)' );
3115                 }
3116         }
3117
3118         $attached_file = get_attached_file( $attachment->ID );
3119
3120         if ( isset( $meta['filesize'] ) ) {
3121                 $bytes = $meta['filesize'];
3122         } elseif ( file_exists( $attached_file ) ) {
3123                 $bytes = filesize( $attached_file );
3124         } else {
3125                 $bytes = '';
3126         }
3127
3128         if ( $bytes ) {
3129                 $response['filesizeInBytes'] = $bytes;
3130                 $response['filesizeHumanReadable'] = size_format( $bytes );
3131         }
3132
3133         if ( current_user_can( 'edit_post', $attachment->ID ) ) {
3134                 $response['nonces']['update'] = wp_create_nonce( 'update-post_' . $attachment->ID );
3135                 $response['nonces']['edit'] = wp_create_nonce( 'image_editor-' . $attachment->ID );
3136                 $response['editLink'] = get_edit_post_link( $attachment->ID, 'raw' );
3137         }
3138
3139         if ( current_user_can( 'delete_post', $attachment->ID ) )
3140                 $response['nonces']['delete'] = wp_create_nonce( 'delete-post_' . $attachment->ID );
3141
3142         if ( $meta && ( 'image' === $type || ! empty( $meta['sizes'] ) ) ) {
3143                 $sizes = array();
3144
3145                 /** This filter is documented in wp-admin/includes/media.php */
3146                 $possible_sizes = apply_filters( 'image_size_names_choose', array(
3147                         'thumbnail' => __('Thumbnail'),
3148                         'medium'    => __('Medium'),
3149                         'large'     => __('Large'),
3150                         'full'      => __('Full Size'),
3151                 ) );
3152                 unset( $possible_sizes['full'] );
3153
3154                 // Loop through all potential sizes that may be chosen. Try to do this with some efficiency.
3155                 // First: run the image_downsize filter. If it returns something, we can use its data.
3156                 // If the filter does not return something, then image_downsize() is just an expensive
3157                 // way to check the image metadata, which we do second.
3158                 foreach ( $possible_sizes as $size => $label ) {
3159
3160                         /** This filter is documented in wp-includes/media.php */
3161                         if ( $downsize = apply_filters( 'image_downsize', false, $attachment->ID, $size ) ) {
3162                                 if ( empty( $downsize[3] ) ) {
3163                                         continue;
3164                                 }
3165
3166                                 $sizes[ $size ] = array(
3167                                         'height'      => $downsize[2],
3168                                         'width'       => $downsize[1],
3169                                         'url'         => $downsize[0],
3170                                         'orientation' => $downsize[2] > $downsize[1] ? 'portrait' : 'landscape',
3171                                 );
3172                         } elseif ( isset( $meta['sizes'][ $size ] ) ) {
3173                                 if ( ! isset( $base_url ) )
3174                                         $base_url = str_replace( wp_basename( $attachment_url ), '', $attachment_url );
3175
3176                                 // Nothing from the filter, so consult image metadata if we have it.
3177                                 $size_meta = $meta['sizes'][ $size ];
3178
3179                                 // We have the actual image size, but might need to further constrain it if content_width is narrower.
3180                                 // Thumbnail, medium, and full sizes are also checked against the site's height/width options.
3181                                 list( $width, $height ) = image_constrain_size_for_editor( $size_meta['width'], $size_meta['height'], $size, 'edit' );
3182
3183                                 $sizes[ $size ] = array(
3184                                         'height'      => $height,
3185                                         'width'       => $width,
3186                                         'url'         => $base_url . $size_meta['file'],
3187                                         'orientation' => $height > $width ? 'portrait' : 'landscape',
3188                                 );
3189                         }
3190                 }
3191
3192                 if ( 'image' === $type ) {
3193                         $sizes['full'] = array( 'url' => $attachment_url );
3194
3195                         if ( isset( $meta['height'], $meta['width'] ) ) {
3196                                 $sizes['full']['height'] = $meta['height'];
3197                                 $sizes['full']['width'] = $meta['width'];
3198                                 $sizes['full']['orientation'] = $meta['height'] > $meta['width'] ? 'portrait' : 'landscape';
3199                         }
3200
3201                         $response = array_merge( $response, $sizes['full'] );
3202                 } elseif ( $meta['sizes']['full']['file'] ) {
3203                         $sizes['full'] = array(
3204                                 'url'         => $base_url . $meta['sizes']['full']['file'],
3205                                 'height'      => $meta['sizes']['full']['height'],
3206                                 'width'       => $meta['sizes']['full']['width'],
3207                                 'orientation' => $meta['sizes']['full']['height'] > $meta['sizes']['full']['width'] ? 'portrait' : 'landscape'
3208                         );
3209                 }
3210
3211                 $response = array_merge( $response, array( 'sizes' => $sizes ) );
3212         }
3213
3214         if ( $meta && 'video' === $type ) {
3215                 if ( isset( $meta['width'] ) )
3216                         $response['width'] = (int) $meta['width'];
3217                 if ( isset( $meta['height'] ) )
3218                         $response['height'] = (int) $meta['height'];
3219         }
3220
3221         if ( $meta && ( 'audio' === $type || 'video' === $type ) ) {
3222                 if ( isset( $meta['length_formatted'] ) )
3223                         $response['fileLength'] = $meta['length_formatted'];
3224
3225                 $response['meta'] = array();
3226                 foreach ( wp_get_attachment_id3_keys( $attachment, 'js' ) as $key => $label ) {
3227                         $response['meta'][ $key ] = false;
3228
3229                         if ( ! empty( $meta[ $key ] ) ) {
3230                                 $response['meta'][ $key ] = $meta[ $key ];
3231                         }
3232                 }
3233
3234                 $id = get_post_thumbnail_id( $attachment->ID );
3235                 if ( ! empty( $id ) ) {
3236                         list( $src, $width, $height ) = wp_get_attachment_image_src( $id, 'full' );
3237                         $response['image'] = compact( 'src', 'width', 'height' );
3238                         list( $src, $width, $height ) = wp_get_attachment_image_src( $id, 'thumbnail' );
3239                         $response['thumb'] = compact( 'src', 'width', 'height' );
3240                 } else {
3241                         $src = wp_mime_type_icon( $attachment->ID );
3242                         $width = 48;
3243                         $height = 64;
3244                         $response['image'] = compact( 'src', 'width', 'height' );
3245                         $response['thumb'] = compact( 'src', 'width', 'height' );
3246                 }
3247         }
3248
3249         if ( function_exists('get_compat_media_markup') )
3250                 $response['compat'] = get_compat_media_markup( $attachment->ID, array( 'in_modal' => true ) );
3251
3252         /**
3253          * Filters the attachment data prepared for JavaScript.
3254          *
3255          * @since 3.5.0
3256          *
3257          * @param array      $response   Array of prepared attachment data.
3258          * @param int|object $attachment Attachment ID or object.
3259          * @param array      $meta       Array of attachment meta data.
3260          */
3261         return apply_filters( 'wp_prepare_attachment_for_js', $response, $attachment, $meta );
3262 }
3263
3264 /**
3265  * Enqueues all scripts, styles, settings, and templates necessary to use
3266  * all media JS APIs.
3267  *
3268  * @since 3.5.0
3269  *
3270  * @global int       $content_width
3271  * @global wpdb      $wpdb
3272  * @global WP_Locale $wp_locale
3273  *
3274  * @param array $args {
3275  *     Arguments for enqueuing media scripts.
3276  *
3277  *     @type int|WP_Post A post object or ID.
3278  * }
3279  */
3280 function wp_enqueue_media( $args = array() ) {
3281         // Enqueue me just once per page, please.
3282         if ( did_action( 'wp_enqueue_media' ) )
3283                 return;
3284
3285         global $content_width, $wpdb, $wp_locale;
3286
3287         $defaults = array(
3288                 'post' => null,
3289         );
3290         $args = wp_parse_args( $args, $defaults );
3291
3292         // We're going to pass the old thickbox media tabs to `media_upload_tabs`
3293         // to ensure plugins will work. We will then unset those tabs.
3294         $tabs = array(
3295                 // handler action suffix => tab label
3296                 'type'     => '',
3297                 'type_url' => '',
3298                 'gallery'  => '',
3299                 'library'  => '',
3300         );
3301
3302         /** This filter is documented in wp-admin/includes/media.php */
3303         $tabs = apply_filters( 'media_upload_tabs', $tabs );
3304         unset( $tabs['type'], $tabs['type_url'], $tabs['gallery'], $tabs['library'] );
3305
3306         $props = array(
3307                 'link'  => get_option( 'image_default_link_type' ), // db default is 'file'
3308                 'align' => get_option( 'image_default_align' ), // empty default
3309                 'size'  => get_option( 'image_default_size' ),  // empty default
3310         );
3311
3312         $exts = array_merge( wp_get_audio_extensions(), wp_get_video_extensions() );
3313         $mimes = get_allowed_mime_types();
3314         $ext_mimes = array();
3315         foreach ( $exts as $ext ) {
3316                 foreach ( $mimes as $ext_preg => $mime_match ) {
3317                         if ( preg_match( '#' . $ext . '#i', $ext_preg ) ) {
3318                                 $ext_mimes[ $ext ] = $mime_match;
3319                                 break;
3320                         }
3321                 }
3322         }
3323
3324         $has_audio = $wpdb->get_var( "
3325                 SELECT ID
3326                 FROM $wpdb->posts
3327                 WHERE post_type = 'attachment'
3328                 AND post_mime_type LIKE 'audio%'
3329                 LIMIT 1
3330         " );
3331         $has_video = $wpdb->get_var( "
3332                 SELECT ID
3333                 FROM $wpdb->posts
3334                 WHERE post_type = 'attachment'
3335                 AND post_mime_type LIKE 'video%'
3336                 LIMIT 1
3337         " );
3338         $months = $wpdb->get_results( $wpdb->prepare( "
3339                 SELECT DISTINCT YEAR( post_date ) AS year, MONTH( post_date ) AS month
3340                 FROM $wpdb->posts
3341                 WHERE post_type = %s
3342                 ORDER BY post_date DESC
3343         ", 'attachment' ) );
3344         foreach ( $months as $month_year ) {
3345                 $month_year->text = sprintf( __( '%1$s %2$d' ), $wp_locale->get_month( $month_year->month ), $month_year->year );
3346         }
3347
3348         $settings = array(
3349                 'tabs'      => $tabs,
3350                 'tabUrl'    => add_query_arg( array( 'chromeless' => true ), admin_url('media-upload.php') ),
3351                 'mimeTypes' => wp_list_pluck( get_post_mime_types(), 0 ),
3352                 /** This filter is documented in wp-admin/includes/media.php */
3353                 'captions'  => ! apply_filters( 'disable_captions', '' ),
3354                 'nonce'     => array(
3355                         'sendToEditor' => wp_create_nonce( 'media-send-to-editor' ),
3356                 ),
3357                 'post'    => array(
3358                         'id' => 0,
3359                 ),
3360                 'defaultProps' => $props,
3361                 'attachmentCounts' => array(
3362                         'audio' => ( $has_audio ) ? 1 : 0,
3363                         'video' => ( $has_video ) ? 1 : 0
3364                 ),
3365                 'embedExts'    => $exts,
3366                 'embedMimes'   => $ext_mimes,
3367                 'contentWidth' => $content_width,
3368                 'months'       => $months,
3369                 'mediaTrash'   => MEDIA_TRASH ? 1 : 0
3370         );
3371
3372         $post = null;
3373         if ( isset( $args['post'] ) ) {
3374                 $post = get_post( $args['post'] );
3375                 $settings['post'] = array(
3376                         'id' => $post->ID,
3377                         'nonce' => wp_create_nonce( 'update-post_' . $post->ID ),
3378                 );
3379
3380                 $thumbnail_support = current_theme_supports( 'post-thumbnails', $post->post_type ) && post_type_supports( $post->post_type, 'thumbnail' );
3381                 if ( ! $thumbnail_support && 'attachment' === $post->post_type && $post->post_mime_type ) {
3382                         if ( wp_attachment_is( 'audio', $post ) ) {
3383                                 $thumbnail_support = post_type_supports( 'attachment:audio', 'thumbnail' ) || current_theme_supports( 'post-thumbnails', 'attachment:audio' );
3384                         } elseif ( wp_attachment_is( 'video', $post ) ) {
3385                                 $thumbnail_support = post_type_supports( 'attachment:video', 'thumbnail' ) || current_theme_supports( 'post-thumbnails', 'attachment:video' );
3386                         }
3387                 }
3388
3389                 if ( $thumbnail_support ) {
3390                         $featured_image_id = get_post_meta( $post->ID, '_thumbnail_id', true );
3391                         $settings['post']['featuredImageId'] = $featured_image_id ? $featured_image_id : -1;
3392                 }
3393         }
3394
3395         if ( $post ) {
3396                 $post_type_object = get_post_type_object( $post->post_type );
3397         } else {
3398                 $post_type_object = get_post_type_object( 'post' );
3399         }
3400
3401         $strings = array(
3402                 // Generic
3403                 'url'         => __( 'URL' ),
3404                 'addMedia'    => __( 'Add Media' ),
3405                 'search'      => __( 'Search' ),
3406                 'select'      => __( 'Select' ),
3407                 'cancel'      => __( 'Cancel' ),
3408                 'update'      => __( 'Update' ),
3409                 'replace'     => __( 'Replace' ),
3410                 'remove'      => __( 'Remove' ),
3411                 'back'        => __( 'Back' ),
3412                 /* translators: This is a would-be plural string used in the media manager.
3413                    If there is not a word you can use in your language to avoid issues with the
3414                    lack of plural support here, turn it into "selected: %d" then translate it.
3415                  */
3416                 'selected'    => __( '%d selected' ),
3417                 'dragInfo'    => __( 'Drag and drop to reorder media files.' ),
3418
3419                 // Upload
3420                 'uploadFilesTitle'  => __( 'Upload Files' ),
3421                 'uploadImagesTitle' => __( 'Upload Images' ),
3422
3423                 // Library
3424                 'mediaLibraryTitle'      => __( 'Media Library' ),
3425                 'insertMediaTitle'       => __( 'Insert Media' ),
3426                 'createNewGallery'       => __( 'Create a new gallery' ),
3427                 'createNewPlaylist'      => __( 'Create a new playlist' ),
3428                 'createNewVideoPlaylist' => __( 'Create a new video playlist' ),
3429                 'returnToLibrary'        => __( '&#8592; Return to library' ),
3430                 'allMediaItems'          => __( 'All media items' ),
3431                 'allDates'               => __( 'All dates' ),
3432                 'noItemsFound'           => __( 'No items found.' ),
3433                 'insertIntoPost'         => $post_type_object->labels->insert_into_item,
3434                 'unattached'             => __( 'Unattached' ),
3435                 'trash'                  => _x( 'Trash', 'noun' ),
3436                 'uploadedToThisPost'     => $post_type_object->labels->uploaded_to_this_item,
3437                 'warnDelete'             => __( "You are about to permanently delete this item.\n  'Cancel' to stop, 'OK' to delete." ),
3438                 'warnBulkDelete'         => __( "You are about to permanently delete these items.\n  'Cancel' to stop, 'OK' to delete." ),
3439                 'warnBulkTrash'          => __( "You are about to trash these items.\n  'Cancel' to stop, 'OK' to delete." ),
3440                 'bulkSelect'             => __( 'Bulk Select' ),
3441                 'cancelSelection'        => __( 'Cancel Selection' ),
3442                 'trashSelected'          => __( 'Trash Selected' ),
3443                 'untrashSelected'        => __( 'Untrash Selected' ),
3444                 'deleteSelected'         => __( 'Delete Selected' ),
3445                 'deletePermanently'      => __( 'Delete Permanently' ),
3446                 'apply'                  => __( 'Apply' ),
3447                 'filterByDate'           => __( 'Filter by date' ),
3448                 'filterByType'           => __( 'Filter by type' ),
3449                 'searchMediaLabel'       => __( 'Search Media' ),
3450                 'searchMediaPlaceholder' => __( 'Search media items...' ), // placeholder (no ellipsis)
3451                 'noMedia'                => __( 'No media files found.' ),
3452
3453                 // Library Details
3454                 'attachmentDetails'  => __( 'Attachment Details' ),
3455
3456                 // From URL
3457                 'insertFromUrlTitle' => __( 'Insert from URL' ),
3458
3459                 // Featured Images
3460                 'setFeaturedImageTitle' => $post_type_object->labels->featured_image,
3461                 'setFeaturedImage'      => $post_type_object->labels->set_featured_image,
3462
3463                 // Gallery
3464                 'createGalleryTitle' => __( 'Create Gallery' ),
3465                 'editGalleryTitle'   => __( 'Edit Gallery' ),
3466                 'cancelGalleryTitle' => __( '&#8592; Cancel Gallery' ),
3467                 'insertGallery'      => __( 'Insert gallery' ),
3468                 'updateGallery'      => __( 'Update gallery' ),
3469                 'addToGallery'       => __( 'Add to gallery' ),
3470                 'addToGalleryTitle'  => __( 'Add to Gallery' ),
3471                 'reverseOrder'       => __( 'Reverse order' ),
3472
3473                 // Edit Image
3474                 'imageDetailsTitle'     => __( 'Image Details' ),
3475                 'imageReplaceTitle'     => __( 'Replace Image' ),
3476                 'imageDetailsCancel'    => __( 'Cancel Edit' ),
3477                 'editImage'             => __( 'Edit Image' ),
3478
3479                 // Crop Image
3480                 'chooseImage' => __( 'Choose Image' ),
3481                 'selectAndCrop' => __( 'Select and Crop' ),
3482                 'skipCropping' => __( 'Skip Cropping' ),
3483                 'cropImage' => __( 'Crop Image' ),
3484                 'cropYourImage' => __( 'Crop your image' ),
3485                 'cropping' => __( 'Cropping&hellip;' ),
3486                 'suggestedDimensions' => __( 'Suggested image dimensions:' ),
3487                 'cropError' => __( 'There has been an error cropping your image.' ),
3488
3489                 // Edit Audio
3490                 'audioDetailsTitle'     => __( 'Audio Details' ),
3491                 'audioReplaceTitle'     => __( 'Replace Audio' ),
3492                 'audioAddSourceTitle'   => __( 'Add Audio Source' ),
3493                 'audioDetailsCancel'    => __( 'Cancel Edit' ),
3494
3495                 // Edit Video
3496                 'videoDetailsTitle'     => __( 'Video Details' ),
3497                 'videoReplaceTitle'     => __( 'Replace Video' ),
3498                 'videoAddSourceTitle'   => __( 'Add Video Source' ),
3499                 'videoDetailsCancel'    => __( 'Cancel Edit' ),
3500                 'videoSelectPosterImageTitle' => __( 'Select Poster Image' ),
3501                 'videoAddTrackTitle'    => __( 'Add Subtitles' ),
3502
3503                 // Playlist
3504                 'playlistDragInfo'    => __( 'Drag and drop to reorder tracks.' ),
3505                 'createPlaylistTitle' => __( 'Create Audio Playlist' ),
3506                 'editPlaylistTitle'   => __( 'Edit Audio Playlist' ),
3507                 'cancelPlaylistTitle' => __( '&#8592; Cancel Audio Playlist' ),
3508                 'insertPlaylist'      => __( 'Insert audio playlist' ),
3509                 'updatePlaylist'      => __( 'Update audio playlist' ),
3510                 'addToPlaylist'       => __( 'Add to audio playlist' ),
3511                 'addToPlaylistTitle'  => __( 'Add to Audio Playlist' ),
3512
3513                 // Video Playlist
3514                 'videoPlaylistDragInfo'    => __( 'Drag and drop to reorder videos.' ),
3515                 'createVideoPlaylistTitle' => __( 'Create Video Playlist' ),
3516                 'editVideoPlaylistTitle'   => __( 'Edit Video Playlist' ),
3517                 'cancelVideoPlaylistTitle' => __( '&#8592; Cancel Video Playlist' ),
3518                 'insertVideoPlaylist'      => __( 'Insert video playlist' ),
3519                 'updateVideoPlaylist'      => __( 'Update video playlist' ),
3520                 'addToVideoPlaylist'       => __( 'Add to video playlist' ),
3521                 'addToVideoPlaylistTitle'  => __( 'Add to Video Playlist' ),
3522         );
3523
3524         /**
3525          * Filters the media view settings.
3526          *
3527          * @since 3.5.0
3528          *
3529          * @param array   $settings List of media view settings.
3530          * @param WP_Post $post     Post object.
3531          */
3532         $settings = apply_filters( 'media_view_settings', $settings, $post );
3533
3534         /**
3535          * Filters the media view strings.
3536          *
3537          * @since 3.5.0
3538          *
3539          * @param array   $strings List of media view strings.
3540          * @param WP_Post $post    Post object.
3541          */
3542         $strings = apply_filters( 'media_view_strings', $strings,  $post );
3543
3544         $strings['settings'] = $settings;
3545
3546         // Ensure we enqueue media-editor first, that way media-views is
3547         // registered internally before we try to localize it. see #24724.
3548         wp_enqueue_script