PageRenderTime 18ms CodeModel.GetById 401ms app.highlight 119ms RepoModel.GetById 1ms app.codeStats 1ms

/wp-includes/media.php

https://github.com/thejameskyle/WordPress
PHP | 3191 lines | 1578 code | 342 blank | 1271 comment | 319 complexity | 8301db4dd3f605fd1f9c2fa7fac936ca MD5 | raw file
   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 */
  36function 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 */
 115function 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 */
 146function 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 */
 225function 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 */
 243function 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 */
 257function 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 */
 280function 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 */
 305function 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 */
 359function 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 */
 426function 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 */
 530function 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 */
 573function 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 */
 628function 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 */
 657function 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 */
 695function 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 */
 746function _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 */
 756function _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 */
 765function _wp_post_thumbnail_class_filter_remove( $attr ) {
 766	remove_filter( 'wp_get_attachment_image_attributes', '_wp_post_thumbnail_class_filter' );
 767}
 768
 769add_shortcode('wp_caption', 'img_caption_shortcode');
 770add_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 */
 797function 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
 873add_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 */
 906function 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		}
 917		$attr['include'] = $attr['ids'];
 918	}
 919
 920	/**
 921	 * Filter the default gallery shortcode output.
 922	 *
 923	 * If the filtered output isn't empty, it will be used instead of generating
 924	 * the default gallery template.
 925	 *
 926	 * @since 2.5.0
 927	 *
 928	 * @see gallery_shortcode()
 929	 *
 930	 * @param string $output The gallery output. Default empty.
 931	 * @param array  $attr   Attributes of the gallery shortcode.
 932	 */
 933	$output = apply_filters( 'post_gallery', '', $attr );
 934	if ( $output != '' ) {
 935		return $output;
 936	}
 937
 938	// We're trusting author input, so let's at least make sure it looks like a valid orderby statement
 939	if ( isset( $attr['orderby'] ) ) {
 940		$attr['orderby'] = sanitize_sql_orderby( $attr['orderby'] );
 941		if ( ! $attr['orderby'] ) {
 942			unset( $attr['orderby'] );
 943		}
 944	}
 945
 946	$html5 = current_theme_supports( 'html5', 'gallery' );
 947	$atts = shortcode_atts( array(
 948		'order'      => 'ASC',
 949		'orderby'    => 'menu_order ID',
 950		'id'         => $post ? $post->ID : 0,
 951		'itemtag'    => $html5 ? 'figure'     : 'dl',
 952		'icontag'    => $html5 ? 'div'        : 'dt',
 953		'captiontag' => $html5 ? 'figcaption' : 'dd',
 954		'columns'    => 3,
 955		'size'       => 'thumbnail',
 956		'include'    => '',
 957		'exclude'    => '',
 958		'link'       => ''
 959	), $attr, 'gallery' );
 960
 961	$id = intval( $atts['id'] );
 962	if ( 'RAND' == $atts['order'] ) {
 963		$atts['orderby'] = 'none';
 964	}
 965
 966	if ( ! empty( $atts['include'] ) ) {
 967		$_attachments = get_posts( array( 'include' => $atts['include'], 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $atts['order'], 'orderby' => $atts['orderby'] ) );
 968
 969		$attachments = array();
 970		foreach ( $_attachments as $key => $val ) {
 971			$attachments[$val->ID] = $_attachments[$key];
 972		}
 973	} elseif ( ! empty( $atts['exclude'] ) ) {
 974		$attachments = get_children( array( 'post_parent' => $id, 'exclude' => $atts['exclude'], 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $atts['order'], 'orderby' => $atts['orderby'] ) );
 975	} else {
 976		$attachments = get_children( array( 'post_parent' => $id, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $atts['order'], 'orderby' => $atts['orderby'] ) );
 977	}
 978
 979	if ( empty( $attachments ) ) {
 980		return '';
 981	}
 982
 983	if ( is_feed() ) {
 984		$output = "\n";
 985		foreach ( $attachments as $att_id => $attachment ) {
 986			$output .= wp_get_attachment_link( $att_id, $atts['size'], true ) . "\n";
 987		}
 988		return $output;
 989	}
 990
 991	$itemtag = tag_escape( $atts['itemtag'] );
 992	$captiontag = tag_escape( $atts['captiontag'] );
 993	$icontag = tag_escape( $atts['icontag'] );
 994	$valid_tags = wp_kses_allowed_html( 'post' );
 995	if ( ! isset( $valid_tags[ $itemtag ] ) ) {
 996		$itemtag = 'dl';
 997	}
 998	if ( ! isset( $valid_tags[ $captiontag ] ) ) {
 999		$captiontag = 'dd';
1000	}
1001	if ( ! isset( $valid_tags[ $icontag ] ) ) {
1002		$icontag = 'dt';
1003	}
1004
1005	$columns = intval( $atts['columns'] );
1006	$itemwidth = $columns > 0 ? floor(100/$columns) : 100;
1007	$float = is_rtl() ? 'right' : 'left';
1008
1009	$selector = "gallery-{$instance}";
1010
1011	$gallery_style = '';
1012
1013	/**
1014	 * Filter whether to print default gallery styles.
1015	 *
1016	 * @since 3.1.0
1017	 *
1018	 * @param bool $print Whether to print default gallery styles.
1019	 *                    Defaults to false if the theme supports HTML5 galleries.
1020	 *                    Otherwise, defaults to true.
1021	 */
1022	if ( apply_filters( 'use_default_gallery_style', ! $html5 ) ) {
1023		$gallery_style = "
1024		<style type='text/css'>
1025			#{$selector} {
1026				margin: auto;
1027			}
1028			#{$selector} .gallery-item {
1029				float: {$float};
1030				margin-top: 10px;
1031				text-align: center;
1032				width: {$itemwidth}%;
1033			}
1034			#{$selector} img {
1035				border: 2px solid #cfcfcf;
1036			}
1037			#{$selector} .gallery-caption {
1038				margin-left: 0;
1039			}
1040			/* see gallery_shortcode() in wp-includes/media.php */
1041		</style>\n\t\t";
1042	}
1043
1044	$size_class = sanitize_html_class( $atts['size'] );
1045	$gallery_div = "<div id='$selector' class='gallery galleryid-{$id} gallery-columns-{$columns} gallery-size-{$size_class}'>";
1046
1047	/**
1048	 * Filter the default gallery shortcode CSS styles.
1049	 *
1050	 * @since 2.5.0
1051	 *
1052	 * @param string $gallery_style Default gallery shortcode CSS styles.
1053	 * @param string $gallery_div   Opening HTML div container for the gallery shortcode output.
1054	 */
1055	$output = apply_filters( 'gallery_style', $gallery_style . $gallery_div );
1056
1057	$i = 0;
1058	foreach ( $attachments as $id => $attachment ) {
1059		if ( ! empty( $atts['link'] ) && 'file' === $atts['link'] ) {
1060			$image_output = wp_get_attachment_link( $id, $atts['size'], false, false );
1061		} elseif ( ! empty( $atts['link'] ) && 'none' === $atts['link'] ) {
1062			$image_output = wp_get_attachment_image( $id, $atts['size'], false );
1063		} else {
1064			$image_output = wp_get_attachment_link( $id, $atts['size'], true, false );
1065		}
1066		$image_meta  = wp_get_attachment_metadata( $id );
1067
1068		$orientation = '';
1069		if ( isset( $image_meta['height'], $image_meta['width'] ) ) {
1070			$orientation = ( $image_meta['height'] > $image_meta['width'] ) ? 'portrait' : 'landscape';
1071		}
1072		$output .= "<{$itemtag} class='gallery-item'>";
1073		$output .= "
1074			<{$icontag} class='gallery-icon {$orientation}'>
1075				$image_output
1076			</{$icontag}>";
1077		if ( $captiontag && trim($attachment->post_excerpt) ) {
1078			$output .= "
1079				<{$captiontag} class='wp-caption-text gallery-caption'>
1080				" . wptexturize($attachment->post_excerpt) . "
1081				</{$captiontag}>";
1082		}
1083		$output .= "</{$itemtag}>";
1084		if ( ! $html5 && $columns > 0 && ++$i % $columns == 0 ) {
1085			$output .= '<br style="clear: both" />';
1086		}
1087	}
1088
1089	if ( ! $html5 && $columns > 0 && $i % $columns !== 0 ) {
1090		$output .= "
1091			<br style='clear: both' />";
1092	}
1093
1094	$output .= "
1095		</div>\n";
1096
1097	return $output;
1098}
1099
1100/**
1101 * Output the templates used by playlists.
1102 *
1103 * @since 3.9.0
1104 */
1105function wp_underscore_playlist_templates() {
1106?>
1107<script type="text/html" id="tmpl-wp-playlist-current-item">
1108	<# if ( data.image ) { #>
1109	<img src="{{ data.thumb.src }}"/>
1110	<# } #>
1111	<div class="wp-playlist-caption">
1112		<span class="wp-playlist-item-meta wp-playlist-item-title">&#8220;{{ data.title }}&#8221;</span>
1113		<# if ( data.meta.album ) { #><span class="wp-playlist-item-meta wp-playlist-item-album">{{ data.meta.album }}</span><# } #>
1114		<# if ( data.meta.artist ) { #><span class="wp-playlist-item-meta wp-playlist-item-artist">{{ data.meta.artist }}</span><# } #>
1115	</div>
1116</script>
1117<script type="text/html" id="tmpl-wp-playlist-item">
1118	<div class="wp-playlist-item">
1119		<a class="wp-playlist-caption" href="{{ data.src }}">
1120			{{ data.index ? ( data.index + '. ' ) : '' }}
1121			<# if ( data.caption ) { #>
1122				{{ data.caption }}
1123			<# } else { #>
1124				<span class="wp-playlist-item-title">&#8220;{{{ data.title }}}&#8221;</span>
1125				<# if ( data.artists && data.meta.artist ) { #>
1126				<span class="wp-playlist-item-artist"> &mdash; {{ data.meta.artist }}</span>
1127				<# } #>
1128			<# } #>
1129		</a>
1130		<# if ( data.meta.length_formatted ) { #>
1131		<div class="wp-playlist-item-length">{{ data.meta.length_formatted }}</div>
1132		<# } #>
1133	</div>
1134</script>
1135<?php
1136}
1137
1138/**
1139 * Output and enqueue default scripts and styles for playlists.
1140 *
1141 * @since 3.9.0
1142 *
1143 * @param string $type Type of playlist. Accepts 'audio' or 'video'.
1144 */
1145function wp_playlist_scripts( $type ) {
1146	wp_enqueue_style( 'wp-mediaelement' );
1147	wp_enqueue_script( 'wp-playlist' );
1148?>
1149<!--[if lt IE 9]><script>document.createElement('<?php echo esc_js( $type ) ?>');</script><![endif]-->
1150<?php
1151	add_action( 'wp_footer', 'wp_underscore_playlist_templates', 0 );
1152	add_action( 'admin_footer', 'wp_underscore_playlist_templates', 0 );
1153}
1154add_action( 'wp_playlist_scripts', 'wp_playlist_scripts' );
1155
1156/**
1157 * The playlist shortcode.
1158 *
1159 * This implements the functionality of the playlist shortcode for displaying
1160 * a collection of WordPress audio or video files in a post.
1161 *
1162 * @since 3.9.0
1163 *
1164 * @param array $attr Playlist shortcode attributes.
1165 * @return string Playlist output. Empty string if the passed type is unsupported.
1166 */
1167function wp_playlist_shortcode( $attr ) {
1168	global $content_width;
1169	$post = get_post();
1170
1171	static $instance = 0;
1172	$instance++;
1173
1174	if ( ! empty( $attr['ids'] ) ) {
1175		// 'ids' is explicitly ordered, unless you specify otherwise.
1176		if ( empty( $attr['orderby'] ) ) {
1177			$attr['orderby'] = 'post__in';
1178		}
1179		$attr['include'] = $attr['ids'];
1180	}
1181
1182	/**
1183	 * Filter the playlist output.
1184	 *
1185	 * Passing a non-empty value to the filter will short-circuit generation
1186	 * of the default playlist output, returning the passed value instead.
1187	 *
1188	 * @since 3.9.0
1189	 *
1190	 * @param string $output Playlist output. Default empty.
1191	 * @param array  $attr   An array of shortcode attributes.
1192	 */
1193	$output = apply_filters( 'post_playlist', '', $attr );
1194	if ( $output != '' ) {
1195		return $output;
1196	}
1197
1198	/*
1199	 * We're trusting author input, so let's at least make sure it looks
1200	 * like a valid orderby statement.
1201	 */
1202	if ( isset( $attr['orderby'] ) ) {
1203		$attr['orderby'] = sanitize_sql_orderby( $attr['orderby'] );
1204		if ( ! $attr['orderby'] )
1205			unset( $attr['orderby'] );
1206	}
1207
1208	$atts = shortcode_atts( array(
1209		'type'		=> 'audio',
1210		'order'		=> 'ASC',
1211		'orderby'	=> 'menu_order ID',
1212		'id'		=> $post ? $post->ID : 0,
1213		'include'	=> '',
1214		'exclude'   => '',
1215		'style'		=> 'light',
1216		'tracklist' => true,
1217		'tracknumbers' => true,
1218		'images'	=> true,
1219		'artists'	=> true
1220	), $attr, 'playlist' );
1221
1222	$id = intval( $atts['id'] );
1223	if ( 'RAND' == $atts['order'] ) {
1224		$atts['orderby'] = 'none';
1225	}
1226
1227	$args = array(
1228		'post_status' => 'inherit',
1229		'post_type' => 'attachment',
1230		'post_mime_type' => $atts['type'],
1231		'order' => $atts['order'],
1232		'orderby' => $atts['orderby']
1233	);
1234
1235	if ( ! empty( $atts['include'] ) ) {
1236		$args['include'] = $atts['include'];
1237		$_attachments = get_posts( $args );
1238
1239		$attachments = array();
1240		foreach ( $_attachments as $key => $val ) {
1241			$attachments[$val->ID] = $_attachments[$key];
1242		}
1243	} elseif ( ! empty( $atts['exclude'] ) ) {
1244		$args['post_parent'] = $id;
1245		$args['exclude'] = $atts['exclude'];
1246		$attachments = get_children( $args );
1247	} else {
1248		$args['post_parent'] = $id;
1249		$attachments = get_children( $args );
1250	}
1251
1252	if ( empty( $attachments ) ) {
1253		return '';
1254	}
1255
1256	if ( is_feed() ) {
1257		$output = "\n";
1258		foreach ( $attachments as $att_id => $attachment ) {
1259			$output .= wp_get_attachment_link( $att_id ) . "\n";
1260		}
1261		return $output;
1262	}
1263
1264	$outer = 22; // default padding and border of wrapper
1265
1266	$default_width = 640;
1267	$default_height = 360;
1268
1269	$theme_width = empty( $content_width ) ? $default_width : ( $content_width - $outer );
1270	$theme_height = empty( $content_width ) ? $default_height : round( ( $default_height * $theme_width ) / $default_width );
1271
1272	$data = array(
1273		'type' => $atts['type'],
1274		// don't pass strings to JSON, will be truthy in JS
1275		'tracklist' => wp_validate_boolean( $atts['tracklist'] ),
1276		'tracknumbers' => wp_validate_boolean( $atts['tracknumbers'] ),
1277		'images' => wp_validate_boolean( $atts['images'] ),
1278		'artists' => wp_validate_boolean( $atts['artists'] ),
1279	);
1280
1281	$tracks = array();
1282	foreach ( $attachments as $attachment ) {
1283		$url = wp_get_attachment_url( $attachment->ID );
1284		$ftype = wp_check_filetype( $url, wp_get_mime_types() );
1285		$track = array(
1286			'src' => $url,
1287			'type' => $ftype['type'],
1288			'title' => $attachment->post_title,
1289			'caption' => $attachment->post_excerpt,
1290			'description' => $attachment->post_content
1291		);
1292
1293		$track['meta'] = array();
1294		$meta = wp_get_attachment_metadata( $attachment->ID );
1295		if ( ! empty( $meta ) ) {
1296
1297			foreach ( wp_get_attachment_id3_keys( $attachment ) as $key => $label ) {
1298				if ( ! empty( $meta[ $key ] ) ) {
1299					$track['meta'][ $key ] = $meta[ $key ];
1300				}
1301			}
1302
1303			if ( 'video' === $atts['type'] ) {
1304				if ( ! empty( $meta['width'] ) && ! empty( $meta['height'] ) ) {
1305					$width = $meta['width'];
1306					$height = $meta['height'];
1307					$theme_height = round( ( $height * $theme_width ) / $width );
1308				} else {
1309					$width = $default_width;
1310					$height = $default_height;
1311				}
1312
1313				$track['dimensions'] = array(
1314					'original' => compact( 'width', 'height' ),
1315					'resized' => array(
1316						'width' => $theme_width,
1317						'height' => $theme_height
1318					)
1319				);
1320			}
1321		}
1322
1323		if ( $atts['images'] ) {
1324			$thumb_id = get_post_thumbnail_id( $attachment->ID );
1325			if ( ! empty( $thumb_id ) ) {
1326				list( $src, $width, $height ) = wp_get_attachment_image_src( $thumb_id, 'full' );
1327				$track['image'] = compact( 'src', 'width', 'height' );
1328				list( $src, $width, $height ) = wp_get_attachment_image_src( $thumb_id, 'thumbnail' );
1329				$track['thumb'] = compact( 'src', 'width', 'height' );
1330			} else {
1331				$src = wp_mime_type_icon( $attachment->ID );
1332				$width = 48;
1333				$height = 64;
1334				$track['image'] = compact( 'src', 'width', 'height' );
1335				$track['thumb'] = compact( 'src', 'width', 'height' );
1336			}
1337		}
1338
1339		$tracks[] = $track;
1340	}
1341	$data['tracks'] = $tracks;
1342
1343	$safe_type = esc_attr( $atts['type'] );
1344	$safe_style = esc_attr( $atts['style'] );
1345
1346	ob_start();
1347
1348	if ( 1 === $instance ) {
1349		/**
1350		 * Print and enqueue playlist scripts, styles, and JavaScript templates.
1351		 *
1352		 * @since 3.9.0
1353		 *
1354		 * @param string $type  Type of playlist. Possible values are 'audio' or 'video'.
1355		 * @param string $style The 'theme' for the playlist. Core provides 'light' and 'dark'.
1356		 */
1357		do_action( 'wp_playlist_scripts', $atts['type'], $atts['style'] );
1358	} ?>
1359<div class="wp-playlist wp-<?php echo $safe_type ?>-playlist wp-playlist-<?php echo $safe_style ?>">
1360	<?php if ( 'audio' === $atts['type'] ): ?>
1361	<div class="wp-playlist-current-item"></div>
1362	<?php endif ?>
1363	<<?php echo $safe_type ?> controls="controls" preload="none" width="<?php
1364		echo (int) $theme_width;
1365	?>"<?php if ( 'video' === $safe_type ):
1366		echo ' height="', (int) $theme_height, '"';
1367	else:
1368		echo ' style="visibility: hidden"';
1369	endif; ?>></<?php echo $safe_type ?>>
1370	<div class="wp-playlist-next"></div>
1371	<div class="wp-playlist-prev"></div>
1372	<noscript>
1373	<ol><?php
1374	foreach ( $attachments as $att_id => $attachment ) {
1375		printf( '<li>%s</li>', wp_get_attachment_link( $att_id ) );
1376	}
1377	?></ol>
1378	</noscript>
1379	<script type="application/json"><?php echo json_encode( $data ) ?></script>
1380</div>
1381	<?php
1382	return ob_get_clean();
1383}
1384add_shortcode( 'playlist', 'wp_playlist_shortcode' );
1385
1386/**
1387 * Provide a No-JS Flash fallback as a last resort for audio / video
1388 *
1389 * @since 3.6.0
1390 *
1391 * @param string $url
1392 * @return string Fallback HTML
1393 */
1394function wp_mediaelement_fallback( $url ) {
1395	/**
1396	 * Filter the Mediaelement fallback output for no-JS.
1397	 *
1398	 * @since 3.6.0
1399	 *
1400	 * @param string $output Fallback output for no-JS.
1401	 * @param string $url    Media file URL.
1402	 */
1403	return apply_filters( 'wp_mediaelement_fallback', sprintf( '<a href="%1$s">%1$s</a>', esc_url( $url ) ), $url );
1404}
1405
1406/**
1407 * Return a filtered list of WP-supported audio formats.
1408 *
1409 * @since 3.6.0
1410 * @return array
1411 */
1412function wp_get_audio_extensions() {
1413	/**
1414	 * Filter the list of supported audio formats.
1415	 *
1416	 * @since 3.6.0
1417	 *
1418	 * @param array $extensions An array of support audio formats. Defaults are
1419	 *                          'mp3', 'ogg', 'wma', 'm4a', 'wav'.
1420	 */
1421	return apply_filters( 'wp_audio_extensions', array( 'mp3', 'ogg', 'wma', 'm4a', 'wav' ) );
1422}
1423
1424/**
1425 * Return useful keys to use to lookup data from an attachment's stored metadata.
1426 *
1427 * @since 3.9.0
1428 *
1429 * @param WP_Post $attachment The current attachment, provided for context.
1430 * @param string  $context    The context. Accepts 'edit', 'display'. Default 'display'.
1431 * @return array Key/value pairs of field keys to labels.
1432 */
1433function wp_get_attachment_id3_keys( $attachment, $context = 'display' ) {
1434	$fields = array(
1435		'artist' => __( 'Artist' ),
1436		'album' => __( 'Album' ),
1437	);
1438
1439	if ( 'display' === $context ) {
1440		$fields['genre']            = __( 'Genre' );
1441		$fields['year']             = __( 'Year' );
1442		$fields['length_formatted'] = _x( 'Length', 'video or audio' );
1443	}
1444
1445	/**
1446	 * Filter the editable list of keys to look up data from an attachment's metadata.
1447	 *
1448	 * @since 3.9.0
1449	 *
1450	 * @param array   $fields     Key/value pairs of field keys to labels.
1451	 * @param WP_Post $attachment Attachment object.
1452	 * @param string  $context    The context. Accepts 'edit', 'display'. Default 'display'.
1453	 */
1454	return apply_filters( 'wp_get_attachment_id3_keys', $fields, $attachment, $context );
1455}
1456/**
1457 * The Audio shortcode.
1458 *
1459 * This implements the functionality of the Audio Shortcode for displaying
1460 * WordPress mp3s in a post.
1461 *
1462 * @since 3.6.0
1463 *
1464 * @param array $attr {
1465 *     Attributes of the audio shortcode.
1466 *
1467 *     @type string $src      URL to the source of the audio file. Default empty.
1468 *     @type string $loop     The 'loop' attribute for the `<audio>` element. Default empty.
1469 *     @type string $autoplay The 'autoplay' attribute for the `<audio>` element. Default empty.
1470 *     @type string $preload  The 'preload' attribute for the `<audio>` element. Default empty.
1471 *     @type string $class    The 'class' attribute for the `<audio>` element. Default 'wp-audio-shortcode'.
1472 *     @type string $id       The 'id' attribute for the `<audio>` element. Default 'audio-{$post_id}-{$instances}'.
1473 *     @type string $style    The 'style' attribute for the `<audio>` element. Default 'width: 100%'.
1474 * }
1475 * @param string $content Optional. Shortcode content.
1476 * @return string HTML content to display audio.
1477 */
1478function wp_audio_shortcode( $attr, $content = '' ) {
1479	$post_id = get_post() ? get_the_ID() : 0;
1480
1481	static $instances = 0;
1482	$instances++;
1483
1484	/**
1485	 * Filter the default audio shortcode output.
1486	 *
1487	 * If the filtered output isn't empty, it will be used instead of generating the default audio template.
1488	 *
1489	 * @since 3.6.0
1490	 *
1491	 * @param string $html      Empty variable to be replaced with shortcode markup.
1492	 * @param array  $attr      Attributes of the shortcode. @see wp_audio_shortcode()
1493	 * @param string $content   Shortcode content.
1494	 * @param int    $instances Unique numeric ID of this audio shortcode instance.
1495	 */
1496	$override = apply_filters( 'wp_audio_shortcode_override', '', $attr, $content, $instances );
1497	if ( '' !== $override ) {
1498		return $override;
1499	}
1500
1501	$audio = null;
1502
1503	$default_types = wp_get_audio_extensions();
1504	$defaults_atts = array(
1505		'src'      => '',
1506		'loop'     => '',
1507		'autoplay' => '',
1508		'preload'  => 'none'
1509	);
1510	foreach ( $default_types as $type ) {
1511		$defaults_atts[$type] = '';
1512	}
1513
1514	$atts = shortcode_atts( $defaults_atts, $attr, 'audio' );
1515
1516	$primary = false;
1517	if ( ! empty( $atts['src'] ) ) {
1518		$type = wp_check_filetype( $atts['src'], wp_get_mime_types() );
1519		if ( ! in_array( strtolower( $type['ext'] ), $default_types ) ) {
1520			return sprintf( '<a class="wp-embedded-audio" href="%s">%s</a>', esc_url( $atts['src'] ), esc_html( $atts['src'] ) );
1521		}
1522		$primary = true;
1523		array_unshift( $default_types, 'src' );
1524	} else {
1525		foreach ( $default_types as $ext ) {
1526			if ( ! empty( $atts[ $ext ] ) ) {
1527				$type = wp_check_filetype( $atts[ $ext ], wp_get_mime_types() );
1528				if ( strtolower( $type['ext'] ) === $ext ) {
1529					$primary = true;
1530				}
1531			}
1532		}
1533	}
1534
1535	if ( ! $primary ) {
1536		$audios = get_attached_media( 'audio', $post_id );
1537		if ( empty( $audios ) ) {
1538			return;
1539		}
1540
1541		$audio = reset( $audios );
1542		$atts['src'] = wp_get_attachment_url( $audio->ID );
1543		if ( empty( $atts['src'] ) ) {
1544			return;
1545		}
1546
1547		array_unshift( $default_types, 'src' );
1548	}
1549
1550	/**
1551	 * Filter the media library used for the audio shortcode.
1552	 *
1553	 * @since 3.6.0
1554	 *
1555	 * @param string $library Media library used for the audio shortcode.
1556	 */
1557	$library = apply_filters( 'wp_audio_shortcode_library', 'mediaelement' );
1558	if ( 'mediaelement' === $library && did_action( 'init' ) ) {
1559		wp_enqueue_style( 'wp-mediaelement' );
1560		wp_enqueue_script( 'wp-mediaelement' );
1561	}
1562
1563	/**
1564	 * Filter the class attribute for the audio shortcode output container.
1565	 *
1566	 * @since 3.6.0
1567	 *
1568	 * @param string $class CSS class or list of space-separated classes.
1569	 */
1570	$html_atts = array(
1571		'class'    => apply_filters( 'wp_audio_shortcode_class', 'wp-audio-shortcode' ),
1572		'id'       => sprintf( 'audio-%d-%d', $post_id, $instances ),
1573		'loop'     => $atts['loop'],
1574		'autoplay' => $atts['autoplay'],
1575		'preload'  => $atts['preload'],
1576		'style'    => 'width: 100%; visibility: hidden;',
1577	);
1578
1579	// These ones should just be omitted altogether if they are blank
1580	foreach ( array( 'loop', 'autoplay', 'preload' ) as $a ) {
1581		if ( empty( $html_atts[$a] ) ) {
1582			unset( $html_atts[$a] );
1583		}
1584	}
1585
1586	$attr_strings = array();
1587	foreach ( $html_atts as $k => $v ) {
1588		$attr_strings[] = $k . '="' . esc_attr( $v ) . '"';
1589	}
1590
1591	$html = '';
1592	if ( 'mediaelement' === $library && 1 === $instances ) {
1593		$html .= "<!--[if lt IE 9]><script>document.createElement('audio');</script><![endif]-->\n";
1594	}
1595	$html .= sprintf( '<audio %s controls="controls">', join( ' ', $attr_strings ) );
1596
1597	$fileurl = '';
1598	$source = '<source type="%s" src="%s" />';
1599	foreach ( $default_types as $fallback ) {
1600		if ( ! empty( $atts[ $fallback ] ) ) {
1601			if ( empty( $fileurl ) ) {
1602				$fileurl = $atts[ $fallback ];
1603			}
1604			$type = wp_check_filetype( $atts[ $fallback ], wp_get_mime_types() );
1605			$url = add_query_arg( '_', $instances, $atts[ $fallback ] );
1606			$html .= sprintf( $source, $type['type'], esc_url( $url ) );
1607		}
1608	}
1609
1610	if ( 'mediaelement' === $library ) {
1611		$html .= wp_mediaelement_fallback( $fileurl );
1612	}
1613	$html .= '</audio>';
1614
1615	/**
1616	 * Filter the audio shortcode output.
1617	 *
1618	 * @since 3.6.0
1619	 *
1620	 * @param string $html    Audio shortcode HTML output.
1621	 * @param array  $atts    Array of audio shortcode attributes.
1622	 * @param string $audio   Audio file.
1623	 * @param int    $post_id Post ID.
1624	 * @param string $library Media library used for the audio shortcode.
1625	 */
1626	return apply_filters( 'wp_audio_shortcode', $html, $atts, $audio, $post_id, $library );
1627}
1628add_shortcode( 'audio', 'wp_audio_shortcode' );
1629
1630/**
1631 * Return a filtered list of WP-supported video formats
1632 *
1633 * @since 3.6.0
1634 * @return array
1635 */
1636function wp_get_video_extensions() {
1637	/**
1638	 * Filter the list of supported video formats.
1639	 *
1640	 * @since 3.6.0
1641	 *
1642	 * @param array $extensions An array of support video formats. Defaults are
1643	 *                          'mp4', 'm4v', 'webm', 'ogv', 'wmv', 'flv'.
1644	 */
1645	return apply_filters( 'wp_video_extensions', array( 'mp4', 'm4v', 'webm', 'ogv', 'wmv', 'flv' ) );
1646}
1647
1648/**
1649 * The Video shortcode.
1650 *
1651 * This implements the functionality of the Video Shortcode for displaying
1652 * WordPress mp4s in a post.
1653 *
1654 * @since 3.6.0
1655 *
1656 * @param array $attr {
1657 *     Attributes of the shortcode.
1658 *
1659 *     @type string $src      URL to the source of the video file. Default empty.
1660 *     @type int    $height   Height of the video embed in pixels. Default 360.
1661 *     @type int    $width    Width of the video embed in pixels. Default $content_width or 640.
1662 *     @type string $poster   The 'poster' attribute for the `<video>` element. Default empty.
1663 *     @type string $loop     The 'loop' attribute for the `<video>` element. Default empty.
1664 *     @type string $autoplay The 'autoplay' attribute for the `<video>` element. Default empty.
1665 *     @type string $preload  The 'preload' attribute for the `<video>` element.
1666 *                            Default 'metadata'.
1667 *     @type string $class    The 'class' attribute for the `<video>` element.
1668 *                            Default 'wp-video-shortcode'.
1669 *     @type string $id       The 'id' attribute for the `<video>` element.
1670 *                            Default 'video-{$post_id}-{$instances}'.
1671 * }
1672 * @param string $content Optional. Shortcode content.
1673 * @return string HTML content to display video.
1674 */
1675function wp_video_shortcode( $attr, $content = '' ) {
1676	global $content_width;
1677	$post_id = get_post() ? get_the_ID() : 0;
1678
1679	static $instances = 0;
1680	$instances++;
1681
1682	/**
1683	 * Filter the default video shortcode output.
1684	 *
1685	 * If the filtered output isn't empty, it will be used instead of generating
1686	 * the default video template.
1687	 *
1688	 * @since 3.6.0
1689	 *
1690	 * @see wp_video_shortcode()
1691	 *
1692	 * @param string $html      Empty variable to be replaced with shortcode markup.
1693	 * @param array  $attr      Attributes of the video shortcode.
1694	 * @param string $content   Video shortcode content.
1695	 * @param int    $instances Unique numeric ID of this video shortcode instance.
1696	 */
1697	$override = apply_filters( 'wp_video_shortcode_override', '', $attr, $content, $instances );
1698	if ( '' !== $override ) {
1699		return $override;
1700	}
1701
1702	$video = null;
1703
1704	$default_types = wp_get_video_extensions();
1705	$defaults_atts = array(
1706		'src'      => '',
1707		'poster'   => '',
1708		'loop'     => '',
1709		'autoplay' => '',
1710		'preload'  => 'metadata',
1711		'width'    => 640,
1712		'height'   => 360,
1713	);
1714
1715	foreach ( $default_types as $type ) {
1716		$defaults_atts[$type] = '';
1717	}
1718
1719	$atts = shortcode_atts( $defaults_atts, $attr, 'video' );
1720
1721	if ( is_admin() ) {
1722		// shrink the video so it isn't huge in the admin
1723		if ( $atts['width'] > $defaults_atts['width'] ) {
1724			$atts['height'] = round( ( $atts['height'] * $defaults_atts['width'] ) / $atts['width'] );
1725			$atts['width'] = $defaults_atts['width'];
1726		}
1727	} else {
1728		// if the video is bigger than the theme
1729		if ( ! empty( $content_width ) && $atts['width'] > $content_width ) {
1730			$atts['height'] = round( ( $atts['height'] * $content_width ) / $atts['width'] );
1731			$atts['width'] = $content_width;
1732		}
1733	}
1734
1735	$yt_pattern = '#^https?://(:?www\.)?(:?youtube\.com/watch|youtu\.be/)#';
1736
1737	$primary = false;
1738	if ( ! empty( $atts['src'] ) ) {
1739		if ( ! preg_match( $yt_pattern, $atts['src'] ) ) {
1740			$type = wp_check_filetype( $atts['src'], wp_get_mime_types() );
1741			if ( ! in_array( strtolower( $type['ext'] ), $default_types ) ) {
1742				return sprintf( '<a class="wp-embedded-video" href="%s">%s</a>', esc_url( $atts['src'] ), esc_html( $atts['src'] ) );
1743			}
1744		}
1745		$primary = true;
1746		array_unshift( $default_types, 'src' );
1747	} else {
1748		foreach ( $default_types as $ext ) {
1749			if ( ! empty( $atts[ $ext ] ) ) {
1750				$type = wp_check_filetype( $atts[ $ext ], wp_get_mime_types() );
1751				if ( strtolower( $type['ext'] ) === $ext ) {
1752					$primary = true;
1753				}
1754			}
1755		}
1756	}
1757
1758	if ( ! $primary ) {
1759		$videos = get_attached_media( 'video', $post_id );
1760		if ( empty( $videos ) ) {
1761			return;
1762		}
1763
1764		$video = reset( $videos );
1765		$atts['src'] = wp_get_attachment_url( $video->ID );
1766		if ( empty( $atts['src'] ) ) {
1767			return;
1768		}
1769
1770		array_unshift( $default_types, 'src' );
1771	}
1772
1773	/**
1774	 * Filter the media library used for the video shortcode.
1775	 *
1776	 * @since 3.6.0
1777	 *
1778	 * @param string $library Media library used for the video shortcode.
1779	 */
1780	$library = apply_filters( 'wp_video_shortcode_library', 'mediaelement' );
1781	if ( 'mediaelement' === $library && did_action( 'init' ) ) {
1782		wp_enqueue_style( 'wp-mediaelement' );
1783		wp_enqueue_script( 'wp-mediaelement' );
1784	}
1785
1786	/**
1787	 * Filter the class attribute for the video shortcode output container.
1788	 *
1789	 * @since 3.6.0
1790	 *
1791	 * @param string $class CSS class or list of space-separated classes.
1792	 */
1793	$html_atts = array(
1794		'class'    => apply_filters( 'wp_video_shortcode_class', 'wp-video-shortcode' ),
1795		'id'       => sprintf( 'video-%d-%d', $post_id, $instances ),
1796		'width'    => absint( $atts['width'] ),
1797		'height'   => absint( $atts['height'] ),
1798		'poster'   => esc_url( $atts['poster'] ),
1799		'loop'     => $atts['loop'],
1800		'autoplay' => $atts['autoplay'],
1801		'preload'  => $atts['preload'],
1802	);
1803
1804	// These ones should just be omitted altogether if they are blank
1805	foreach ( array( 'poster', 'loop', 'autoplay', 'preload' ) as $a ) {
1806		if ( empty( $html_atts[$a] ) ) {
1807			unset( $html_atts[$a] );
1808		}
1809	}
1810
1811	$attr_strings = array();
1812	foreach ( $html_atts as $k => $v ) {
1813		$attr_strings[] = $k . '="' . esc_attr( $v ) . '"';
1814	}
1815
1816	$html = '';
1817	if ( 'mediaelement' === $library && 1 === $instances ) {
1818		$html .= "<!--[if lt IE 9]><script>document.createElement('video');</script><![endif]-->\n";
1819	}
1820	$html .= sprintf( '<video %s controls="controls">', join( ' ', $attr_strings ) );
1821
1822	$fileurl = '';
1823	$source = '<source type="%s" src="%s" />';
1824	foreach ( $default_types as $fallback ) {
1825		if ( ! empty( $atts[ $fallback ] ) ) {
1826			if ( empty( $fileurl ) ) {
1827				$fileurl = $atts[ $fallback ];
1828			}
1829			if ( 'src' === $fallback && preg_match( $yt_pattern, $atts['src'] ) ) {
1830				$type = array( 'type' => 'video/youtube' );
1831			} else {
1832				$type = wp_check_filetype( $atts[ $fallback ], wp_get_mime_types() );
1833			}
1834			$url = add_query_arg( '_', $instances, $atts[ $fallback ] );
1835			$html .= sprintf( $source, $type['type'], esc_url( $url ) );
1836		}
1837	}
1838
1839	if ( ! empty( $content ) ) {
1840		if ( false !== strpos( $content, "\n" ) ) {
1841			$content = str_replace( array( "\r\n", "\n", "\t" ), '', $content );
1842		}
1843		$html .= trim( $content );
1844	}
1845
1846	if ( 'mediaelement' === $library ) {
1847		$html .= wp_mediaelement_fallback( $fileurl );
1848	}
1849	$html .= '</video>';
1850
1851	$output = sprintf( '<div style="width: %dpx; max-width: 100%%;" class="wp-video">%s</div>', $atts['width'], $html );
1852
1853	/**
1854	 * Filter the output of the video shortcode.
1855	 *
1856	 * @since 3.6.0
1857	 *
1858	 * @param string $output  Video shortcode HTML output.
1859	 * @param array  $atts    Array of video shortcode attributes.
1860	 * @param string $video   Video file.
1861	 * @param int    $post_id Post ID.
1862	 * @param string $library Media library used for the video shortcode.
1863	 */
1864	return apply_filters( 'wp_video_shortcode', $output, $atts, $video, $post_id, $library );
1865}
1866add_shortcode( 'video', 'wp_video_shortcode' );
1867
1868/**
1869 * Display previous image link that has the same post parent.
1870 *
1871 * @since 2.5.0
1872 * @param string $size Optional, default is 'thumbnail'. Size of image, either array or string. 0 or 'none' will default to post_title or $text;
1873 * @param string $text Optional, default is false. If included, link will reflect $text variable.
1874 * @return string HTML content.
1875 */
1876function previous_image_link($size = 'thumbnail', $text = false) {
1877	adjacent_image_link(true, $size, $text);
1878}
1879
1880/**
1881 * Display next image link that has the same post parent.
1882 *
1883 * @since 2.5.0
1884 * @param string $size Optional, default is 'thumbnail'. Size of image, either array or string. 0 or 'none' will default to post_title or $text;
1885 * @param string $text Optional, default is false. If included, link will reflect $text variable.
1886 * @return string HTML content.
1887 */
1888function next_image_link($size = 'thumbnail', $text = false) {
1889	adjacent_image_link(false, $size, $text);
1890}
1891
1892/**
1893 * Display next or previous image link that has the same post parent.
1894 *
1895 * Retrieves the current attachment object from the $post global.
1896 *
1897 * @since 2.5.0
1898 *
1899 * @param bool $prev Optional. Default is true to display previous link, false for next.
1900 */
1901function adjacent_image_link($prev = true, $size = 'thumbnail', $text = false) {
1902	$post = get_post();
1903	$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' ) ) );
1904
1905	foreach ( $attachments as $k => $attachment ) {
1906		if ( $attachment->ID == $post->ID ) {
1907			break;
1908		}
1909	}
1910
1911	$output = '';
1912	$attachment_id = 0;
1913
1914	if ( $attachments ) {
1915		$k = $prev ? $k - 1 : $k + 1;
1916
1917		if ( isset( $attachments[ $k ] ) ) {
1918			$attachment_id = $attachments[ $k ]->ID;
1919			$output = wp_get_attachment_link( $attachment_id, $size, true, false, $text );
1920		}
1921	}
1922
1923	$adjacent = $prev ? 'previous' : 'next';
1924
1925	/**
1926	 * Filter the adjacent image link.
1927	 *
1928	 * The dynamic portion of the hook name, $adjacent, refers to the type of adjacency,
1929	 * either 'next', or 'previous'.
1930	 *
1931	 * @since 3.5.0
1932	 *
1933	 * @param string $output        Adjacent image HTML markup.
1934	 * @param int    $attachment_id Attachment ID
1935	 * @param string $size          Image size.
1936	 * @param string $text          Link text.
1937	 */
1938	echo apply_filters( "{$adjacent}_image_link", $output, $attachment_id, $size, $text );
1939}
1940
1941/**
1942 * Retrieve taxonomies attached to the attachment.
1943 *
1944 * @since 2.5.0
1945 *
1946 * @param int|array|object $attachment Attachment ID, Attachment data array, or Attachment data object.
1947 * @return array Empty array on failure. List of taxonomies on success.
1948 */
1949function get_attachment_taxonomies($attachment) {
1950	if ( is_int( $attachment ) )
1951		$attachment = get_post($attachment);
1952	else if ( is_array($attachment) )
1953		$attachment = (object) $attachment;
1954
1955	if ( ! is_object($attachment) )
1956		return array();
1957
1958	$filename = basename($attachment->guid);
1959
1960	$objects = array('attachment');
1961
1962	if ( false !== strpos($filename, '.') )
1963		$objects[] = 'attachment:' . substr($filename, strrpos($filename, '.') + 1);
1964	if ( !empty($attachment->post_mime_type) ) {
1965		$objects[] = 'attachment:' . $attachment->post_mime_type;
1966		if ( false !== strpos($attachment->post_mime_type, '/') )
1967			foreach ( explode('/', $attachment->post_mime_type) as $token )
1968				if ( !empty($token) )
1969					$objects[] = "attachment:$token";
1970	}
1971
1972	$taxonomies = array();
1973	foreach ( $objects as $object )
1974		if ( $taxes = get_object_taxonomies($object) )
1975			$taxonomies = array_merge($taxonomies, $taxes);
1976
1977	return array_unique($taxonomies);
1978}
1979
1980/**
1981 * Return all of the taxonomy names that are registered for attachments.
1982 *
1983 * Handles mime-type-specific taxonomies such as attachment:image and attachment:video.
1984 *
1985 * @since 3.5.0
1986 * @see get_attachment_taxonomies()
1987 * @uses get_taxonomies()
1988 *
1989 * @param string $output The type of output to return, either taxonomy 'names' or 'objects'. 'names' is the default.
1990 * @return array The names of all taxonomy of $object_type.
1991 */
1992function get_taxonomies_for_attachments( $output = 'names' ) {
1993	$taxonomies = array();
1994	foreach ( get_taxonomies( array(), 'objects' ) as $taxonomy ) {
1995		foreach ( $taxonomy->object_type as $object_type ) {
1996			if ( 'attachment' == $object_type || 0 === strpos( $object_type, 'attachment:' ) ) {
1997				if ( 'names' == $output )
1998					$taxonomies[] = $taxonomy->name;
1999				else
2000					$taxonomies[ $taxonomy->name ] = $taxonomy;
2001				break;
2002			}
2003		}
2004	}
2005
2006	return $taxonomies;
2007}
2008
2009/**
2010 * Create new GD image resource with transparency support
2011 * @TODO: Deprecate if possible.
2012 *
2013 * @since 2.9.0
2014 *
2015 * @param int $width Image width
2016 * @param int $height Image height
2017 * @return image resource
2018 */
2019function wp_imagecreatetruecolor($width, $height) {
2020	$img = imagecreatetruecolor($width, $height);
2021	if ( is_resource($img) && function_exists('imagealphablending') && function_exists('imagesavealpha') ) {
2022		imagealphablending($img, false);
2023		imagesavealpha($img, true);
2024	}
2025	return $img;
2026}
2027
2028/**
2029 * Register an embed handler. This function should probably only be used for sites that do not support oEmbed.
2030 *
2031 * @since 2.9.0
2032 * @see WP_Embed::register_handler()
2033 */
2034function wp_embed_register_handler( $id, $regex, $callback, $priority = 10 ) {
2035	global $wp_embed;
2036	$wp_embed->register_handler( $id, $regex, $callback, $priority );
2037}
2038
2039/**
2040 * Unregister a previously registered embed handler.
2041 *
2042 * @since 2.9.0
2043 * @see WP_Embed::unregister_handler()
2044 */
2045function wp_embed_unregister_handler( $id, $priority = 10 ) {
2046	global $wp_embed;
2047	$wp_embed->unregister_handler( $id, $priority );
2048}
2049
2050/**
2051 * Create default array of embed parameters.
2052 *
2053 * The width defaults to the content width as specified by the theme. If the
2054 * theme does not specify a content width, then 500px is used.
2055 *
2056 * The default height is 1.5 times the width, or 1000px, whichever is smaller.
2057 *
2058 * The 'embed_defaults' filter can be used to adjust either of these values.
2059 *
2060 * @since 2.9.0
2061 *
2062 * @return array Default embed parameters.
2063 */
2064function wp_embed_defaults() {
2065	if ( ! empty( $GLOBALS['content_width'] ) )
2066		$width = (int) $GLOBALS['content_width'];
2067
2068	if ( empty( $width ) )
2069		$width = 500;
2070
2071	$height = min( ceil( $width * 1.5 ), 1000 );
2072
2073	/**
2074	 * Filter the default array of embed dimensions.
2075	 *
2076	 * @since 2.9.0
2077	 *
2078	 * @param int $width  Width of the embed in pixels.
2079	 * @param int $height Height of the embed in pixels.
2080	 */
2081	return apply_filters( 'embed_defaults', compact( 'width', 'height' ) );
2082}
2083
2084/**
2085 * Based on a supplied width/height example, return the biggest possible dimensions based on the max width/height.
2086 *
2087 * @since 2.9.0
2088 * @uses wp_constrain_dimensions() This function passes the widths and the heights.
2089 *
2090 * @param int $example_width The width of an example embed.
2091 * @param int $example_height The height of an example embed.
2092 * @param int $max_width The maximum allowed width.
2093 * @param int $max_height The maximum allowed height.
2094 * @return array The maximum possible width and height based on the example ratio.
2095 */
2096function wp_expand_dimensions( $example_width, $example_height, $max_width, $max_height ) {
2097	$example_width  = (int) $example_width;
2098	$example_height = (int) $example_height;
2099	$max_width      = (int) $max_width;
2100	$max_height     = (int) $max_height;
2101
2102	return wp_constrain_dimensions( $example_width * 1000000, $example_height * 1000000, $max_width, $max_height );
2103}
2104
2105/**
2106 * Attempts to fetch the embed HTML for a provided URL using oEmbed.
2107 *
2108 * @since 2.9.0
2109 * @see WP_oEmbed
2110 *
2111 * @uses _wp_oembed_get_object()
2112 * @uses WP_oEmbed::get_html()
2113 *
2114 * @param string $url The URL that should be embedded.
2115 * @param array $args Additional arguments and parameters.
2116 * @return bool|string False on failure or the embed HTML on success.
2117 */
2118function wp_oembed_get( $url, $args = '' ) {
2119	require_once( ABSPATH . WPINC . '/class-oembed.php' );
2120	$oembed = _wp_oembed_get_object();
2121	return $oembed->get_html( $url, $args );
2122}
2123
2124/**
2125 * Adds a URL format and oEmbed provider URL pair.
2126 *
2127 * @since 2.9.0
2128 * @see WP_oEmbed
2129 *
2130 * @uses _wp_oembed_get_object()
2131 *
2132 * @param string $format The format of URL that this provider can handle. You can use asterisks as wildcards.
2133 * @param string $provider The URL to the oEmbed provider.
2134 * @param boolean $regex Whether the $format parameter is in a regex format.
2135 */
2136function wp_oembed_add_provider( $format, $provider, $regex = false ) {
2137	require_once( ABSPATH . WPINC . '/class-oembed.php' );
2138
2139	if ( did_action( 'plugins_loaded' ) ) {
2140		$oembed = _wp_oembed_get_object();
2141		$oembed->providers[$format] = array( $provider, $regex );
2142	} else {
2143		WP_oEmbed::_add_provider_early( $format, $provider, $regex );
2144	}
2145}
2146
2147/**
2148 * Removes an oEmbed provider.
2149 *
2150 * @since 3.5.0
2151 * @see WP_oEmbed
2152 *
2153 * @uses _wp_oembed_get_object()
2154 *
2155 * @param string $format The URL format for the oEmbed provider to remove.
2156 */
2157function wp_oembed_remove_provider( $format ) {
2158	require_once( ABSPATH . WPINC . '/class-oembed.php' );
2159
2160	if ( did_action( 'plugins_loaded' ) ) {
2161		$oembed = _wp_oembed_get_object();
2162
2163		if ( isset( $oembed->providers[ $format ] ) ) {
2164			unset( $oembed->providers[ $format ] );
2165			return true;
2166		}
2167	} else {
2168		WP_oEmbed::_remove_provider_early( $format );
2169	}
2170
2171	return false;
2172}
2173
2174/**
2175 * Determines if default embed handlers should be loaded.
2176 *
2177 * Checks to make sure that the embeds library hasn't already been loaded. If
2178 * it hasn't, then it will load the embeds library.
2179 *
2180 * @since 2.9.0
2181 */
2182function wp_maybe_load_embeds() {
2183	/**
2184	 * Filter whether to load the default embed handlers.
2185	 *
2186	 * Returning a falsey value will prevent loading the default embed handlers.
2187	 *
2188	 * @since 2.9.0
2189	 *
2190	 * @param bool $maybe_load_embeds Whether to load the embeds library. Default true.
2191	 */
2192	if ( ! apply_filters( 'load_default_embeds', true ) ) {
2193		return;
2194	}
2195
2196	wp_embed_register_handler( 'youtube_embed_url', '#https?://(www.)?youtube\.com/embed/([^/]+)#i', 'wp_embed_handler_youtube' );
2197
2198	wp_embed_register_handler( 'googlevideo', '#http://video\.google\.([A-Za-z.]{2,5})/videoplay\?docid=([\d-]+)(.*?)#i', 'wp_embed_handler_googlevideo' );
2199
2200	/**
2201	 * Filter the audio embed handler callback.
2202	 *
2203	 * @since 3.6.0
2204	 *
2205	 * @param callback $handler Audio embed handler callback function.
2206	 */
2207	wp_embed_register_handler( 'audio', '#^https?://.+?\.(' . join( '|', wp_get_audio_extensions() ) . ')$#i', apply_filters( 'wp_audio_embed_handler', 'wp_embed_handler_audio' ), 9999 );
2208
2209	/**
2210	 * Filter the video embed handler callback.
2211	 *
2212	 * @since 3.6.0
2213	 *
2214	 * @param callback $handler Video embed handler callback function.
2215	 */
2216	wp_embed_register_handler( 'video', '#^https?://.+?\.(' . join( '|', wp_get_video_extensions() ) . ')$#i', apply_filters( 'wp_video_embed_handler', 'wp_embed_handler_video' ), 9999 );
2217}
2218
2219/**
2220 * The Google Video embed handler callback. Google Video does not support oEmbed.
2221 *
2222 * @see WP_Embed::register_handler()
2223 * @see WP_Embed::shortcode()
2224 *
2225 * @param array $matches The regex matches from the provided regex when calling {@link wp_embed_register_handler()}.
2226 * @param array $attr Embed attributes.
2227 * @param string $url The original URL that was matched by the regex.
2228 * @param array $rawattr The original unmodified attributes.
2229 * @return string The embed HTML.
2230 */
2231function wp_embed_handler_googlevideo( $matches, $attr, $url, $rawattr ) {
2232	// If the user supplied a fixed width AND height, use it
2233	if ( !empty($rawattr['width']) && !empty($rawattr['height']) ) {
2234		$width  = (int) $rawattr['width'];
2235		$height = (int) $rawattr['height'];
2236	} else {
2237		list( $width, $height ) = wp_expand_dimensions( 425, 344, $attr['width'], $attr['height'] );
2238	}
2239
2240	/**
2241	 * Filter the Google Video embed output.
2242	 *
2243	 * @since 2.9.0
2244	 *
2245	 * @param string $html    Google Video HTML embed markup.
2246	 * @param array  $matches The regex matches from the provided regex.
2247	 * @param array  $attr    An array of embed attributes.
2248	 * @param string $url     The original URL that was matched by the regex.
2249	 * @param array  $rawattr The original unmodified attributes.
2250	 */
2251	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 );
2252}
2253
2254/**
2255 * The YouTube embed handler callback. Catches URLs that can be parsed but aren't supported by oEmbed.
2256 *
2257 * @since 4.0.0
2258 *
2259 * @param array $matches The regex matches from the provided regex when calling {@link wp_embed_register_handler()}.
2260 * @param array $attr Embed attributes.
2261 * @param string $url The original URL that was matched by the regex.
2262 * @param array $rawattr The original unmodified attributes.
2263 * @return string The embed HTML.
2264 */
2265function wp_embed_handler_youtube( $matches, $attr, $url, $rawattr ) {
2266	global $wp_embed;
2267	$embed = $wp_embed->autoembed( "https://youtube.com/watch?v={$matches[2]}" );
2268	/**
2269	 * Filter the YoutTube embed output.
2270	 *
2271	 * @since 4.0.0
2272	 *
2273	 * @param string $embed   YouTube embed output.
2274	 * @param array  $attr    An array of embed attributes.
2275	 * @param string $url     The original URL that was matched by the regex.
2276	 * @param array  $rawattr The original unmodified attributes.
2277	 */
2278	return apply_filters( 'wp_embed_handler_youtube', $embed, $attr, $url, $rawattr );
2279}
2280
2281/**
2282 * Audio embed handler callback.
2283 *
2284 * @since 3.6.0
2285 *
2286 * @param array $matches The regex matches from the provided regex when calling {@link wp_embed_register_handler()}.
2287 * @param array $attr Embed attributes.
2288 * @param string $url The original URL that was matched by the regex.
2289 * @param array $rawattr The original unmodified attributes.
2290 * @return string The embed HTML.
2291 */
2292function wp_embed_handler_audio( $matches, $attr, $url, $rawattr ) {
2293	$audio = sprintf( '[audio src="%s" /]', esc_url( $url ) );
2294
2295	/**
2296	 * Filter the audio embed output.
2297	 *
2298	 * @since 3.6.0
2299	 *
2300	 * @param string $audio   Audio embed output.
2301	 * @param array  $attr    An array of embed attributes.
2302	 * @param string $url     The original URL that was matched by the regex.
2303	 * @param array  $rawattr The original unmodified attributes.
2304	 */
2305	return apply_filters( 'wp_embed_handler_audio', $audio, $attr, $url, $rawattr );
2306}
2307
2308/**
2309 * Video embed handler callback.
2310 *
2311 * @since 3.6.0
2312 *
2313 * @param array $matches The regex matches from the provided regex when calling {@link wp_embed_register_handler()}.
2314 * @param array $attr Embed attributes.
2315 * @param string $url The original URL that was matched by the regex.
2316 * @param array $rawattr The original unmodified attributes.
2317 * @return string The embed HTML.
2318 */
2319function wp_embed_handler_video( $matches, $attr, $url, $rawattr ) {
2320	$dimensions = '';
2321	if ( ! empty( $rawattr['width'] ) && ! empty( $rawattr['height'] ) ) {
2322		$dimensions .= sprintf( 'width="%d" ', (int) $rawattr['width'] );
2323		$dimensions .= sprintf( 'height="%d" ', (int) $rawattr['height'] );
2324	}
2325	$video = sprintf( '[video %s src="%s" /]', $dimensions, esc_url( $url ) );
2326
2327	/**
2328	 * Filter the video embed output.
2329	 *
2330	 * @since 3.6.0
2331	 *
2332	 * @param string $video   Video embed output.
2333	 * @param array  $attr    An array of embed attributes.
2334	 * @param string $url     The original URL that was matched by the regex.
2335	 * @param array  $rawattr The original unmodified attributes.
2336	 */
2337	return apply_filters( 'wp_embed_handler_video', $video, $attr, $url, $rawattr );
2338}
2339
2340/**
2341 * Converts a shorthand byte value to an integer byte value.
2342 *
2343 * @since 2.3.0
2344 *
2345 * @param string $size A shorthand byte value.
2346 * @return int An integer byte value.
2347 */
2348function wp_convert_hr_to_bytes( $size ) {
2349	$size  = strtolower( $size );
2350	$bytes = (int) $size;
2351	if ( strpos( $size, 'k' ) !== false )
2352		$bytes = intval( $size ) * 1024;
2353	elseif ( strpos( $size, 'm' ) !== false )
2354		$bytes = intval($size) * 1024 * 1024;
2355	elseif ( strpos( $size, 'g' ) !== false )
2356		$bytes = intval( $size ) * 1024 * 1024 * 1024;
2357	return $bytes;
2358}
2359
2360/**
2361 * Determine the maximum upload size allowed in php.ini.
2362 *
2363 * @since 2.5.0
2364 *
2365 * @return int Allowed upload size.
2366 */
2367function wp_max_upload_size() {
2368	$u_bytes = wp_convert_hr_to_bytes( ini_get( 'upload_max_filesize' ) );
2369	$p_bytes = wp_convert_hr_to_bytes( ini_get( 'post_max_size' ) );
2370
2371	/**
2372	 * Filter the maximum upload size allowed in php.ini.
2373	 *
2374	 * @since 2.5.0
2375	 *
2376	 * @param int $size    Max upload size limit in bytes.
2377	 * @param int $u_bytes Maximum upload filesize in bytes.
2378	 * @param int $p_bytes Maximum size of POST data in bytes.
2379	 */
2380	return apply_filters( 'upload_size_limit', min( $u_bytes, $p_bytes ), $u_bytes, $p_bytes );
2381}
2382
2383/**
2384 * Returns a WP_Image_Editor instance and loads file into it.
2385 *
2386 * @since 3.5.0
2387 * @access public
2388 *
2389 * @param string $path Path to file to load
2390 * @param array $args Additional data. Accepts { 'mime_type'=>string, 'methods'=>{string, string, ...} }
2391 * @return WP_Image_Editor|WP_Error
2392 */
2393function wp_get_image_editor( $path, $args = array() ) {
2394	$args['path'] = $path;
2395
2396	if ( ! isset( $args['mime_type'] ) ) {
2397		$file_info = wp_check_filetype( $args['path'] );
2398
2399		// If $file_info['type'] is false, then we let the editor attempt to
2400		// figure out the file type, rather than forcing a failure based on extension.
2401		if ( isset( $file_info ) && $file_info['type'] )
2402			$args['mime_type'] = $file_info['type'];
2403	}
2404
2405	$implementation = _wp_image_editor_choose( $args );
2406
2407	if ( $implementation ) {
2408		$editor = new $implementation( $path );
2409		$loaded = $editor->load();
2410
2411		if ( is_wp_error( $loaded ) )
2412			return $loaded;
2413
2414		return $editor;
2415	}
2416
2417	return new WP_Error( 'image_no_editor', __('No editor could be selected.') );
2418}
2419
2420/**
2421 * Tests whether there is an editor that supports a given mime type or methods.
2422 *
2423 * @since 3.5.0
2424 * @access public
2425 *
2426 * @param string|array $args Array of requirements. Accepts { 'mime_type'=>string, 'methods'=>{string, string, ...} }
2427 * @return boolean true if an eligible editor is found; false otherwise
2428 */
2429function wp_image_editor_supports( $args = array() ) {
2430	return (bool) _wp_image_editor_choose( $args );
2431}
2432
2433/**
2434 * Tests which editors are capable of supporting the request.
2435 *
2436 * @since 3.5.0
2437 * @access private
2438 *
2439 * @param array $args Additional data. Accepts { 'mime_type'=>string, 'methods'=>{string, string, ...} }
2440 * @return string|bool Class name for the first editor that claims to support the request. False if no editor claims to support the request.
2441 */
2442function _wp_image_editor_choose( $args = array() ) {
2443	require_once ABSPATH . WPINC . '/class-wp-image-editor.php';
2444	require_once ABSPATH . WPINC . '/class-wp-image-editor-gd.php';
2445	require_once ABSPATH . WPINC . '/class-wp-image-editor-imagick.php';
2446
2447	/**
2448	 * Filter the list of image editing library classes.
2449	 *
2450	 * @since 3.5.0
2451	 *
2452	 * @param array $image_editors List of available image editors. Defaults are
2453	 *                             'WP_Image_Editor_Imagick', 'WP_Image_Editor_GD'.
2454	 */
2455	$implementations = apply_filters( 'wp_image_editors', array( 'WP_Image_Editor_Imagick', 'WP_Image_Editor_GD' ) );
2456
2457	foreach ( $implementations as $implementation ) {
2458		if ( ! call_user_func( array( $implementation, 'test' ), $args ) )
2459			continue;
2460
2461		if ( isset( $args['mime_type'] ) &&
2462			! call_user_func(
2463				array( $implementation, 'supports_mime_type' ),
2464				$args['mime_type'] ) ) {
2465			continue;
2466		}
2467
2468		if ( isset( $args['methods'] ) &&
2469			 array_diff( $args['methods'], get_class_methods( $implementation ) ) ) {
2470			continue;
2471		}
2472
2473		return $implementation;
2474	}
2475
2476	return false;
2477}
2478
2479/**
2480 * Prints default plupload arguments.
2481 *
2482 * @since 3.4.0
2483 */
2484function wp_plupload_default_settings() {
2485	global $wp_scripts;
2486
2487	$data = $wp_scripts->get_data( 'wp-plupload', 'data' );
2488	if ( $data && false !== strpos( $data, '_wpPluploadSettings' ) )
2489		return;
2490
2491	$max_upload_size = wp_max_upload_size();
2492
2493	$defaults = array(
2494		'runtimes'            => 'html5,flash,silverlight,html4',
2495		'file_data_name'      => 'async-upload', // key passed to $_FILE.
2496		'url'                 => admin_url( 'async-upload.php', 'relative' ),
2497		'flash_swf_url'       => includes_url( 'js/plupload/plupload.flash.swf' ),
2498		'silverlight_xap_url' => includes_url( 'js/plupload/plupload.silverlight.xap' ),
2499		'filters' => array(
2500			'max_file_size'   => $max_upload_size . 'b',
2501		),
2502	);
2503
2504	/**
2505	 * Filter the Plupload default settings.
2506	 *
2507	 * @since 3.4.0
2508	 *
2509	 * @param array $defaults Default Plupload settings array.
2510	 */
2511	$defaults = apply_filters( 'plupload_default_settings', $defaults );
2512
2513	$params = array(
2514		'action' => 'upload-attachment',
2515	);
2516
2517	/**
2518	 * Filter the Plupload default parameters.
2519	 *
2520	 * @since 3.4.0
2521	 *
2522	 * @param array $params Default Plupload parameters array.
2523	 */
2524	$params = apply_filters( 'plupload_default_params', $params );
2525	$params['_wpnonce'] = wp_create_nonce( 'media-form' );
2526	$defaults['multipart_params'] = $params;
2527
2528	$settings = array(
2529		'defaults' => $defaults,
2530		'browser'  => array(
2531			'mobile'    => wp_is_mobile(),
2532			'supported' => _device_can_upload(),
2533		),
2534		'limitExceeded' => is_multisite() && ! is_upload_space_available()
2535	);
2536
2537	$script = 'var _wpPluploadSettings = ' . json_encode( $settings ) . ';';
2538
2539	if ( $data )
2540		$script = "$data\n$script";
2541
2542	$wp_scripts->add_data( 'wp-plupload', 'data', $script );
2543}
2544add_action( 'customize_controls_enqueue_scripts', 'wp_plupload_default_settings' );
2545
2546/**
2547 * Prepares an attachment post object for JS, where it is expected
2548 * to be JSON-encoded and fit into an Attachment model.
2549 *
2550 * @since 3.5.0
2551 *
2552 * @param mixed $attachment Attachment ID or object.
2553 * @return array Array of attachment details.
2554 */
2555function wp_prepare_attachment_for_js( $attachment ) {
2556	if ( ! $attachment = get_post( $attachment ) )
2557		return;
2558
2559	if ( 'attachment' != $attachment->post_type )
2560		return;
2561
2562	$meta = wp_get_attachment_metadata( $attachment->ID );
2563	if ( false !== strpos( $attachment->post_mime_type, '/' ) )
2564		list( $type, $subtype ) = explode( '/', $attachment->post_mime_type );
2565	else
2566		list( $type, $subtype ) = array( $attachment->post_mime_type, '' );
2567
2568	$attachment_url = wp_get_attachment_url( $attachment->ID );
2569
2570	$response = array(
2571		'id'          => $attachment->ID,
2572		'title'       => $attachment->post_title,
2573		'filename'    => wp_basename( $attachment->guid ),
2574		'url'         => $attachment_url,
2575		'link'        => get_attachment_link( $attachment->ID ),
2576		'alt'         => get_post_meta( $attachment->ID, '_wp_attachment_image_alt', true ),
2577		'author'      => $attachment->post_author,
2578		'description' => $attachment->post_content,
2579		'caption'     => $attachment->post_excerpt,
2580		'name'        => $attachment->post_name,
2581		'status'      => $attachment->post_status,
2582		'uploadedTo'  => $attachment->post_parent,
2583		'date'        => strtotime( $attachment->post_date_gmt ) * 1000,
2584		'modified'    => strtotime( $attachment->post_modified_gmt ) * 1000,
2585		'menuOrder'   => $attachment->menu_order,
2586		'mime'        => $attachment->post_mime_type,
2587		'type'        => $type,
2588		'subtype'     => $subtype,
2589		'icon'        => wp_mime_type_icon( $attachment->ID ),
2590		'dateFormatted' => mysql2date( get_option('date_format'), $attachment->post_date ),
2591		'nonces'      => array(
2592			'update' => false,
2593			'delete' => false,
2594			'edit'   => false
2595		),
2596		'editLink'   => false,
2597	);
2598
2599	$author = new WP_User( $attachment->post_author );
2600	$response['authorName'] = $author->display_name;
2601
2602	if ( $attachment->post_parent ) {
2603		$post_parent = get_post( $attachment->post_parent );
2604		$response['uploadedToLink'] = get_edit_post_link( $attachment->post_parent, 'raw' );
2605		$response['uploadedToTitle'] = $post_parent->post_title ? $post_parent->post_title : __( '(No title)' );
2606	}
2607
2608	$bytes = filesize( get_attached_file( $attachment->ID ) );
2609	$response['filesizeInBytes'] = $bytes;
2610	$response['filesizeHumanReadable'] = size_format( $bytes );
2611
2612	if ( current_user_can( 'edit_post', $attachment->ID ) ) {
2613		$response['nonces']['update'] = wp_create_nonce( 'update-post_' . $attachment->ID );
2614		$response['nonces']['edit'] = wp_create_nonce( 'image_editor-' . $attachment->ID );
2615		$response['editLink'] = get_edit_post_link( $attachment->ID, 'raw' );
2616	}
2617
2618	if ( current_user_can( 'delete_post', $attachment->ID ) )
2619		$response['nonces']['delete'] = wp_create_nonce( 'delete-post_' . $attachment->ID );
2620
2621	if ( $meta && 'image' === $type ) {
2622		$sizes = array();
2623
2624		/** This filter is documented in wp-admin/includes/media.php */
2625		$possible_sizes = apply_filters( 'image_size_names_choose', array(
2626			'thumbnail' => __('Thumbnail'),
2627			'medium'    => __('Medium'),
2628			'large'     => __('Large'),
2629			'full'      => __('Full Size'),
2630		) );
2631		unset( $possible_sizes['full'] );
2632
2633		// Loop through all potential sizes that may be chosen. Try to do this with some efficiency.
2634		// First: run the image_downsize filter. If it returns something, we can use its data.
2635		// If the filter does not return something, then image_downsize() is just an expensive
2636		// way to check the image metadata, which we do second.
2637		foreach ( $possible_sizes as $size => $label ) {
2638
2639			/** This filter is documented in wp-includes/media.php */
2640			if ( $downsize = apply_filters( 'image_downsize', false, $attachment->ID, $size ) ) {
2641				if ( ! $downsize[3] )
2642					continue;
2643				$sizes[ $size ] = array(
2644					'height'      => $downsize[2],
2645					'width'       => $downsize[1],
2646					'url'         => $downsize[0],
2647					'orientation' => $downsize[2] > $downsize[1] ? 'portrait' : 'landscape',
2648				);
2649			} elseif ( isset( $meta['sizes'][ $size ] ) ) {
2650				if ( ! isset( $base_url ) )
2651					$base_url = str_replace( wp_basename( $attachment_url ), '', $attachment_url );
2652
2653				// Nothing from the filter, so consult image metadata if we have it.
2654				$size_meta = $meta['sizes'][ $size ];
2655
2656				// We have the actual image size, but might need to further constrain it if content_width is narrower.
2657				// Thumbnail, medium, and full sizes are also checked against the site's height/width options.
2658				list( $width, $height ) = image_constrain_size_for_editor( $size_meta['width'], $size_meta['height'], $size, 'edit' );
2659
2660				$sizes[ $size ] = array(
2661					'height'      => $height,
2662					'width'       => $width,
2663					'url'         => $base_url . $size_meta['file'],
2664					'orientation' => $height > $width ? 'portrait' : 'landscape',
2665				);
2666			}
2667		}
2668
2669		$sizes['full'] = array( 'url' => $attachment_url );
2670
2671		if ( isset( $meta['height'], $meta['width'] ) ) {
2672			$sizes['full']['height'] = $meta['height'];
2673			$sizes['full']['width'] = $meta['width'];
2674			$sizes['full']['orientation'] = $meta['height'] > $meta['width'] ? 'portrait' : 'landscape';
2675		}
2676
2677		$response = array_merge( $response, array( 'sizes' => $sizes ), $sizes['full'] );
2678	} elseif ( $meta && 'video' === $type ) {
2679		if ( isset( $meta['width'] ) )
2680			$response['width'] = (int) $meta['width'];
2681		if ( isset( $meta['height'] ) )
2682			$response['height'] = (int) $meta['height'];
2683	}
2684
2685	if ( $meta && ( 'audio' === $type || 'video' === $type ) ) {
2686		if ( isset( $meta['length_formatted'] ) )
2687			$response['fileLength'] = $meta['length_formatted'];
2688
2689		$response['meta'] = array();
2690		foreach ( wp_get_attachment_id3_keys( $attachment ) as $key => $label ) {
2691			if ( ! empty( $meta[ $key ] ) ) {
2692				$response['meta'][ $key ] = $meta[ $key ];
2693			}
2694		}
2695
2696		$id = get_post_thumbnail_id( $attachment->ID );
2697		if ( ! empty( $id ) ) {
2698			list( $src, $width, $height ) = wp_get_attachment_image_src( $id, 'full' );
2699			$response['image'] = compact( 'src', 'width', 'height' );
2700			list( $src, $width, $height ) = wp_get_attachment_image_src( $id, 'thumbnail' );
2701			$response['thumb'] = compact( 'src', 'width', 'height' );
2702		} else {
2703			$src = wp_mime_type_icon( $attachment->ID );
2704			$width = 48;
2705			$height = 64;
2706			$response['image'] = compact( 'src', 'width', 'height' );
2707			$response['thumb'] = compact( 'src', 'width', 'height' );
2708		}
2709	}
2710
2711	if ( function_exists('get_compat_media_markup') )
2712		$response['compat'] = get_compat_media_markup( $attachment->ID, array( 'in_modal' => true ) );
2713
2714	/**
2715	 * Filter the attachment data prepared for JavaScript.
2716	 *
2717	 * @since 3.5.0
2718	 *
2719	 * @param array      $response   Array of prepared attachment data.
2720	 * @param int|object $attachment Attachment ID or object.
2721	 * @param array      $meta       Array of attachment meta data.
2722	 */
2723	return apply_filters( 'wp_prepare_attachment_for_js', $response, $attachment, $meta );
2724}
2725
2726/**
2727 * Enqueues all scripts, styles, settings, and templates necessary to use
2728 * all media JS APIs.
2729 *
2730 * @since 3.5.0
2731 */
2732function wp_enqueue_media( $args = array() ) {
2733
2734	// Enqueue me just once per page, please.
2735	if ( did_action( 'wp_enqueue_media' ) )
2736		return;
2737
2738	global $content_width, $wpdb;
2739
2740	$defaults = array(
2741		'post' => null,
2742	);
2743	$args = wp_parse_args( $args, $defaults );
2744
2745	// We're going to pass the old thickbox media tabs to `media_upload_tabs`
2746	// to ensure plugins will work. We will then unset those tabs.
2747	$tabs = array(
2748		// handler action suffix => tab label
2749		'type'     => '',
2750		'type_url' => '',
2751		'gallery'  => '',
2752		'library'  => '',
2753	);
2754
2755	/** This filter is documented in wp-admin/includes/media.php */
2756	$tabs = apply_filters( 'media_upload_tabs', $tabs );
2757	unset( $tabs['type'], $tabs['type_url'], $tabs['gallery'], $tabs['library'] );
2758
2759	$props = array(
2760		'link'  => get_option( 'image_default_link_type' ), // db default is 'file'
2761		'align' => get_option( 'image_default_align' ), // empty default
2762		'size'  => get_option( 'image_default_size' ),  // empty default
2763	);
2764
2765	$exts = array_merge( wp_get_audio_extensions(), wp_get_video_extensions() );
2766	$mimes = get_allowed_mime_types();
2767	$ext_mimes = array();
2768	foreach ( $exts as $ext ) {
2769		foreach ( $mimes as $ext_preg => $mime_match ) {
2770			if ( preg_match( '#' . $ext . '#i', $ext_preg ) ) {
2771				$ext_mimes[ $ext ] = $mime_match;
2772				break;
2773			}
2774		}
2775	}
2776
2777	$has_audio = $wpdb->get_var( "
2778		SELECT ID
2779		FROM $wpdb->posts
2780		WHERE post_type = 'attachment'
2781		AND post_mime_type LIKE 'audio%'
2782		LIMIT 1
2783	" );
2784	$has_video = $wpdb->get_var( "
2785		SELECT ID
2786		FROM $wpdb->posts
2787		WHERE post_type = 'attachment'
2788		AND post_mime_type LIKE 'video%'
2789		LIMIT 1
2790	" );
2791
2792	$settings = array(
2793		'tabs'      => $tabs,
2794		'tabUrl'    => add_query_arg( array( 'chromeless' => true ), admin_url('media-upload.php') ),
2795		'mimeTypes' => wp_list_pluck( get_post_mime_types(), 0 ),
2796		/** This filter is documented in wp-admin/includes/media.php */
2797		'captions'  => ! apply_filters( 'disable_captions', '' ),
2798		'nonce'     => array(
2799			'sendToEditor' => wp_create_nonce( 'media-send-to-editor' ),
2800		),
2801		'post'    => array(
2802			'id' => 0,
2803		),
2804		'defaultProps' => $props,
2805		'attachmentCounts' => array(
2806			'audio' => ( $has_audio ) ? 1 : 0,
2807			'video' => ( $has_video ) ? 1 : 0
2808		),
2809		'embedExts'    => $exts,
2810		'embedMimes'   => $ext_mimes,
2811		'contentWidth' => $content_width,
2812	);
2813
2814	$post = null;
2815	if ( isset( $args['post'] ) ) {
2816		$post = get_post( $args['post'] );
2817		$settings['post'] = array(
2818			'id' => $post->ID,
2819			'nonce' => wp_create_nonce( 'update-post_' . $post->ID ),
2820		);
2821
2822		$thumbnail_support = current_theme_supports( 'post-thumbnails', $post->post_type ) && post_type_supports( $post->post_type, 'thumbnail' );
2823		if ( ! $thumbnail_support && 'attachment' === $post->post_type && $post->post_mime_type ) {
2824			if ( 0 === strpos( $post->post_mime_type, 'audio/' ) ) {
2825				$thumbnail_support = post_type_supports( 'attachment:audio', 'thumbnail' ) || current_theme_supports( 'post-thumbnails', 'attachment:audio' );
2826			} elseif ( 0 === strpos( $post->post_mime_type, 'video/' ) ) {
2827				$thumbnail_support = post_type_supports( 'attachment:video', 'thumbnail' ) || current_theme_supports( 'post-thumbnails', 'attachment:video' );
2828			}
2829		}
2830
2831		if ( $thumbnail_support ) {
2832			$featured_image_id = get_post_meta( $post->ID, '_thumbnail_id', true );
2833			$settings['post']['featuredImageId'] = $featured_image_id ? $featured_image_id : -1;
2834		}
2835	}
2836
2837	$hier = $post && is_post_type_hierarchical( $post->post_type );
2838
2839	$strings = array(
2840		// Generic
2841		'url'         => __( 'URL' ),
2842		'addMedia'    => __( 'Add Media' ),
2843		'search'      => __( 'Search' ),
2844		'select'      => __( 'Select' ),
2845		'cancel'      => __( 'Cancel' ),
2846		'update'      => __( 'Update' ),
2847		'replace'     => __( 'Replace' ),
2848		'remove'      => __( 'Remove' ),
2849		'back'        => __( 'Back' ),
2850		/* translators: This is a would-be plural string used in the media manager.
2851		   If there is not a word you can use in your language to avoid issues with the
2852		   lack of plural support here, turn it into "selected: %d" then translate it.
2853		 */
2854		'selected'    => __( '%d selected' ),
2855		'dragInfo'    => __( 'Drag and drop to reorder images.' ),
2856
2857		// Upload
2858		'uploadFilesTitle'  => __( 'Upload Files' ),
2859		'uploadImagesTitle' => __( 'Upload Images' ),
2860
2861		// Library
2862		'mediaLibraryTitle'  => __( 'Media Library' ),
2863		'insertMediaTitle'   => __( 'Insert Media' ),
2864		'createNewGallery'   => __( 'Create a new gallery' ),
2865		'createNewPlaylist'   => __( 'Create a new playlist' ),
2866		'createNewVideoPlaylist'   => __( 'Create a new video playlist' ),
2867		'returnToLibrary'    => __( '&#8592; Return to library' ),
2868		'allMediaItems'      => __( 'All media items' ),
2869		'allMediaTypes'      => __( 'All media types' ),
2870		'noItemsFound'       => __( 'No items found.' ),
2871		'insertIntoPost'     => $hier ? __( 'Insert into page' ) : __( 'Insert into post' ),
2872		'uploadedToThisPost' => $hier ? __( 'Uploaded to this page' ) : __( 'Uploaded to this post' ),
2873		'warnDelete' =>      __( "You are about to permanently delete this item.\n  'Cancel' to stop, 'OK' to delete." ),
2874
2875		// From URL
2876		'insertFromUrlTitle' => __( 'Insert from URL' ),
2877
2878		// Featured Images
2879		'setFeaturedImageTitle' => __( 'Set Featured Image' ),
2880		'setFeaturedImage'    => __( 'Set featured image' ),
2881
2882		// Gallery
2883		'createGalleryTitle' => __( 'Create Gallery' ),
2884		'editGalleryTitle'   => __( 'Edit Gallery' ),
2885		'cancelGalleryTitle' => __( '&#8592; Cancel Gallery' ),
2886		'insertGallery'      => __( 'Insert gallery' ),
2887		'updateGallery'      => __( 'Update gallery' ),
2888		'addToGallery'       => __( 'Add to gallery' ),
2889		'addToGalleryTitle'  => __( 'Add to Gallery' ),
2890		'reverseOrder'       => __( 'Reverse order' ),
2891
2892		// Edit Image
2893		'imageDetailsTitle'     => __( 'Image Details' ),
2894		'imageReplaceTitle'     => __( 'Replace Image' ),
2895		'imageDetailsCancel'    => __( 'Cancel Edit' ),
2896		'editImage'             => __( 'Edit Image' ),
2897
2898		// Crop Image
2899		'chooseImage' => __( 'Choose Image' ),
2900		'selectAndCrop' => __( 'Select and Crop' ),
2901		'skipCropping' => __( 'Skip Cropping' ),
2902		'cropImage' => __( 'Crop Image' ),
2903		'cropYourImage' => __( 'Crop your image' ),
2904		'cropping' => __( 'Cropping&hellip;' ),
2905		'suggestedDimensions' => __( 'Suggested image dimensions:' ),
2906		'cropError' => __( 'There has been an error cropping your image.' ),
2907
2908		// Edit Audio
2909		'audioDetailsTitle'     => __( 'Audio Details' ),
2910		'audioReplaceTitle'     => __( 'Replace Audio' ),
2911		'audioAddSourceTitle'   => __( 'Add Audio Source' ),
2912		'audioDetailsCancel'    => __( 'Cancel Edit' ),
2913
2914		// Edit Video
2915		'videoDetailsTitle'     => __( 'Video Details' ),
2916		'videoReplaceTitle'     => __( 'Replace Video' ),
2917		'videoAddSourceTitle'   => __( 'Add Video Source' ),
2918		'videoDetailsCancel'    => __( 'Cancel Edit' ),
2919		'videoSelectPosterImageTitle' => __( 'Select Poster Image' ),
2920		'videoAddTrackTitle'	=> __( 'Add Subtitles' ),
2921
2922 		// Playlist
2923 		'playlistDragInfo'    => __( 'Drag and drop to reorder tracks.' ),
2924 		'createPlaylistTitle' => __( 'Create Audio Playlist' ),
2925 		'editPlaylistTitle'   => __( 'Edit Audio Playlist' ),
2926 		'cancelPlaylistTitle' => __( '&#8592; Cancel Audio Playlist' ),
2927 		'insertPlaylist'      => __( 'Insert audio playlist' ),
2928 		'updatePlaylist'      => __( 'Update audio playlist' ),
2929 		'addToPlaylist'       => __( 'Add to audio playlist' ),
2930 		'addToPlaylistTitle'  => __( 'Add to Audio Playlist' ),
2931
2932 		// Video Playlist
2933 		'videoPlaylistDragInfo'    => __( 'Drag and drop to reorder videos.' ),
2934 		'createVideoPlaylistTitle' => __( 'Create Video Playlist' ),
2935 		'editVideoPlaylistTitle'   => __( 'Edit Video Playlist' ),
2936 		'cancelVideoPlaylistTitle' => __( '&#8592; Cancel Video Playlist' ),
2937 		'insertVideoPlaylist'      => __( 'Insert video playlist' ),
2938 		'updateVideoPlaylist'      => __( 'Update video playlist' ),
2939 		'addToVideoPlaylist'       => __( 'Add to video playlist' ),
2940 		'addToVideoPlaylistTitle'  => __( 'Add to Video Playlist' ),
2941	);
2942
2943	/**
2944	 * Filter the media view settings.
2945	 *
2946	 * @since 3.5.0
2947	 *
2948	 * @param array   $settings List of media view settings.
2949	 * @param WP_Post $post     Post object.
2950	 */
2951	$settings = apply_filters( 'media_view_settings', $settings, $post );
2952
2953	/**
2954	 * Filter the media view strings.
2955	 *
2956	 * @since 3.5.0
2957	 *
2958	 * @param array   $strings List of media view strings.
2959	 * @param WP_Post $post    Post object.
2960	 */
2961	$strings = apply_filters( 'media_view_strings', $strings,  $post );
2962
2963	$strings['settings'] = $settings;
2964
2965	wp_localize_script( 'media-views', '_wpMediaViewsL10n', $strings );
2966
2967	wp_enqueue_script( 'media-editor' );
2968	wp_enqueue_script( 'media-audiovideo' );
2969	wp_enqueue_style( 'media-views' );
2970	if ( is_admin() ) {
2971		wp_enqueue_script( 'mce-view' );
2972		wp_enqueue_script( 'image-edit' );
2973	}
2974	wp_enqueue_style( 'imgareaselect' );
2975	wp_plupload_default_settings();
2976
2977	require_once ABSPATH . WPINC . '/media-template.php';
2978	add_action( 'admin_footer', 'wp_print_media_templates' );
2979	add_action( 'wp_footer', 'wp_print_media_templates' );
2980	add_action( 'customize_controls_print_footer_scripts', 'wp_print_media_templates' );
2981
2982	/**
2983	 * Fires at the conclusion of wp_enqueue_media().
2984	 *
2985	 * @since 3.5.0
2986	 */
2987	do_action( 'wp_enqueue_media' );
2988}
2989
2990/**
2991 * Retrieve media attached to the passed post.
2992 *
2993 * @since 3.6.0
2994 *
2995 * @param string      $type Mime type.
2996 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
2997 * @return array Found attachments.
2998 */
2999function get_attached_media( $type, $post = 0 ) {
3000	if ( ! $post = get_post( $post ) )
3001		return array();
3002
3003	$args = array(
3004		'post_parent' => $post->ID,
3005		'post_type' => 'attachment',
3006		'post_mime_type' => $type,
3007		'posts_per_page' => -1,
3008		'orderby' => 'menu_order',
3009		'order' => 'ASC',
3010	);
3011
3012	/**
3013	 * Filter arguments used to retrieve media attached to the given post.
3014	 *
3015	 * @since 3.6.0
3016	 *
3017	 * @param array  $args Post query arguments.
3018	 * @param string $type Mime type of the desired media.
3019	 * @param mixed  $post Post ID or object.
3020	 */
3021	$args = apply_filters( 'get_attached_media_args', $args, $type, $post );
3022
3023	$children = get_children( $args );
3024
3025	/**
3026	 * Filter the list of media attached to the given post.
3027	 *
3028	 * @since 3.6.0
3029	 *
3030	 * @param array  $children Associative array of media attached to the given post.
3031	 * @param string $type     Mime type of the media desired.
3032	 * @param mixed  $post     Post ID or object.
3033	 */
3034	return (array) apply_filters( 'get_attached_media', $children, $type, $post );
3035}
3036
3037/**
3038 * Check the content blob for an <audio>, <video> <object>, <embed>, or <iframe>
3039 *
3040 * @since 3.6.0
3041 *
3042 * @param string $content A string which might contain media data.
3043 * @param array $types array of media types: 'audio', 'video', 'object', 'embed', or 'iframe'
3044 * @return array A list of found HTML media embeds
3045 */
3046function get_media_embedded_in_content( $content, $types = null ) {
3047	$html = array();
3048	$allowed_media_types = array( 'audio', 'video', 'object', 'embed', 'iframe' );
3049	if ( ! empty( $types ) ) {
3050		if ( ! is_array( $types ) )
3051			$types = array( $types );
3052		$allowed_media_types = array_intersect( $allowed_media_types, $types );
3053	}
3054
3055	foreach ( $allowed_media_types as $tag ) {
3056		if ( preg_match( '#' . get_tag_regex( $tag ) . '#', $content, $matches ) ) {
3057			$html[] = $matches[0];
3058		}
3059	}
3060
3061	return $html;
3062}
3063
3064/**
3065 * Retrieve galleries from the passed post's content.
3066 *
3067 * @since 3.6.0
3068 *
3069 * @param int|WP_Post $post Optional. Post ID or object.
3070 * @param bool        $html Whether to return HTML or data in the array.
3071 * @return array A list of arrays, each containing gallery data and srcs parsed
3072 *		         from the expanded shortcode.
3073 */
3074function get_post_galleries( $post, $html = true ) {
3075	if ( ! $post = get_post( $post ) )
3076		return array();
3077
3078	if ( ! has_shortcode( $post->post_content, 'gallery' ) )
3079		return array();
3080
3081	$galleries = array();
3082	if ( preg_match_all( '/' . get_shortcode_regex() . '/s', $post->post_content, $matches, PREG_SET_ORDER ) ) {
3083		foreach ( $matches as $shortcode ) {
3084			if ( 'gallery' === $shortcode[2] ) {
3085				$srcs = array();
3086
3087				$gallery = do_shortcode_tag( $shortcode );
3088				if ( $html ) {
3089					$galleries[] = $gallery;
3090				} else {
3091					preg_match_all( '#src=([\'"])(.+?)\1#is', $gallery, $src, PREG_SET_ORDER );
3092					if ( ! empty( $src ) ) {
3093						foreach ( $src as $s )
3094							$srcs[] = $s[2];
3095					}
3096
3097					$data = shortcode_parse_atts( $shortcode[3] );
3098					$data['src'] = array_values( array_unique( $srcs ) );
3099					$galleries[] = $data;
3100				}
3101			}
3102		}
3103	}
3104
3105	/**
3106	 * Filter the list of all found galleries in the given post.
3107	 *
3108	 * @since 3.6.0
3109	 *
3110	 * @param array   $galleries Associative array of all found post galleries.
3111	 * @param WP_Post $post      Post object.
3112	 */
3113	return apply_filters( 'get_post_galleries', $galleries, $post );
3114}
3115
3116/**
3117 * Check a specified post's content for gallery and, if present, return the first
3118 *
3119 * @since 3.6.0
3120 *
3121 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
3122 * @param bool        $html Whether to return HTML or data.
3123 * @return string|array Gallery data and srcs parsed from the expanded shortcode.
3124 */
3125function get_post_gallery( $post = 0, $html = true ) {
3126	$galleries = get_post_galleries( $post, $html );
3127	$gallery = reset( $galleries );
3128
3129	/**
3130	 * Filter the first-found post gallery.
3131	 *
3132	 * @since 3.6.0
3133	 *
3134	 * @param array       $gallery   The first-found post gallery.
3135	 * @param int|WP_Post $post      Post ID or object.
3136	 * @param array       $galleries Associative array of all found post galleries.
3137	 */
3138	return apply_filters( 'get_post_gallery', $gallery, $post, $galleries );
3139}
3140
3141/**
3142 * Retrieve the image srcs from galleries from a post's content, if present
3143 *
3144 * @since 3.6.0
3145 *
3146 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
3147 * @return array A list of lists, each containing image srcs parsed.
3148 *		from an expanded shortcode
3149 */
3150function get_post_galleries_images( $post = 0 ) {
3151	$galleries = get_post_galleries( $post, false );
3152	return wp_list_pluck( $galleries, 'src' );
3153}
3154
3155/**
3156 * Check a post's content for galleries and return the image srcs for the first found gallery
3157 *
3158 * @since 3.6.0
3159 *
3160 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
3161 * @return array A list of a gallery's image srcs in order.
3162 */
3163function get_post_gallery_images( $post = 0 ) {
3164	$gallery = get_post_gallery( $post, false );
3165	return empty( $gallery['src'] ) ? array() : $gallery['src'];
3166}
3167
3168/**
3169 * Maybe attempt to generate attachment metadata, if missing.
3170 *
3171 * @since 3.9.0
3172 *
3173 * @param WP_Post $attachment Attachment object.
3174 */
3175function wp_maybe_generate_attachment_metadata( $attachment ) {
3176	if ( empty( $attachment ) || ( empty( $attachment->ID ) || ! $attachment_id = (int) $attachment->ID ) ) {
3177		return;
3178	}
3179
3180	$file = get_attached_file( $attachment_id );
3181	$meta = wp_get_attachment_metadata( $attachment_id );
3182	if ( empty( $meta ) && file_exists( $file ) ) {
3183		$_meta = get_post_meta( $attachment_id );
3184		$regeneration_lock = 'wp_generating_att_' . $attachment_id;
3185		if ( ! array_key_exists( '_wp_attachment_metadata', $_meta ) && ! get_transient( $regeneration_lock ) ) {
3186			set_transient( $regeneration_lock, $file );
3187			wp_update_attachment_metadata( $attachment_id, wp_generate_attachment_metadata( $attachment_id, $file ) );
3188			delete_transient( $regeneration_lock );
3189		}
3190	}
3191}