PageRenderTime 91ms CodeModel.GetById 24ms app.highlight 48ms RepoModel.GetById 1ms app.codeStats 1ms

/htdocs/wp-includes/media.php

https://bitbucket.org/dkrzos/phc
PHP | 1560 lines | 810 code | 197 blank | 553 comment | 189 complexity | 3777f989f339b8960ce97909b9158bff MD5 | raw file

Large files files are truncated, but you can click here to view the full 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	list( $max_width, $max_height ) = apply_filters( 'editor_max_image_size', array( $max_width, $max_height ), $size, $context );
  82
  83	return wp_constrain_dimensions( $width, $height, $max_width, $max_height );
  84}
  85
  86/**
  87 * Retrieve width and height attributes using given width and height values.
  88 *
  89 * Both attributes are required in the sense that both parameters must have a
  90 * value, but are optional in that if you set them to false or null, then they
  91 * will not be added to the returned string.
  92 *
  93 * You can set the value using a string, but it will only take numeric values.
  94 * If you wish to put 'px' after the numbers, then it will be stripped out of
  95 * the return.
  96 *
  97 * @since 2.5.0
  98 *
  99 * @param int|string $width Optional. Width attribute value.
 100 * @param int|string $height Optional. Height attribute value.
 101 * @return string HTML attributes for width and, or height.
 102 */
 103function image_hwstring($width, $height) {
 104	$out = '';
 105	if ($width)
 106		$out .= 'width="'.intval($width).'" ';
 107	if ($height)
 108		$out .= 'height="'.intval($height).'" ';
 109	return $out;
 110}
 111
 112/**
 113 * Scale an image to fit a particular size (such as 'thumb' or 'medium').
 114 *
 115 * Array with image url, width, height, and whether is intermediate size, in
 116 * that order is returned on success is returned. $is_intermediate is true if
 117 * $url is a resized image, false if it is the original.
 118 *
 119 * The URL might be the original image, or it might be a resized version. This
 120 * function won't create a new resized copy, it will just return an already
 121 * resized one if it exists.
 122 *
 123 * A plugin may use the 'image_downsize' filter to hook into and offer image
 124 * resizing services for images. The hook must return an array with the same
 125 * elements that are returned in the function. The first element being the URL
 126 * to the new image that was resized.
 127 *
 128 * @since 2.5.0
 129 * @uses apply_filters() Calls 'image_downsize' on $id and $size to provide
 130 *		resize services.
 131 *
 132 * @param int $id Attachment ID for image.
 133 * @param array|string $size Optional, default is 'medium'. Size of image, either array or string.
 134 * @return bool|array False on failure, array on success.
 135 */
 136function image_downsize($id, $size = 'medium') {
 137
 138	if ( !wp_attachment_is_image($id) )
 139		return false;
 140
 141	$img_url = wp_get_attachment_url($id);
 142	$meta = wp_get_attachment_metadata($id);
 143	$width = $height = 0;
 144	$is_intermediate = false;
 145	$img_url_basename = wp_basename($img_url);
 146
 147	// plugins can use this to provide resize services
 148	if ( $out = apply_filters('image_downsize', false, $id, $size) )
 149		return $out;
 150
 151	// try for a new style intermediate size
 152	if ( $intermediate = image_get_intermediate_size($id, $size) ) {
 153		$img_url = str_replace($img_url_basename, $intermediate['file'], $img_url);
 154		$width = $intermediate['width'];
 155		$height = $intermediate['height'];
 156		$is_intermediate = true;
 157	}
 158	elseif ( $size == 'thumbnail' ) {
 159		// fall back to the old thumbnail
 160		if ( ($thumb_file = wp_get_attachment_thumb_file($id)) && $info = getimagesize($thumb_file) ) {
 161			$img_url = str_replace($img_url_basename, wp_basename($thumb_file), $img_url);
 162			$width = $info[0];
 163			$height = $info[1];
 164			$is_intermediate = true;
 165		}
 166	}
 167	if ( !$width && !$height && isset($meta['width'], $meta['height']) ) {
 168		// any other type: use the real image
 169		$width = $meta['width'];
 170		$height = $meta['height'];
 171	}
 172
 173	if ( $img_url) {
 174		// we have the actual image size, but might need to further constrain it if content_width is narrower
 175		list( $width, $height ) = image_constrain_size_for_editor( $width, $height, $size );
 176
 177		return array( $img_url, $width, $height, $is_intermediate );
 178	}
 179	return false;
 180
 181}
 182
 183/**
 184 * Registers a new image size
 185 *
 186 * @since 2.9.0
 187 */
 188function add_image_size( $name, $width = 0, $height = 0, $crop = false ) {
 189	global $_wp_additional_image_sizes;
 190	$_wp_additional_image_sizes[$name] = array( 'width' => absint( $width ), 'height' => absint( $height ), 'crop' => (bool) $crop );
 191}
 192
 193/**
 194 * Registers an image size for the post thumbnail
 195 *
 196 * @since 2.9.0
 197 */
 198function set_post_thumbnail_size( $width = 0, $height = 0, $crop = false ) {
 199	add_image_size( 'post-thumbnail', $width, $height, $crop );
 200}
 201
 202/**
 203 * An <img src /> tag for an image attachment, scaling it down if requested.
 204 *
 205 * The filter 'get_image_tag_class' allows for changing the class name for the
 206 * image without having to use regular expressions on the HTML content. The
 207 * parameters are: what WordPress will use for the class, the Attachment ID,
 208 * image align value, and the size the image should be.
 209 *
 210 * The second filter 'get_image_tag' has the HTML content, which can then be
 211 * further manipulated by a plugin to change all attribute values and even HTML
 212 * content.
 213 *
 214 * @since 2.5.0
 215 *
 216 * @uses apply_filters() The 'get_image_tag_class' filter is the IMG element
 217 *		class attribute.
 218 * @uses apply_filters() The 'get_image_tag' filter is the full IMG element with
 219 *		all attributes.
 220 *
 221 * @param int $id Attachment ID.
 222 * @param string $alt Image Description for the alt attribute.
 223 * @param string $title Image Description for the title attribute.
 224 * @param string $align Part of the class name for aligning the image.
 225 * @param string $size Optional. Default is 'medium'.
 226 * @return string HTML IMG element for given image attachment
 227 */
 228function get_image_tag($id, $alt, $title, $align, $size='medium') {
 229
 230	list( $img_src, $width, $height ) = image_downsize($id, $size);
 231	$hwstring = image_hwstring($width, $height);
 232
 233	$title = $title ? 'title="' . esc_attr( $title ) . '" ' : '';
 234
 235	$class = 'align' . esc_attr($align) .' size-' . esc_attr($size) . ' wp-image-' . $id;
 236	$class = apply_filters('get_image_tag_class', $class, $id, $align, $size);
 237
 238	$html = '<img src="' . esc_attr($img_src) . '" alt="' . esc_attr($alt) . '" ' . $title . $hwstring . 'class="' . $class . '" />';
 239
 240	$html = apply_filters( 'get_image_tag', $html, $id, $alt, $title, $align, $size );
 241
 242	return $html;
 243}
 244
 245/**
 246 * Calculates the new dimensions for a downsampled image.
 247 *
 248 * If either width or height are empty, no constraint is applied on
 249 * that dimension.
 250 *
 251 * @since 2.5.0
 252 *
 253 * @param int $current_width Current width of the image.
 254 * @param int $current_height Current height of the image.
 255 * @param int $max_width Optional. Maximum wanted width.
 256 * @param int $max_height Optional. Maximum wanted height.
 257 * @return array First item is the width, the second item is the height.
 258 */
 259function wp_constrain_dimensions( $current_width, $current_height, $max_width=0, $max_height=0 ) {
 260	if ( !$max_width and !$max_height )
 261		return array( $current_width, $current_height );
 262
 263	$width_ratio = $height_ratio = 1.0;
 264	$did_width = $did_height = false;
 265
 266	if ( $max_width > 0 && $current_width > 0 && $current_width > $max_width ) {
 267		$width_ratio = $max_width / $current_width;
 268		$did_width = true;
 269	}
 270
 271	if ( $max_height > 0 && $current_height > 0 && $current_height > $max_height ) {
 272		$height_ratio = $max_height / $current_height;
 273		$did_height = true;
 274	}
 275
 276	// Calculate the larger/smaller ratios
 277	$smaller_ratio = min( $width_ratio, $height_ratio );
 278	$larger_ratio  = max( $width_ratio, $height_ratio );
 279
 280	if ( intval( $current_width * $larger_ratio ) > $max_width || intval( $current_height * $larger_ratio ) > $max_height )
 281 		// The larger ratio is too big. It would result in an overflow.
 282		$ratio = $smaller_ratio;
 283	else
 284		// The larger ratio fits, and is likely to be a more "snug" fit.
 285		$ratio = $larger_ratio;
 286
 287	$w = intval( $current_width  * $ratio );
 288	$h = intval( $current_height * $ratio );
 289
 290	// Sometimes, due to rounding, we'll end up with a result like this: 465x700 in a 177x177 box is 117x176... a pixel short
 291	// 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.
 292	// Thus we look for dimensions that are one pixel shy of the max value and bump them up
 293	if ( $did_width && $w == $max_width - 1 )
 294		$w = $max_width; // Round it up
 295	if ( $did_height && $h == $max_height - 1 )
 296		$h = $max_height; // Round it up
 297
 298	return array( $w, $h );
 299}
 300
 301/**
 302 * Retrieve calculated resized dimensions for use in WP_Image_Editor.
 303 *
 304 * Calculate dimensions and coordinates for a resized image that fits within a
 305 * specified width and height. If $crop is true, the largest matching central
 306 * portion of the image will be cropped out and resized to the required size.
 307 *
 308 * @since 2.5.0
 309 * @uses apply_filters() Calls 'image_resize_dimensions' on $orig_w, $orig_h, $dest_w, $dest_h and
 310 *		$crop to provide custom resize dimensions.
 311 *
 312 * @param int $orig_w Original width.
 313 * @param int $orig_h Original height.
 314 * @param int $dest_w New width.
 315 * @param int $dest_h New height.
 316 * @param bool $crop Optional, default is false. Whether to crop image or resize.
 317 * @return bool|array False on failure. Returned array matches parameters for imagecopyresampled() PHP function.
 318 */
 319function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop = false) {
 320
 321	if ($orig_w <= 0 || $orig_h <= 0)
 322		return false;
 323	// at least one of dest_w or dest_h must be specific
 324	if ($dest_w <= 0 && $dest_h <= 0)
 325		return false;
 326
 327	// plugins can use this to provide custom resize dimensions
 328	$output = apply_filters( 'image_resize_dimensions', null, $orig_w, $orig_h, $dest_w, $dest_h, $crop );
 329	if ( null !== $output )
 330		return $output;
 331
 332	if ( $crop ) {
 333		// crop the largest possible portion of the original image that we can size to $dest_w x $dest_h
 334		$aspect_ratio = $orig_w / $orig_h;
 335		$new_w = min($dest_w, $orig_w);
 336		$new_h = min($dest_h, $orig_h);
 337
 338		if ( !$new_w ) {
 339			$new_w = intval($new_h * $aspect_ratio);
 340		}
 341
 342		if ( !$new_h ) {
 343			$new_h = intval($new_w / $aspect_ratio);
 344		}
 345
 346		$size_ratio = max($new_w / $orig_w, $new_h / $orig_h);
 347
 348		$crop_w = round($new_w / $size_ratio);
 349		$crop_h = round($new_h / $size_ratio);
 350
 351		$s_x = floor( ($orig_w - $crop_w) / 2 );
 352		$s_y = floor( ($orig_h - $crop_h) / 2 );
 353	} else {
 354		// don't crop, just resize using $dest_w x $dest_h as a maximum bounding box
 355		$crop_w = $orig_w;
 356		$crop_h = $orig_h;
 357
 358		$s_x = 0;
 359		$s_y = 0;
 360
 361		list( $new_w, $new_h ) = wp_constrain_dimensions( $orig_w, $orig_h, $dest_w, $dest_h );
 362	}
 363
 364	// if the resulting image would be the same size or larger we don't want to resize it
 365	if ( $new_w >= $orig_w && $new_h >= $orig_h )
 366		return false;
 367
 368	// the return array matches the parameters to imagecopyresampled()
 369	// int dst_x, int dst_y, int src_x, int src_y, int dst_w, int dst_h, int src_w, int src_h
 370	return array( 0, 0, (int) $s_x, (int) $s_y, (int) $new_w, (int) $new_h, (int) $crop_w, (int) $crop_h );
 371
 372}
 373
 374/**
 375 * Resize an image to make a thumbnail or intermediate size.
 376 *
 377 * The returned array has the file size, the image width, and image height. The
 378 * filter 'image_make_intermediate_size' can be used to hook in and change the
 379 * values of the returned array. The only parameter is the resized file path.
 380 *
 381 * @since 2.5.0
 382 *
 383 * @param string $file File path.
 384 * @param int $width Image width.
 385 * @param int $height Image height.
 386 * @param bool $crop Optional, default is false. Whether to crop image to specified height and width or resize.
 387 * @return bool|array False, if no image was created. Metadata array on success.
 388 */
 389function image_make_intermediate_size( $file, $width, $height, $crop = false ) {
 390	if ( $width || $height ) {
 391		$editor = wp_get_image_editor( $file );
 392
 393		if ( is_wp_error( $editor ) || is_wp_error( $editor->resize( $width, $height, $crop ) ) )
 394			return false;
 395
 396		$resized_file = $editor->save();
 397
 398		if ( ! is_wp_error( $resized_file ) && $resized_file ) {
 399			unset( $resized_file['path'] );
 400			return $resized_file;
 401		}
 402	}
 403	return false;
 404}
 405
 406/**
 407 * Retrieve the image's intermediate size (resized) path, width, and height.
 408 *
 409 * The $size parameter can be an array with the width and height respectively.
 410 * If the size matches the 'sizes' metadata array for width and height, then it
 411 * will be used. If there is no direct match, then the nearest image size larger
 412 * than the specified size will be used. If nothing is found, then the function
 413 * will break out and return false.
 414 *
 415 * The metadata 'sizes' is used for compatible sizes that can be used for the
 416 * parameter $size value.
 417 *
 418 * The url path will be given, when the $size parameter is a string.
 419 *
 420 * If you are passing an array for the $size, you should consider using
 421 * add_image_size() so that a cropped version is generated. It's much more
 422 * efficient than having to find the closest-sized image and then having the
 423 * browser scale down the image.
 424 *
 425 * @since 2.5.0
 426 * @see add_image_size()
 427 *
 428 * @param int $post_id Attachment ID for image.
 429 * @param array|string $size Optional, default is 'thumbnail'. Size of image, either array or string.
 430 * @return bool|array False on failure or array of file path, width, and height on success.
 431 */
 432function image_get_intermediate_size($post_id, $size='thumbnail') {
 433	if ( !is_array( $imagedata = wp_get_attachment_metadata( $post_id ) ) )
 434		return false;
 435
 436	// get the best one for a specified set of dimensions
 437	if ( is_array($size) && !empty($imagedata['sizes']) ) {
 438		foreach ( $imagedata['sizes'] as $_size => $data ) {
 439			// already cropped to width or height; so use this size
 440			if ( ( $data['width'] == $size[0] && $data['height'] <= $size[1] ) || ( $data['height'] == $size[1] && $data['width'] <= $size[0] ) ) {
 441				$file = $data['file'];
 442				list($width, $height) = image_constrain_size_for_editor( $data['width'], $data['height'], $size );
 443				return compact( 'file', 'width', 'height' );
 444			}
 445			// add to lookup table: area => size
 446			$areas[$data['width'] * $data['height']] = $_size;
 447		}
 448		if ( !$size || !empty($areas) ) {
 449			// find for the smallest image not smaller than the desired size
 450			ksort($areas);
 451			foreach ( $areas as $_size ) {
 452				$data = $imagedata['sizes'][$_size];
 453				if ( $data['width'] >= $size[0] || $data['height'] >= $size[1] ) {
 454					// Skip images with unexpectedly divergent aspect ratios (crops)
 455					// First, we calculate what size the original image would be if constrained to a box the size of the current image in the loop
 456					$maybe_cropped = image_resize_dimensions($imagedata['width'], $imagedata['height'], $data['width'], $data['height'], false );
 457					// 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
 458					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'] ) ) )
 459						continue;
 460					// If we're still here, then we're going to use this size
 461					$file = $data['file'];
 462					list($width, $height) = image_constrain_size_for_editor( $data['width'], $data['height'], $size );
 463					return compact( 'file', 'width', 'height' );
 464				}
 465			}
 466		}
 467	}
 468
 469	if ( is_array($size) || empty($size) || empty($imagedata['sizes'][$size]) )
 470		return false;
 471
 472	$data = $imagedata['sizes'][$size];
 473	// include the full filesystem path of the intermediate file
 474	if ( empty($data['path']) && !empty($data['file']) ) {
 475		$file_url = wp_get_attachment_url($post_id);
 476		$data['path'] = path_join( dirname($imagedata['file']), $data['file'] );
 477		$data['url'] = path_join( dirname($file_url), $data['file'] );
 478	}
 479	return $data;
 480}
 481
 482/**
 483 * Get the available image sizes
 484 * @since 3.0.0
 485 * @return array Returns a filtered array of image size strings
 486 */
 487function get_intermediate_image_sizes() {
 488	global $_wp_additional_image_sizes;
 489	$image_sizes = array('thumbnail', 'medium', 'large'); // Standard sizes
 490	if ( isset( $_wp_additional_image_sizes ) && count( $_wp_additional_image_sizes ) )
 491		$image_sizes = array_merge( $image_sizes, array_keys( $_wp_additional_image_sizes ) );
 492
 493	return apply_filters( 'intermediate_image_sizes', $image_sizes );
 494}
 495
 496/**
 497 * Retrieve an image to represent an attachment.
 498 *
 499 * A mime icon for files, thumbnail or intermediate size for images.
 500 *
 501 * @since 2.5.0
 502 *
 503 * @param int $attachment_id Image attachment ID.
 504 * @param string $size Optional, default is 'thumbnail'.
 505 * @param bool $icon Optional, default is false. Whether it is an icon.
 506 * @return bool|array Returns an array (url, width, height), or false, if no image is available.
 507 */
 508function wp_get_attachment_image_src($attachment_id, $size='thumbnail', $icon = false) {
 509
 510	// get a thumbnail or intermediate image if there is one
 511	if ( $image = image_downsize($attachment_id, $size) )
 512		return $image;
 513
 514	$src = false;
 515
 516	if ( $icon && $src = wp_mime_type_icon($attachment_id) ) {
 517		$icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/crystal' );
 518		$src_file = $icon_dir . '/' . wp_basename($src);
 519		@list($width, $height) = getimagesize($src_file);
 520	}
 521	if ( $src && $width && $height )
 522		return array( $src, $width, $height );
 523	return false;
 524}
 525
 526/**
 527 * Get an HTML img element representing an image attachment
 528 *
 529 * While $size will accept an array, it is better to register a size with
 530 * add_image_size() so that a cropped version is generated. It's much more
 531 * efficient than having to find the closest-sized image and then having the
 532 * browser scale down the image.
 533 *
 534 * @see add_image_size()
 535 * @uses apply_filters() Calls 'wp_get_attachment_image_attributes' hook on attributes array
 536 * @uses wp_get_attachment_image_src() Gets attachment file URL and dimensions
 537 * @since 2.5.0
 538 *
 539 * @param int $attachment_id Image attachment ID.
 540 * @param string $size Optional, default is 'thumbnail'.
 541 * @param bool $icon Optional, default is false. Whether it is an icon.
 542 * @return string HTML img element or empty string on failure.
 543 */
 544function wp_get_attachment_image($attachment_id, $size = 'thumbnail', $icon = false, $attr = '') {
 545
 546	$html = '';
 547	$image = wp_get_attachment_image_src($attachment_id, $size, $icon);
 548	if ( $image ) {
 549		list($src, $width, $height) = $image;
 550		$hwstring = image_hwstring($width, $height);
 551		if ( is_array($size) )
 552			$size = join('x', $size);
 553		$attachment = get_post($attachment_id);
 554		$default_attr = array(
 555			'src'	=> $src,
 556			'class'	=> "attachment-$size",
 557			'alt'	=> trim(strip_tags( get_post_meta($attachment_id, '_wp_attachment_image_alt', true) )), // Use Alt field first
 558		);
 559		if ( empty($default_attr['alt']) )
 560			$default_attr['alt'] = trim(strip_tags( $attachment->post_excerpt )); // If not, Use the Caption
 561		if ( empty($default_attr['alt']) )
 562			$default_attr['alt'] = trim(strip_tags( $attachment->post_title )); // Finally, use the title
 563
 564		$attr = wp_parse_args($attr, $default_attr);
 565		$attr = apply_filters( 'wp_get_attachment_image_attributes', $attr, $attachment );
 566		$attr = array_map( 'esc_attr', $attr );
 567		$html = rtrim("<img $hwstring");
 568		foreach ( $attr as $name => $value ) {
 569			$html .= " $name=" . '"' . $value . '"';
 570		}
 571		$html .= ' />';
 572	}
 573
 574	return $html;
 575}
 576
 577/**
 578 * Adds a 'wp-post-image' class to post thumbnails
 579 * Uses the begin_fetch_post_thumbnail_html and end_fetch_post_thumbnail_html action hooks to
 580 * dynamically add/remove itself so as to only filter post thumbnails
 581 *
 582 * @since 2.9.0
 583 * @param array $attr Attributes including src, class, alt, title
 584 * @return array
 585 */
 586function _wp_post_thumbnail_class_filter( $attr ) {
 587	$attr['class'] .= ' wp-post-image';
 588	return $attr;
 589}
 590
 591/**
 592 * Adds _wp_post_thumbnail_class_filter to the wp_get_attachment_image_attributes filter
 593 *
 594 * @since 2.9.0
 595 */
 596function _wp_post_thumbnail_class_filter_add( $attr ) {
 597	add_filter( 'wp_get_attachment_image_attributes', '_wp_post_thumbnail_class_filter' );
 598}
 599
 600/**
 601 * Removes _wp_post_thumbnail_class_filter from the wp_get_attachment_image_attributes filter
 602 *
 603 * @since 2.9.0
 604 */
 605function _wp_post_thumbnail_class_filter_remove( $attr ) {
 606	remove_filter( 'wp_get_attachment_image_attributes', '_wp_post_thumbnail_class_filter' );
 607}
 608
 609add_shortcode('wp_caption', 'img_caption_shortcode');
 610add_shortcode('caption', 'img_caption_shortcode');
 611
 612/**
 613 * The Caption shortcode.
 614 *
 615 * Allows a plugin to replace the content that would otherwise be returned. The
 616 * filter is 'img_caption_shortcode' and passes an empty string, the attr
 617 * parameter and the content parameter values.
 618 *
 619 * The supported attributes for the shortcode are 'id', 'align', 'width', and
 620 * 'caption'.
 621 *
 622 * @since 2.6.0
 623 *
 624 * @param array $attr Attributes attributed to the shortcode.
 625 * @param string $content Optional. Shortcode content.
 626 * @return string
 627 */
 628function img_caption_shortcode($attr, $content = null) {
 629	// New-style shortcode with the caption inside the shortcode with the link and image tags.
 630	if ( ! isset( $attr['caption'] ) ) {
 631		if ( preg_match( '#((?:<a [^>]+>\s*)?<img [^>]+>(?:\s*</a>)?)(.*)#is', $content, $matches ) ) {
 632			$content = $matches[1];
 633			$attr['caption'] = trim( $matches[2] );
 634		}
 635	}
 636
 637	// Allow plugins/themes to override the default caption template.
 638	$output = apply_filters('img_caption_shortcode', '', $attr, $content);
 639	if ( $output != '' )
 640		return $output;
 641
 642	extract(shortcode_atts(array(
 643		'id'	=> '',
 644		'align'	=> 'alignnone',
 645		'width'	=> '',
 646		'caption' => ''
 647	), $attr));
 648
 649	if ( 1 > (int) $width || empty($caption) )
 650		return $content;
 651
 652	if ( $id ) $id = 'id="' . esc_attr($id) . '" ';
 653
 654	return '<div ' . $id . 'class="wp-caption ' . esc_attr($align) . '" style="width: ' . (10 + (int) $width) . 'px">'
 655	. do_shortcode( $content ) . '<p class="wp-caption-text">' . $caption . '</p></div>';
 656}
 657
 658add_shortcode('gallery', 'gallery_shortcode');
 659
 660/**
 661 * The Gallery shortcode.
 662 *
 663 * This implements the functionality of the Gallery Shortcode for displaying
 664 * WordPress images on a post.
 665 *
 666 * @since 2.5.0
 667 *
 668 * @param array $attr Attributes of the shortcode.
 669 * @return string HTML content to display gallery.
 670 */
 671function gallery_shortcode($attr) {
 672	$post = get_post();
 673
 674	static $instance = 0;
 675	$instance++;
 676
 677	if ( ! empty( $attr['ids'] ) ) {
 678		// 'ids' is explicitly ordered, unless you specify otherwise.
 679		if ( empty( $attr['orderby'] ) )
 680			$attr['orderby'] = 'post__in';
 681		$attr['include'] = $attr['ids'];
 682	}
 683
 684	// Allow plugins/themes to override the default gallery template.
 685	$output = apply_filters('post_gallery', '', $attr);
 686	if ( $output != '' )
 687		return $output;
 688
 689	// We're trusting author input, so let's at least make sure it looks like a valid orderby statement
 690	if ( isset( $attr['orderby'] ) ) {
 691		$attr['orderby'] = sanitize_sql_orderby( $attr['orderby'] );
 692		if ( !$attr['orderby'] )
 693			unset( $attr['orderby'] );
 694	}
 695
 696	extract(shortcode_atts(array(
 697		'order'      => 'ASC',
 698		'orderby'    => 'menu_order ID',
 699		'id'         => $post->ID,
 700		'itemtag'    => 'dl',
 701		'icontag'    => 'dt',
 702		'captiontag' => 'dd',
 703		'columns'    => 3,
 704		'size'       => 'thumbnail',
 705		'include'    => '',
 706		'exclude'    => ''
 707	), $attr));
 708
 709	$id = intval($id);
 710	if ( 'RAND' == $order )
 711		$orderby = 'none';
 712
 713	if ( !empty($include) ) {
 714		$_attachments = get_posts( array('include' => $include, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $order, 'orderby' => $orderby) );
 715
 716		$attachments = array();
 717		foreach ( $_attachments as $key => $val ) {
 718			$attachments[$val->ID] = $_attachments[$key];
 719		}
 720	} elseif ( !empty($exclude) ) {
 721		$attachments = get_children( array('post_parent' => $id, 'exclude' => $exclude, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $order, 'orderby' => $orderby) );
 722	} else {
 723		$attachments = get_children( array('post_parent' => $id, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $order, 'orderby' => $orderby) );
 724	}
 725
 726	if ( empty($attachments) )
 727		return '';
 728
 729	if ( is_feed() ) {
 730		$output = "\n";
 731		foreach ( $attachments as $att_id => $attachment )
 732			$output .= wp_get_attachment_link($att_id, $size, true) . "\n";
 733		return $output;
 734	}
 735
 736	$itemtag = tag_escape($itemtag);
 737	$captiontag = tag_escape($captiontag);
 738	$icontag = tag_escape($icontag);
 739	$valid_tags = wp_kses_allowed_html( 'post' );
 740	if ( ! isset( $valid_tags[ $itemtag ] ) )
 741		$itemtag = 'dl';
 742	if ( ! isset( $valid_tags[ $captiontag ] ) )
 743		$captiontag = 'dd';
 744	if ( ! isset( $valid_tags[ $icontag ] ) )
 745		$icontag = 'dt';
 746
 747	$columns = intval($columns);
 748	$itemwidth = $columns > 0 ? floor(100/$columns) : 100;
 749	$float = is_rtl() ? 'right' : 'left';
 750
 751	$selector = "gallery-{$instance}";
 752
 753	$gallery_style = $gallery_div = '';
 754	if ( apply_filters( 'use_default_gallery_style', true ) )
 755		$gallery_style = "
 756		<style type='text/css'>
 757			#{$selector} {
 758				margin: auto;
 759			}
 760			#{$selector} .gallery-item {
 761				float: {$float};
 762				margin-top: 10px;
 763				text-align: center;
 764				width: {$itemwidth}%;
 765			}
 766			#{$selector} img {
 767				border: 2px solid #cfcfcf;
 768			}
 769			#{$selector} .gallery-caption {
 770				margin-left: 0;
 771			}
 772		</style>
 773		<!-- see gallery_shortcode() in wp-includes/media.php -->";
 774	$size_class = sanitize_html_class( $size );
 775	$gallery_div = "<div id='$selector' class='gallery galleryid-{$id} gallery-columns-{$columns} gallery-size-{$size_class}'>";
 776	$output = apply_filters( 'gallery_style', $gallery_style . "\n\t\t" . $gallery_div );
 777
 778	$i = 0;
 779	foreach ( $attachments as $id => $attachment ) {
 780		$link = isset($attr['link']) && 'file' == $attr['link'] ? wp_get_attachment_link($id, $size, false, false) : wp_get_attachment_link($id, $size, true, false);
 781
 782		$output .= "<{$itemtag} class='gallery-item'>";
 783		$output .= "
 784			<{$icontag} class='gallery-icon'>
 785				$link
 786			</{$icontag}>";
 787		if ( $captiontag && trim($attachment->post_excerpt) ) {
 788			$output .= "
 789				<{$captiontag} class='wp-caption-text gallery-caption'>
 790				" . wptexturize($attachment->post_excerpt) . "
 791				</{$captiontag}>";
 792		}
 793		$output .= "</{$itemtag}>";
 794		if ( $columns > 0 && ++$i % $columns == 0 )
 795			$output .= '<br style="clear: both" />';
 796	}
 797
 798	$output .= "
 799			<br style='clear: both;' />
 800		</div>\n";
 801
 802	return $output;
 803}
 804
 805/**
 806 * Display previous image link that has the same post parent.
 807 *
 808 * @since 2.5.0
 809 * @param string $size Optional, default is 'thumbnail'. Size of image, either array or string. 0 or 'none' will default to post_title or $text;
 810 * @param string $text Optional, default is false. If included, link will reflect $text variable.
 811 * @return string HTML content.
 812 */
 813function previous_image_link($size = 'thumbnail', $text = false) {
 814	adjacent_image_link(true, $size, $text);
 815}
 816
 817/**
 818 * Display next image link that has the same post parent.
 819 *
 820 * @since 2.5.0
 821 * @param string $size Optional, default is 'thumbnail'. Size of image, either array or string. 0 or 'none' will default to post_title or $text;
 822 * @param string $text Optional, default is false. If included, link will reflect $text variable.
 823 * @return string HTML content.
 824 */
 825function next_image_link($size = 'thumbnail', $text = false) {
 826	adjacent_image_link(false, $size, $text);
 827}
 828
 829/**
 830 * Display next or previous image link that has the same post parent.
 831 *
 832 * Retrieves the current attachment object from the $post global.
 833 *
 834 * @since 2.5.0
 835 *
 836 * @param bool $prev Optional. Default is true to display previous link, false for next.
 837 */
 838function adjacent_image_link($prev = true, $size = 'thumbnail', $text = false) {
 839	$post = get_post();
 840	$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' ) ) );
 841
 842	foreach ( $attachments as $k => $attachment )
 843		if ( $attachment->ID == $post->ID )
 844			break;
 845
 846	$k = $prev ? $k - 1 : $k + 1;
 847
 848	$output = $attachment_id = null;
 849	if ( isset( $attachments[ $k ] ) ) {
 850		$attachment_id = $attachments[ $k ]->ID;
 851		$output = wp_get_attachment_link( $attachment_id, $size, true, false, $text );
 852	}
 853
 854	$adjacent = $prev ? 'previous' : 'next';
 855	echo apply_filters( "{$adjacent}_image_link", $output, $attachment_id, $size, $text );
 856}
 857
 858/**
 859 * Retrieve taxonomies attached to the attachment.
 860 *
 861 * @since 2.5.0
 862 *
 863 * @param int|array|object $attachment Attachment ID, Attachment data array, or Attachment data object.
 864 * @return array Empty array on failure. List of taxonomies on success.
 865 */
 866function get_attachment_taxonomies($attachment) {
 867	if ( is_int( $attachment ) )
 868		$attachment = get_post($attachment);
 869	else if ( is_array($attachment) )
 870		$attachment = (object) $attachment;
 871
 872	if ( ! is_object($attachment) )
 873		return array();
 874
 875	$filename = basename($attachment->guid);
 876
 877	$objects = array('attachment');
 878
 879	if ( false !== strpos($filename, '.') )
 880		$objects[] = 'attachment:' . substr($filename, strrpos($filename, '.') + 1);
 881	if ( !empty($attachment->post_mime_type) ) {
 882		$objects[] = 'attachment:' . $attachment->post_mime_type;
 883		if ( false !== strpos($attachment->post_mime_type, '/') )
 884			foreach ( explode('/', $attachment->post_mime_type) as $token )
 885				if ( !empty($token) )
 886					$objects[] = "attachment:$token";
 887	}
 888
 889	$taxonomies = array();
 890	foreach ( $objects as $object )
 891		if ( $taxes = get_object_taxonomies($object) )
 892			$taxonomies = array_merge($taxonomies, $taxes);
 893
 894	return array_unique($taxonomies);
 895}
 896
 897/**
 898 * Return all of the taxonomy names that are registered for attachments.
 899 *
 900 * Handles mime-type-specific taxonomies such as attachment:image and attachment:video.
 901 *
 902 * @since 3.5.0
 903 * @see get_attachment_taxonomies()
 904 * @uses get_taxonomies()
 905 *
 906 * @param string $output The type of output to return, either taxonomy 'names' or 'objects'. 'names' is the default.
 907 * @return array The names of all taxonomy of $object_type.
 908 */
 909function get_taxonomies_for_attachments( $output = 'names' ) {
 910	$taxonomies = array();
 911	foreach ( get_taxonomies( array(), 'objects' ) as $taxonomy ) {
 912		foreach ( $taxonomy->object_type as $object_type ) {
 913			if ( 'attachment' == $object_type || 0 === strpos( $object_type, 'attachment:' ) ) {
 914				if ( 'names' == $output )
 915					$taxonomies[] = $taxonomy->name;
 916				else
 917					$taxonomies[ $taxonomy->name ] = $taxonomy;
 918				break;
 919			}
 920		}
 921	}
 922
 923	return $taxonomies;
 924}
 925
 926/**
 927 * Create new GD image resource with transparency support
 928 * @TODO: Deprecate if possible.
 929 *
 930 * @since 2.9.0
 931 *
 932 * @param int $width Image width
 933 * @param int $height Image height
 934 * @return image resource
 935 */
 936function wp_imagecreatetruecolor($width, $height) {
 937	$img = imagecreatetruecolor($width, $height);
 938	if ( is_resource($img) && function_exists('imagealphablending') && function_exists('imagesavealpha') ) {
 939		imagealphablending($img, false);
 940		imagesavealpha($img, true);
 941	}
 942	return $img;
 943}
 944
 945/**
 946 * Register an embed handler. This function should probably only be used for sites that do not support oEmbed.
 947 *
 948 * @since 2.9.0
 949 * @see WP_Embed::register_handler()
 950 */
 951function wp_embed_register_handler( $id, $regex, $callback, $priority = 10 ) {
 952	global $wp_embed;
 953	$wp_embed->register_handler( $id, $regex, $callback, $priority );
 954}
 955
 956/**
 957 * Unregister a previously registered embed handler.
 958 *
 959 * @since 2.9.0
 960 * @see WP_Embed::unregister_handler()
 961 */
 962function wp_embed_unregister_handler( $id, $priority = 10 ) {
 963	global $wp_embed;
 964	$wp_embed->unregister_handler( $id, $priority );
 965}
 966
 967/**
 968 * Create default array of embed parameters.
 969 *
 970 * The width defaults to the content width as specified by the theme. If the
 971 * theme does not specify a content width, then 500px is used.
 972 *
 973 * The default height is 1.5 times the width, or 1000px, whichever is smaller.
 974 *
 975 * The 'embed_defaults' filter can be used to adjust either of these values.
 976 *
 977 * @since 2.9.0
 978 *
 979 * @return array Default embed parameters.
 980 */
 981function wp_embed_defaults() {
 982	if ( ! empty( $GLOBALS['content_width'] ) )
 983		$width = (int) $GLOBALS['content_width'];
 984
 985	if ( empty( $width ) )
 986		$width = 500;
 987
 988	$height = min( ceil( $width * 1.5 ), 1000 );
 989
 990	return apply_filters( 'embed_defaults', compact( 'width', 'height' ) );
 991}
 992
 993/**
 994 * Based on a supplied width/height example, return the biggest possible dimensions based on the max width/height.
 995 *
 996 * @since 2.9.0
 997 * @uses wp_constrain_dimensions() This function passes the widths and the heights.
 998 *
 999 * @param int $example_width The width of an example embed.
1000 * @param int $example_height The height of an example embed.
1001 * @param int $max_width The maximum allowed width.
1002 * @param int $max_height The maximum allowed height.
1003 * @return array The maximum possible width and height based on the example ratio.
1004 */
1005function wp_expand_dimensions( $example_width, $example_height, $max_width, $max_height ) {
1006	$example_width  = (int) $example_width;
1007	$example_height = (int) $example_height;
1008	$max_width      = (int) $max_width;
1009	$max_height     = (int) $max_height;
1010
1011	return wp_constrain_dimensions( $example_width * 1000000, $example_height * 1000000, $max_width, $max_height );
1012}
1013
1014/**
1015 * Attempts to fetch the embed HTML for a provided URL using oEmbed.
1016 *
1017 * @since 2.9.0
1018 * @see WP_oEmbed
1019 *
1020 * @uses _wp_oembed_get_object()
1021 * @uses WP_oEmbed::get_html()
1022 *
1023 * @param string $url The URL that should be embedded.
1024 * @param array $args Additional arguments and parameters.
1025 * @return bool|string False on failure or the embed HTML on success.
1026 */
1027function wp_oembed_get( $url, $args = '' ) {
1028	require_once( ABSPATH . WPINC . '/class-oembed.php' );
1029	$oembed = _wp_oembed_get_object();
1030	return $oembed->get_html( $url, $args );
1031}
1032
1033/**
1034 * Adds a URL format and oEmbed provider URL pair.
1035 *
1036 * @since 2.9.0
1037 * @see WP_oEmbed
1038 *
1039 * @uses _wp_oembed_get_object()
1040 *
1041 * @param string $format The format of URL that this provider can handle. You can use asterisks as wildcards.
1042 * @param string $provider The URL to the oEmbed provider.
1043 * @param boolean $regex Whether the $format parameter is in a regex format.
1044 */
1045function wp_oembed_add_provider( $format, $provider, $regex = false ) {
1046	require_once( ABSPATH . WPINC . '/class-oembed.php' );
1047	$oembed = _wp_oembed_get_object();
1048	$oembed->providers[$format] = array( $provider, $regex );
1049}
1050
1051/**
1052 * Removes an oEmbed provider.
1053 *
1054 * @since 3.5
1055 * @see WP_oEmbed
1056 *
1057 * @uses _wp_oembed_get_object()
1058 *
1059 * @param string $format The URL format for the oEmbed provider to remove.
1060 */
1061function wp_oembed_remove_provider( $format ) {
1062	require_once( ABSPATH . WPINC . '/class-oembed.php' );
1063
1064	$oembed = _wp_oembed_get_object();
1065
1066	if ( isset( $oembed->providers[ $format ] ) ) {
1067		unset( $oembed->providers[ $format ] );
1068		return true;
1069	}
1070
1071	return false;
1072}
1073
1074/**
1075 * Determines if default embed handlers should be loaded.
1076 *
1077 * Checks to make sure that the embeds library hasn't already been loaded. If
1078 * it hasn't, then it will load the embeds library.
1079 *
1080 * @since 2.9.0
1081 */
1082function wp_maybe_load_embeds() {
1083	if ( ! apply_filters( 'load_default_embeds', true ) )
1084		return;
1085	wp_embed_register_handler( 'googlevideo', '#http://video\.google\.([A-Za-z.]{2,5})/videoplay\?docid=([\d-]+)(.*?)#i', 'wp_embed_handler_googlevideo' );
1086}
1087
1088/**
1089 * The Google Video embed handler callback. Google Video does not support oEmbed.
1090 *
1091 * @see WP_Embed::register_handler()
1092 * @see WP_Embed::shortcode()
1093 *
1094 * @param array $matches The regex matches from the provided regex when calling {@link wp_embed_register_handler()}.
1095 * @param array $attr Embed attributes.
1096 * @param string $url The original URL that was matched by the regex.
1097 * @param array $rawattr The original unmodified attributes.
1098 * @return string The embed HTML.
1099 */
1100function wp_embed_handler_googlevideo( $matches, $attr, $url, $rawattr ) {
1101	// If the user supplied a fixed width AND height, use it
1102	if ( !empty($rawattr['width']) && !empty($rawattr['height']) ) {
1103		$width  = (int) $rawattr['width'];
1104		$height = (int) $rawattr['height'];
1105	} else {
1106		list( $width, $height ) = wp_expand_dimensions( 425, 344, $attr['width'], $attr['height'] );
1107	}
1108
1109	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 );
1110}
1111
1112/**
1113 * {@internal Missing Short Description}}
1114 *
1115 * @since 2.3.0
1116 *
1117 * @param unknown_type $size
1118 * @return unknown
1119 */
1120function wp_convert_hr_to_bytes( $size ) {
1121	$size  = strtolower( $size );
1122	$bytes = (int) $size;
1123	if ( strpos( $size, 'k' ) !== false )
1124		$bytes = intval( $size ) * 1024;
1125	elseif ( strpos( $size, 'm' ) !== false )
1126		$bytes = intval($size) * 1024 * 1024;
1127	elseif ( strpos( $size, 'g' ) !== false )
1128		$bytes = intval( $size ) * 1024 * 1024 * 1024;
1129	return $bytes;
1130}
1131
1132/**
1133 * {@internal Missing Short Description}}
1134 *
1135 * @since 2.3.0
1136 *
1137 * @param unknown_type $bytes
1138 * @return unknown
1139 */
1140function wp_convert_bytes_to_hr( $bytes ) {
1141	$units = array( 0 => 'B', 1 => 'kB', 2 => 'MB', 3 => 'GB' );
1142	$log   = log( $bytes, 1024 );
1143	$power = (int) $log;
1144	$size  = pow( 1024, $log - $power );
1145	return $size . $units[$power];
1146}
1147
1148/**
1149 * {@internal Missing Short Description}}
1150 *
1151 * @since 2.5.0
1152 *
1153 * @return unknown
1154 */
1155function wp_max_upload_size() {
1156	$u_bytes = wp_convert_hr_to_bytes( ini_get( 'upload_max_filesize' ) );
1157	$p_bytes = wp_convert_hr_to_bytes( ini_get( 'post_max_size' ) );
1158	$bytes   = apply_filters( 'upload_size_limit', min( $u_bytes, $p_bytes ), $u_bytes, $p_bytes );
1159	return $bytes;
1160}
1161
1162/**
1163 * Returns a WP_Image_Editor instance and loads file into it.
1164 *
1165 * @since 3.5.0
1166 * @access public
1167 *
1168 * @param string $path Path to file to load
1169 * @param array $args Additional data. Accepts { 'mime_type'=>string, 'methods'=>{string, string, ...} }
1170 * @return WP_Image_Editor|WP_Error
1171 */
1172function wp_get_image_editor( $path, $args = array() ) {
1173	$args['path'] = $path;
1174
1175	if ( ! isset( $args['mime_type'] ) ) {
1176		$file_info  = wp_check_filetype( $args['path'] );
1177
1178		// If $file_info['type'] is false, then we let the editor attempt to
1179		// figure out the file type, rather than forcing a failure based on extension.
1180		if ( isset( $file_info ) && $file_info['type'] )
1181			$args['mime_type'] = $file_info['type'];
1182	}
1183
1184	$implementation = _wp_image_editor_choose( $args );
1185
1186	if ( $implementation ) {
1187		$editor = new $implementation( $path );
1188		$loaded = $editor->load();
1189
1190		if ( is_wp_error( $loaded ) )
1191			return $loaded;
1192
1193		return $editor;
1194	}
1195
1196	return new WP_Error( 'image_no_editor', __('No editor could be selected.') );
1197}
1198
1199/**
1200 * Tests whether there is an editor that supports a given mime type or methods.
1201 *
1202 * @since 3.5.0
1203 * @access public
1204 *
1205 * @param string|array $args Array of requirements.  Accepts { 'mime_type'=>string, 'methods'=>{string, string, ...} }
1206 * @return boolean true if an eligible editor is found; false otherwise
1207 */
1208function wp_image_editor_supports( $args = array() ) {
1209	return (bool) _wp_image_editor_choose( $args );
1210}
1211
1212/**
1213 * Tests which editors are capable of supporting the request.
1214 *
1215 * @since 3.5.0
1216 * @access private
1217 *
1218 * @param array $args Additional data. Accepts { 'mime_type'=>string, 'methods'=>{string, string, ...} }
1219 * @return string|bool Class name for the first editor that claims to support the request. False if no editor claims to support the request.
1220 */
1221function _wp_image_editor_choose( $args = array() ) {
1222	require_once ABSPATH . WPINC . '/class-wp-image-editor.php';
1223	require_once ABSPATH . WPINC . '/class-wp-image-editor-gd.php';
1224	require_once ABSPATH . WPINC . '/class-wp-image-editor-imagick.php';
1225
1226	$implementations = apply_filters( 'wp_image_editors',
1227		array( 'WP_Image_Editor_Imagick', 'WP_Image_Editor_GD' ) );
1228
1229	foreach ( $implementations as $implementation ) {
1230		if ( ! call_user_func( array( $implementation, 'test' ), $args ) )
1231			continue;
1232
1233		if ( isset( $args['mime_type'] ) &&
1234			! call_user_func(
1235				array( $implementation, 'supports_mime_type' ),
1236				$args['mime_type'] ) ) {
1237			continue;
1238		}
1239
1240		if ( isset( $args['methods'] ) &&
1241			 array_diff( $args['methods'], get_class_methods( $implementation ) ) ) {
1242			continue;
1243		}
1244
1245		return $implementation;
1246	}
1247
1248	return false;
1249}
1250
1251/**
1252 * Prints default plupload arguments.
1253 *
1254 * @since 3.4.0
1255 */
1256function wp_plupload_default_settings() {
1257	global $wp_scripts;
1258
1259	$data = $wp_scripts->get_data( 'wp-plupload', 'data' );
1260	if ( $data && false !== strpos( $data, '_wpPluploadSettings' ) )
1261		return;
1262
1263	$max_upload_size = wp_max_upload_size();
1264
1265	$defaults = array(
1266		'runtimes'            => 'html5,silverlight,flash,html4',
1267		'file_data_name'      => 'async-upload', // key passed to $_FILE.
1268		'multiple_queues'     => true,
1269		'max_file_size'       => $max_upload_size . 'b',
1270		'url'                 => admin_url( 'async-upload.php', 'relative' ),
1271		'flash_swf_url'       => includes_url( 'js/plupload/plupload.flash.swf' ),
1272		'silverlight_xap_url' => includes_url( 'js/plupload/plupload.silverlight.xap' ),
1273		'filters'             => array( array( 'title' => __( 'Allowed Files' ), 'extensions' => '*') ),
1274		'multipart'           => true,
1275		'urlstream_upload'    => true,
1276	);
1277
1278	// Multi-file uploading doesn't currently work in iOS Safari,
1279	// single-file allows the built-in camera to be used as source for images
1280	if ( wp_is_mobile() )
1281		$defaults['multi_selection'] = false;
1282
1283	$defaults = apply_filters( 'plupload_default_settings', $defaults );
1284
1285	$params = array(
1286		'action' => 'upload-attachment',
1287	);
1288
1289	$params = apply_filters( 'plupload_default_params', $params );
1290	$params['_wpnonce'] = wp_create_nonce( 'media-form' );
1291	$defaults['multipart_params'] = $params;
1292
1293	$settings = array(
1294		'defaults' => $defaults,
1295		'browser'  => array(
1296			'mobile'    => wp_is_mobile(),
1297			'supported' => _device_can_upload(),
1298		),
1299		'limitExceeded' => is_multisite() && ! is_upload_space_available()
1300	);
1301
1302	$script = 'var _wpPluploadSettings = ' . json_encode( $settings ) . ';';
1303
1304	if ( $data )
1305		$script = "$data\n$script";
1306
1307	$wp_scripts->add_data( 'wp-plupload', 'data', $script );
1308}
1309add_action( 'customize_controls_enqueue_scripts', 'wp_plupload_default_settings' );
1310
1311/**
1312 * Prepares an attachment post object for JS, where it is expected
1313 * to be JSON-encoded and fit into an Attachment model.
1314 *
1315 * @since 3.5.0
1316 *
1317 * @param mixed $attachment Attachment ID or object.
1318 * @return array Array of attachment details.
1319 */
1320function wp_prepare_attachment_for_js( $attachment ) {
1321	if ( ! $attachment = get_post( $attachment ) )
1322		return;
1323
1324	if ( 'attachment' != $attachment->post_type )
1325		return;
1326
1327	$meta = wp_get_attachment_metadata( $attachment->ID );
1328	if ( false !== strpos( $attachment->post_mime_type, '/' ) )
1329		list( $type, $subtype ) = explode( '/', $attachment->post_mime_type );
1330	else
1331		list( $type, $subtype ) = array( $attachment->post_mime_type, '' );
1332
1333	$attachment_url = wp_get_attachment_url( $attachment->ID );
1334
1335	$response = array(
1336		'id'          => $attachment->ID,
1337		'title'       => $attachment->post_title,
1338		'filename'    => basename( $attachment->guid ),
1339		'url'         => $attachment_url,
1340		'link'        => get_attachment_link( $attachment->ID ),
1341		'alt'         => get_post_meta( $attachment->ID, '_wp_attachment_image_alt', true ),
1342		'author'      => $attachment->post_author,
1343		'description' => $attachment->post_content,
1344		'caption'     => $attachment->post_excerpt,
1345		'name'        => $attachment->post_name,
1346		'status'      => $attachment->post_status,
1347		'uploadedTo'  => $attachment->post_parent,
1348		'date'        => strtotime( $attachment->post_date_gmt ) * 1000,
1349		'modified'    => strtotime( $attachment->post_modified_gmt ) * 1000,
1350		'menuOrder'   => $attachment->menu_order,
1351		'mime'        => $attachment->post_mime_type,
1352		'type'        => $type,
1353		'subtype'     => $subtype,
1354		'icon'        => wp_mime_type_icon( $attachment->ID ),
1355		'dateFormatted' => mysql2date( get_option('date_format'), $attachment->post_date ),
1356		'nonces'      => array(
1357			'update' => false,
1358			'delete' => false,
1359		),
1360		'editLink'   => false,
1361	);
1362
1363	if ( current_user_can( 'edit_post', $attachment->ID ) ) {
1364		$response['nonces']['update'] = wp_create_nonce( 'update-post_' . $attachment->ID );
1365		$response['editLink'] = get_edit_post_link( $attachment->ID, 'raw' );
1366	}
1367
1368	if ( current_user_can( 'delete_post', $attachment->ID ) )
1369		$response['nonces']['delete'] = wp_create_nonce( 'delete-post_' . $attachment->ID );
1370
1371	if ( $meta && 'image' === $type ) {
1372		$sizes = array();
1373		$possible_sizes = apply_filters( 'image_size_names_choose', array(
1374			'thumbnail' => __('Thumbnail'),
1375			'medium'    => __('Medium'),
1376			'large'     => __('Large'),
1377			'full'      => __('Full Size'),
1378		) );
1379		unset( $possible_sizes['full'] );
1380
1381		// Loop through all potential sizes that may be chosen. Try to do this with some efficiency.
1382		// First: run the image_downsize filter. If it returns something, we can use its data.
1383		// If the filter does not return something, then image_downsize() is just an expensive
1384		// way to check the image metadata, which we do second.
1385		foreach ( $possible_sizes as $size => $label ) {
1386			if ( $downsize = apply_filters( 'image_downsize', false, $attachment->ID, $size ) ) {
1387				if ( ! $downsize[3] )
1388					continue;
1389				$sizes[ $size ] = array(
1390					'height'      => $downsize[2],
1391					'width'       => $downsize[1],
1392					'url'         => $downsize[0],
1393					'orientation' => $downsize[2] > $downsize[1] ? 'portrait' : 'landscape',
1394				);
1395			} elseif ( isset( $meta['sizes'][ $size ] ) ) {
1396				if ( ! isset( $base_url ) )
1397					$base_url = str_replace( wp_basename( $attachment_url ), '', $attachment_url );
1398
1399				// Nothing from the filter, so consult image metadata if we have it.
1400				$size_meta = $meta['sizes'][ $size ];
1401
1402				// We have the actual image size, but might need to further constrain it if content_width is narrower.
1403				// Thumbnail, medium, and full sizes are also checked against the site's height/width options.
1404				list( $width, $height ) = image_constrain_size_for_editor( $size_meta['width'], $size_meta['height'], $size, 'edit' );
1405
1406				$sizes[ $size ] = array(
1407					'height'      => $height,
1408					'width'       => $width,
1409					'url'         => $base_url . $size_meta['file'],
1410					'orientation' => $height > $width ? 'portrait' : 'landscape',
1411				);
1412			}
1413		}
1414
1415		$sizes['full'] = array(
1416			'height'      => $meta['height'],
1417			'width'       => $meta['width'],
1418			'url'         => $attachment_url,
1419			'orientation' => $meta['height'] > $meta['width'] ? 'portrait' : 'landscape',
1420		);
1421
1422		$response = array_merge( $response, array( 'sizes' => $sizes ), $sizes['full'] );
1423	}
1424
1425	if ( function_exists('get_compat_media_markup') )
1426		$response['compat'] = get_compat_media_markup( $attachment->ID, array( 'in_modal' => true ) );
1427
1428	return apply_filters( 'wp_prepare_attachment_for_js', $response, $attachment, $meta );
1429}
1430
1431/**
1432 * Enqueues all scripts, styles, settings, and templates necessary to use
1433 * all media JS APIs.
1434 *
1435 * @since 3.5.0
1436 */
1437function wp_enqueue_media( $args = array() ) {
1438
1439	// Enqueue me just once per page, pl…

Large files files are truncated, but you can click here to view the full file