wp-includes/media.php

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