3 * WordPress API for media display.
10 * Scale down the default size of an image.
12 * This is so that the image is a better fit for the editor and theme.
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
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.
28 * @uses wp_constrain_dimensions() This function passes the widths and the heights.
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.
36 function image_constrain_size_for_editor($width, $height, $size = 'medium', $context = null ) {
37 global $content_width, $_wp_additional_image_sizes;
40 $context = is_admin() ? 'edit' : 'display';
42 if ( is_array($size) ) {
43 $max_width = $size[0];
44 $max_height = $size[1];
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 ) {
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
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 );
75 // $size == 'full' has no constraint
78 $max_height = $height;
81 list( $max_width, $max_height ) = apply_filters( 'editor_max_image_size', array( $max_width, $max_height ), $size, $context );
83 return wp_constrain_dimensions( $width, $height, $max_width, $max_height );
87 * Retrieve width and height attributes using given width and height values.
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.
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
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.
103 function image_hwstring($width, $height) {
106 $out .= 'width="'.intval($width).'" ';
108 $out .= 'height="'.intval($height).'" ';
113 * Scale an image to fit a particular size (such as 'thumb' or 'medium').
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.
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.
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.
129 * @uses apply_filters() Calls 'image_downsize' on $id and $size to provide
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.
136 function image_downsize($id, $size = 'medium') {
138 if ( !wp_attachment_is_image($id) )
141 // plugins can use this to provide resize services
142 if ( $out = apply_filters( 'image_downsize', false, $id, $size ) )
145 $img_url = wp_get_attachment_url($id);
146 $meta = wp_get_attachment_metadata($id);
147 $width = $height = 0;
148 $is_intermediate = false;
149 $img_url_basename = wp_basename($img_url);
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;
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);
164 $is_intermediate = true;
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'];
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 );
177 return array( $img_url, $width, $height, $is_intermediate );
184 * Registers a new image size
188 function 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 );
194 * Registers an image size for the post thumbnail
198 function set_post_thumbnail_size( $width = 0, $height = 0, $crop = false ) {
199 add_image_size( 'post-thumbnail', $width, $height, $crop );
203 * An <img src /> tag for an image attachment, scaling it down if requested.
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.
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
216 * @uses apply_filters() The 'get_image_tag_class' filter is the IMG element
218 * @uses apply_filters() The 'get_image_tag' filter is the full IMG element with
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
228 function get_image_tag($id, $alt, $title, $align, $size='medium') {
230 list( $img_src, $width, $height ) = image_downsize($id, $size);
231 $hwstring = image_hwstring($width, $height);
233 $title = $title ? 'title="' . esc_attr( $title ) . '" ' : '';
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);
238 $html = '<img src="' . esc_attr($img_src) . '" alt="' . esc_attr($alt) . '" ' . $title . $hwstring . 'class="' . $class . '" />';
240 $html = apply_filters( 'get_image_tag', $html, $id, $alt, $title, $align, $size );
246 * Calculates the new dimensions for a downsampled image.
248 * If either width or height are empty, no constraint is applied on
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.
259 function 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 );
263 $width_ratio = $height_ratio = 1.0;
264 $did_width = $did_height = false;
266 if ( $max_width > 0 && $current_width > 0 && $current_width > $max_width ) {
267 $width_ratio = $max_width / $current_width;
271 if ( $max_height > 0 && $current_height > 0 && $current_height > $max_height ) {
272 $height_ratio = $max_height / $current_height;
276 // Calculate the larger/smaller ratios
277 $smaller_ratio = min( $width_ratio, $height_ratio );
278 $larger_ratio = max( $width_ratio, $height_ratio );
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;
284 // The larger ratio fits, and is likely to be a more "snug" fit.
285 $ratio = $larger_ratio;
287 $w = intval( $current_width * $ratio );
288 $h = intval( $current_height * $ratio );
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
298 return array( $w, $h );
302 * Retrieve calculated resized dimensions for use in WP_Image_Editor.
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.
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.
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.
319 function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop = false) {
321 if ($orig_w <= 0 || $orig_h <= 0)
323 // at least one of dest_w or dest_h must be specific
324 if ($dest_w <= 0 && $dest_h <= 0)
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 )
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);
339 $new_w = intval($new_h * $aspect_ratio);
343 $new_h = intval($new_w / $aspect_ratio);
346 $size_ratio = max($new_w / $orig_w, $new_h / $orig_h);
348 $crop_w = round($new_w / $size_ratio);
349 $crop_h = round($new_h / $size_ratio);
351 $s_x = floor( ($orig_w - $crop_w) / 2 );
352 $s_y = floor( ($orig_h - $crop_h) / 2 );
354 // don't crop, just resize using $dest_w x $dest_h as a maximum bounding box
361 list( $new_w, $new_h ) = wp_constrain_dimensions( $orig_w, $orig_h, $dest_w, $dest_h );
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 )
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 );
375 * Resize an image to make a thumbnail or intermediate size.
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.
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.
389 function image_make_intermediate_size( $file, $width, $height, $crop = false ) {
390 if ( $width || $height ) {
391 $editor = wp_get_image_editor( $file );
393 if ( is_wp_error( $editor ) || is_wp_error( $editor->resize( $width, $height, $crop ) ) )
396 $resized_file = $editor->save();
398 if ( ! is_wp_error( $resized_file ) && $resized_file ) {
399 unset( $resized_file['path'] );
400 return $resized_file;
407 * Retrieve the image's intermediate size (resized) path, width, and height.
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.
415 * The metadata 'sizes' is used for compatible sizes that can be used for the
416 * parameter $size value.
418 * The url path will be given, when the $size parameter is a string.
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.
426 * @see add_image_size()
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.
432 function image_get_intermediate_size($post_id, $size='thumbnail') {
433 if ( !is_array( $imagedata = wp_get_attachment_metadata( $post_id ) ) )
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' );
445 // add to lookup table: area => size
446 $areas[$data['width'] * $data['height']] = $_size;
448 if ( !$size || !empty($areas) ) {
449 // find for the smallest image not smaller than the desired size
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'] ) ) )
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' );
469 if ( is_array($size) || empty($size) || empty($imagedata['sizes'][$size]) )
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'] );
483 * Get the available image sizes
485 * @return array Returns a filtered array of image size strings
487 function 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 ) );
493 return apply_filters( 'intermediate_image_sizes', $image_sizes );
497 * Retrieve an image to represent an attachment.
499 * A mime icon for files, thumbnail or intermediate size for images.
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.
508 function wp_get_attachment_image_src($attachment_id, $size='thumbnail', $icon = false) {
510 // get a thumbnail or intermediate image if there is one
511 if ( $image = image_downsize($attachment_id, $size) )
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);
521 if ( $src && $width && $height )
522 return array( $src, $width, $height );
527 * Get an HTML img element representing an image attachment
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.
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
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 * @param mixed $attr Optional, attributes for the image markup.
543 * @return string HTML img element or empty string on failure.
545 function wp_get_attachment_image($attachment_id, $size = 'thumbnail', $icon = false, $attr = '') {
548 $image = wp_get_attachment_image_src($attachment_id, $size, $icon);
550 list($src, $width, $height) = $image;
551 $hwstring = image_hwstring($width, $height);
552 if ( is_array($size) )
553 $size = join('x', $size);
554 $attachment = get_post($attachment_id);
555 $default_attr = array(
557 'class' => "attachment-$size",
558 'alt' => trim(strip_tags( get_post_meta($attachment_id, '_wp_attachment_image_alt', true) )), // Use Alt field first
560 if ( empty($default_attr['alt']) )
561 $default_attr['alt'] = trim(strip_tags( $attachment->post_excerpt )); // If not, Use the Caption
562 if ( empty($default_attr['alt']) )
563 $default_attr['alt'] = trim(strip_tags( $attachment->post_title )); // Finally, use the title
565 $attr = wp_parse_args($attr, $default_attr);
566 $attr = apply_filters( 'wp_get_attachment_image_attributes', $attr, $attachment );
567 $attr = array_map( 'esc_attr', $attr );
568 $html = rtrim("<img $hwstring");
569 foreach ( $attr as $name => $value ) {
570 $html .= " $name=" . '"' . $value . '"';
579 * Adds a 'wp-post-image' class to post thumbnails
580 * Uses the begin_fetch_post_thumbnail_html and end_fetch_post_thumbnail_html action hooks to
581 * dynamically add/remove itself so as to only filter post thumbnails
584 * @param array $attr Attributes including src, class, alt, title
587 function _wp_post_thumbnail_class_filter( $attr ) {
588 $attr['class'] .= ' wp-post-image';
593 * Adds _wp_post_thumbnail_class_filter to the wp_get_attachment_image_attributes filter
597 function _wp_post_thumbnail_class_filter_add( $attr ) {
598 add_filter( 'wp_get_attachment_image_attributes', '_wp_post_thumbnail_class_filter' );
602 * Removes _wp_post_thumbnail_class_filter from the wp_get_attachment_image_attributes filter
606 function _wp_post_thumbnail_class_filter_remove( $attr ) {
607 remove_filter( 'wp_get_attachment_image_attributes', '_wp_post_thumbnail_class_filter' );
610 add_shortcode('wp_caption', 'img_caption_shortcode');
611 add_shortcode('caption', 'img_caption_shortcode');
614 * The Caption shortcode.
616 * Allows a plugin to replace the content that would otherwise be returned. The
617 * filter is 'img_caption_shortcode' and passes an empty string, the attr
618 * parameter and the content parameter values.
620 * The supported attributes for the shortcode are 'id', 'align', 'width', and
625 * @param array $attr Attributes attributed to the shortcode.
626 * @param string $content Optional. Shortcode content.
629 function img_caption_shortcode($attr, $content = null) {
630 // New-style shortcode with the caption inside the shortcode with the link and image tags.
631 if ( ! isset( $attr['caption'] ) ) {
632 if ( preg_match( '#((?:<a [^>]+>\s*)?<img [^>]+>(?:\s*</a>)?)(.*)#is', $content, $matches ) ) {
633 $content = $matches[1];
634 $attr['caption'] = trim( $matches[2] );
638 // Allow plugins/themes to override the default caption template.
639 $output = apply_filters('img_caption_shortcode', '', $attr, $content);
643 extract(shortcode_atts(array(
645 'align' => 'alignnone',
648 ), $attr, 'caption'));
650 if ( 1 > (int) $width || empty($caption) )
653 if ( $id ) $id = 'id="' . esc_attr($id) . '" ';
655 return '<div ' . $id . 'class="wp-caption ' . esc_attr($align) . '" style="width: ' . (10 + (int) $width) . 'px">'
656 . do_shortcode( $content ) . '<p class="wp-caption-text">' . $caption . '</p></div>';
659 add_shortcode('gallery', 'gallery_shortcode');
662 * The Gallery shortcode.
664 * This implements the functionality of the Gallery Shortcode for displaying
665 * WordPress images on a post.
669 * @param array $attr Attributes of the shortcode.
670 * @return string HTML content to display gallery.
672 function gallery_shortcode($attr) {
675 static $instance = 0;
678 if ( ! empty( $attr['ids'] ) ) {
679 // 'ids' is explicitly ordered, unless you specify otherwise.
680 if ( empty( $attr['orderby'] ) )
681 $attr['orderby'] = 'post__in';
682 $attr['include'] = $attr['ids'];
685 // Allow plugins/themes to override the default gallery template.
686 $output = apply_filters('post_gallery', '', $attr);
690 // We're trusting author input, so let's at least make sure it looks like a valid orderby statement
691 if ( isset( $attr['orderby'] ) ) {
692 $attr['orderby'] = sanitize_sql_orderby( $attr['orderby'] );
693 if ( !$attr['orderby'] )
694 unset( $attr['orderby'] );
697 extract(shortcode_atts(array(
699 'orderby' => 'menu_order ID',
700 'id' => $post ? $post->ID : 0,
703 'captiontag' => 'dd',
705 'size' => 'thumbnail',
708 ), $attr, 'gallery'));
711 if ( 'RAND' == $order )
714 if ( !empty($include) ) {
715 $_attachments = get_posts( array('include' => $include, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $order, 'orderby' => $orderby) );
717 $attachments = array();
718 foreach ( $_attachments as $key => $val ) {
719 $attachments[$val->ID] = $_attachments[$key];
721 } elseif ( !empty($exclude) ) {
722 $attachments = get_children( array('post_parent' => $id, 'exclude' => $exclude, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $order, 'orderby' => $orderby) );
724 $attachments = get_children( array('post_parent' => $id, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $order, 'orderby' => $orderby) );
727 if ( empty($attachments) )
732 foreach ( $attachments as $att_id => $attachment )
733 $output .= wp_get_attachment_link($att_id, $size, true) . "\n";
737 $itemtag = tag_escape($itemtag);
738 $captiontag = tag_escape($captiontag);
739 $icontag = tag_escape($icontag);
740 $valid_tags = wp_kses_allowed_html( 'post' );
741 if ( ! isset( $valid_tags[ $itemtag ] ) )
743 if ( ! isset( $valid_tags[ $captiontag ] ) )
745 if ( ! isset( $valid_tags[ $icontag ] ) )
748 $columns = intval($columns);
749 $itemwidth = $columns > 0 ? floor(100/$columns) : 100;
750 $float = is_rtl() ? 'right' : 'left';
752 $selector = "gallery-{$instance}";
754 $gallery_style = $gallery_div = '';
755 if ( apply_filters( 'use_default_gallery_style', true ) )
757 <style type='text/css'>
761 #{$selector} .gallery-item {
765 width: {$itemwidth}%;
768 border: 2px solid #cfcfcf;
770 #{$selector} .gallery-caption {
773 /* see gallery_shortcode() in wp-includes/media.php */
775 $size_class = sanitize_html_class( $size );
776 $gallery_div = "<div id='$selector' class='gallery galleryid-{$id} gallery-columns-{$columns} gallery-size-{$size_class}'>";
777 $output = apply_filters( 'gallery_style', $gallery_style . "\n\t\t" . $gallery_div );
780 foreach ( $attachments as $id => $attachment ) {
781 if ( ! empty( $attr['link'] ) && 'file' === $attr['link'] )
782 $image_output = wp_get_attachment_link( $id, $size, false, false );
783 elseif ( ! empty( $attr['link'] ) && 'none' === $attr['link'] )
784 $image_output = wp_get_attachment_image( $id, $size, false );
786 $image_output = wp_get_attachment_link( $id, $size, true, false );
788 $image_meta = wp_get_attachment_metadata( $id );
791 if ( isset( $image_meta['height'], $image_meta['width'] ) )
792 $orientation = ( $image_meta['height'] > $image_meta['width'] ) ? 'portrait' : 'landscape';
794 $output .= "<{$itemtag} class='gallery-item'>";
796 <{$icontag} class='gallery-icon {$orientation}'>
799 if ( $captiontag && trim($attachment->post_excerpt) ) {
801 <{$captiontag} class='wp-caption-text gallery-caption'>
802 " . wptexturize($attachment->post_excerpt) . "
805 $output .= "</{$itemtag}>";
806 if ( $columns > 0 && ++$i % $columns == 0 )
807 $output .= '<br style="clear: both" />';
811 <br style='clear: both;' />
818 * Provide a No-JS Flash fallback as a last resort for audio / video
823 * @return string Fallback HTML
825 function wp_mediaelement_fallback( $url ) {
826 return apply_filters( 'wp_mediaelement_fallback', sprintf( '<a href="%1$s">%1$s</a>', esc_url( $url ) ), $url );
830 * Return a filtered list of WP-supported audio formats
835 function wp_get_audio_extensions() {
836 return apply_filters( 'wp_audio_extensions', array( 'mp3', 'ogg', 'wma', 'm4a', 'wav' ) );
840 * The Audio shortcode.
842 * This implements the functionality of the Audio Shortcode for displaying
843 * WordPress mp3s in a post.
847 * @param array $attr Attributes of the shortcode.
848 * @return string HTML content to display audio.
850 function wp_audio_shortcode( $attr ) {
851 $post_id = get_post() ? get_the_ID() : 0;
853 static $instances = 0;
858 $default_types = wp_get_audio_extensions();
859 $defaults_atts = array(
865 foreach ( $default_types as $type )
866 $defaults_atts[$type] = '';
868 $atts = shortcode_atts( $defaults_atts, $attr, 'audio' );
872 if ( ! empty( $src ) ) {
873 $type = wp_check_filetype( $src, wp_get_mime_types() );
874 if ( ! in_array( $type['ext'], $default_types ) )
875 return sprintf( '<a class="wp-embedded-audio" href="%s">%s</a>', esc_url( $src ), esc_html( $src ) );
877 array_unshift( $default_types, 'src' );
879 foreach ( $default_types as $ext ) {
880 if ( ! empty( $$ext ) ) {
881 $type = wp_check_filetype( $$ext, wp_get_mime_types() );
882 if ( $type['ext'] === $ext )
889 $audios = get_attached_media( 'audio', $post_id );
890 if ( empty( $audios ) )
893 $audio = reset( $audios );
894 $src = wp_get_attachment_url( $audio->ID );
898 array_unshift( $default_types, 'src' );
901 $library = apply_filters( 'wp_audio_shortcode_library', 'mediaelement' );
902 if ( 'mediaelement' === $library && did_action( 'init' ) ) {
903 wp_enqueue_style( 'wp-mediaelement' );
904 wp_enqueue_script( 'wp-mediaelement' );
908 'class' => apply_filters( 'wp_audio_shortcode_class', 'wp-audio-shortcode' ),
909 'id' => sprintf( 'audio-%d-%d', $post_id, $instances ),
911 'autoplay' => $autoplay,
912 'preload' => $preload,
913 'style' => 'width: 100%',
916 // These ones should just be omitted altogether if they are blank
917 foreach ( array( 'loop', 'autoplay', 'preload' ) as $a ) {
918 if ( empty( $atts[$a] ) )
922 $attr_strings = array();
923 foreach ( $atts as $k => $v ) {
924 $attr_strings[] = $k . '="' . esc_attr( $v ) . '"';
928 if ( 'mediaelement' === $library && 1 === $instances )
929 $html .= "<!--[if lt IE 9]><script>document.createElement('audio');</script><![endif]-->\n";
930 $html .= sprintf( '<audio %s controls="controls">', join( ' ', $attr_strings ) );
933 $source = '<source type="%s" src="%s" />';
934 foreach ( $default_types as $fallback ) {
935 if ( ! empty( $$fallback ) ) {
936 if ( empty( $fileurl ) )
937 $fileurl = $$fallback;
938 $type = wp_check_filetype( $$fallback, wp_get_mime_types() );
939 $html .= sprintf( $source, $type['type'], esc_url( $$fallback ) );
943 if ( 'mediaelement' === $library )
944 $html .= wp_mediaelement_fallback( $fileurl );
947 return apply_filters( 'wp_audio_shortcode', $html, $atts, $audio, $post_id, $library );
949 add_shortcode( 'audio', apply_filters( 'wp_audio_shortcode_handler', 'wp_audio_shortcode' ) );
952 * Return a filtered list of WP-supported video formats
957 function wp_get_video_extensions() {
958 return apply_filters( 'wp_video_extensions', array( 'mp4', 'm4v', 'webm', 'ogv', 'wmv', 'flv' ) );
962 * The Video shortcode.
964 * This implements the functionality of the Video Shortcode for displaying
965 * WordPress mp4s in a post.
969 * @param array $attr Attributes of the shortcode.
970 * @return string HTML content to display video.
972 function wp_video_shortcode( $attr ) {
973 global $content_width;
974 $post_id = get_post() ? get_the_ID() : 0;
976 static $instances = 0;
981 $default_types = wp_get_video_extensions();
982 $defaults_atts = array(
987 'preload' => 'metadata',
989 'width' => empty( $content_width ) ? 640 : $content_width,
992 foreach ( $default_types as $type )
993 $defaults_atts[$type] = '';
995 $atts = shortcode_atts( $defaults_atts, $attr, 'video' );
1000 if ( is_admin() && $width > 600 )
1002 elseif ( ! is_admin() && $w > $defaults_atts['width'] )
1003 $w = $defaults_atts['width'];
1006 $height = round( ( $h * $w ) / $width );
1011 if ( ! empty( $src ) ) {
1012 $type = wp_check_filetype( $src, wp_get_mime_types() );
1013 if ( ! in_array( $type['ext'], $default_types ) )
1014 return sprintf( '<a class="wp-embedded-video" href="%s">%s</a>', esc_url( $src ), esc_html( $src ) );
1016 array_unshift( $default_types, 'src' );
1018 foreach ( $default_types as $ext ) {
1019 if ( ! empty( $$ext ) ) {
1020 $type = wp_check_filetype( $$ext, wp_get_mime_types() );
1021 if ( $type['ext'] === $ext )
1028 $videos = get_attached_media( 'video', $post_id );
1029 if ( empty( $videos ) )
1032 $video = reset( $videos );
1033 $src = wp_get_attachment_url( $video->ID );
1034 if ( empty( $src ) )
1037 array_unshift( $default_types, 'src' );
1040 $library = apply_filters( 'wp_video_shortcode_library', 'mediaelement' );
1041 if ( 'mediaelement' === $library && did_action( 'init' ) ) {
1042 wp_enqueue_style( 'wp-mediaelement' );
1043 wp_enqueue_script( 'wp-mediaelement' );
1047 'class' => apply_filters( 'wp_video_shortcode_class', 'wp-video-shortcode' ),
1048 'id' => sprintf( 'video-%d-%d', $post_id, $instances ),
1049 'width' => absint( $width ),
1050 'height' => absint( $height ),
1051 'poster' => esc_url( $poster ),
1053 'autoplay' => $autoplay,
1054 'preload' => $preload,
1057 // These ones should just be omitted altogether if they are blank
1058 foreach ( array( 'poster', 'loop', 'autoplay', 'preload' ) as $a ) {
1059 if ( empty( $atts[$a] ) )
1063 $attr_strings = array();
1064 foreach ( $atts as $k => $v ) {
1065 $attr_strings[] = $k . '="' . esc_attr( $v ) . '"';
1069 if ( 'mediaelement' === $library && 1 === $instances )
1070 $html .= "<!--[if lt IE 9]><script>document.createElement('video');</script><![endif]-->\n";
1071 $html .= sprintf( '<video %s controls="controls">', join( ' ', $attr_strings ) );
1074 $source = '<source type="%s" src="%s" />';
1075 foreach ( $default_types as $fallback ) {
1076 if ( ! empty( $$fallback ) ) {
1077 if ( empty( $fileurl ) )
1078 $fileurl = $$fallback;
1079 $type = wp_check_filetype( $$fallback, wp_get_mime_types() );
1080 // m4v sometimes shows up as video/mpeg which collides with mp4
1081 if ( 'm4v' === $type['ext'] )
1082 $type['type'] = 'video/m4v';
1083 $html .= sprintf( $source, $type['type'], esc_url( $$fallback ) );
1086 if ( 'mediaelement' === $library )
1087 $html .= wp_mediaelement_fallback( $fileurl );
1088 $html .= '</video>';
1090 $html = sprintf( '<div style="width: %dpx; max-width: 100%%;">%s</div>', $width, $html );
1091 return apply_filters( 'wp_video_shortcode', $html, $atts, $video, $post_id, $library );
1093 add_shortcode( 'video', apply_filters( 'wp_video_shortcode_handler', 'wp_video_shortcode' ) );
1096 * Display previous image link that has the same post parent.
1099 * @param string $size Optional, default is 'thumbnail'. Size of image, either array or string. 0 or 'none' will default to post_title or $text;
1100 * @param string $text Optional, default is false. If included, link will reflect $text variable.
1101 * @return string HTML content.
1103 function previous_image_link($size = 'thumbnail', $text = false) {
1104 adjacent_image_link(true, $size, $text);
1108 * Display next image link that has the same post parent.
1111 * @param string $size Optional, default is 'thumbnail'. Size of image, either array or string. 0 or 'none' will default to post_title or $text;
1112 * @param string $text Optional, default is false. If included, link will reflect $text variable.
1113 * @return string HTML content.
1115 function next_image_link($size = 'thumbnail', $text = false) {
1116 adjacent_image_link(false, $size, $text);
1120 * Display next or previous image link that has the same post parent.
1122 * Retrieves the current attachment object from the $post global.
1126 * @param bool $prev Optional. Default is true to display previous link, false for next.
1128 function adjacent_image_link($prev = true, $size = 'thumbnail', $text = false) {
1130 $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' ) ) );
1132 foreach ( $attachments as $k => $attachment )
1133 if ( $attachment->ID == $post->ID )
1136 $k = $prev ? $k - 1 : $k + 1;
1138 $output = $attachment_id = null;
1139 if ( isset( $attachments[ $k ] ) ) {
1140 $attachment_id = $attachments[ $k ]->ID;
1141 $output = wp_get_attachment_link( $attachment_id, $size, true, false, $text );
1144 $adjacent = $prev ? 'previous' : 'next';
1145 echo apply_filters( "{$adjacent}_image_link", $output, $attachment_id, $size, $text );
1149 * Retrieve taxonomies attached to the attachment.
1153 * @param int|array|object $attachment Attachment ID, Attachment data array, or Attachment data object.
1154 * @return array Empty array on failure. List of taxonomies on success.
1156 function get_attachment_taxonomies($attachment) {
1157 if ( is_int( $attachment ) )
1158 $attachment = get_post($attachment);
1159 else if ( is_array($attachment) )
1160 $attachment = (object) $attachment;
1162 if ( ! is_object($attachment) )
1165 $filename = basename($attachment->guid);
1167 $objects = array('attachment');
1169 if ( false !== strpos($filename, '.') )
1170 $objects[] = 'attachment:' . substr($filename, strrpos($filename, '.') + 1);
1171 if ( !empty($attachment->post_mime_type) ) {
1172 $objects[] = 'attachment:' . $attachment->post_mime_type;
1173 if ( false !== strpos($attachment->post_mime_type, '/') )
1174 foreach ( explode('/', $attachment->post_mime_type) as $token )
1175 if ( !empty($token) )
1176 $objects[] = "attachment:$token";
1179 $taxonomies = array();
1180 foreach ( $objects as $object )
1181 if ( $taxes = get_object_taxonomies($object) )
1182 $taxonomies = array_merge($taxonomies, $taxes);
1184 return array_unique($taxonomies);
1188 * Return all of the taxonomy names that are registered for attachments.
1190 * Handles mime-type-specific taxonomies such as attachment:image and attachment:video.
1193 * @see get_attachment_taxonomies()
1194 * @uses get_taxonomies()
1196 * @param string $output The type of output to return, either taxonomy 'names' or 'objects'. 'names' is the default.
1197 * @return array The names of all taxonomy of $object_type.
1199 function get_taxonomies_for_attachments( $output = 'names' ) {
1200 $taxonomies = array();
1201 foreach ( get_taxonomies( array(), 'objects' ) as $taxonomy ) {
1202 foreach ( $taxonomy->object_type as $object_type ) {
1203 if ( 'attachment' == $object_type || 0 === strpos( $object_type, 'attachment:' ) ) {
1204 if ( 'names' == $output )
1205 $taxonomies[] = $taxonomy->name;
1207 $taxonomies[ $taxonomy->name ] = $taxonomy;
1217 * Create new GD image resource with transparency support
1218 * @TODO: Deprecate if possible.
1222 * @param int $width Image width
1223 * @param int $height Image height
1224 * @return image resource
1226 function wp_imagecreatetruecolor($width, $height) {
1227 $img = imagecreatetruecolor($width, $height);
1228 if ( is_resource($img) && function_exists('imagealphablending') && function_exists('imagesavealpha') ) {
1229 imagealphablending($img, false);
1230 imagesavealpha($img, true);
1236 * Register an embed handler. This function should probably only be used for sites that do not support oEmbed.
1239 * @see WP_Embed::register_handler()
1241 function wp_embed_register_handler( $id, $regex, $callback, $priority = 10 ) {
1243 $wp_embed->register_handler( $id, $regex, $callback, $priority );
1247 * Unregister a previously registered embed handler.
1250 * @see WP_Embed::unregister_handler()
1252 function wp_embed_unregister_handler( $id, $priority = 10 ) {
1254 $wp_embed->unregister_handler( $id, $priority );
1258 * Create default array of embed parameters.
1260 * The width defaults to the content width as specified by the theme. If the
1261 * theme does not specify a content width, then 500px is used.
1263 * The default height is 1.5 times the width, or 1000px, whichever is smaller.
1265 * The 'embed_defaults' filter can be used to adjust either of these values.
1269 * @return array Default embed parameters.
1271 function wp_embed_defaults() {
1272 if ( ! empty( $GLOBALS['content_width'] ) )
1273 $width = (int) $GLOBALS['content_width'];
1275 if ( empty( $width ) )
1278 $height = min( ceil( $width * 1.5 ), 1000 );
1280 return apply_filters( 'embed_defaults', compact( 'width', 'height' ) );
1284 * Based on a supplied width/height example, return the biggest possible dimensions based on the max width/height.
1287 * @uses wp_constrain_dimensions() This function passes the widths and the heights.
1289 * @param int $example_width The width of an example embed.
1290 * @param int $example_height The height of an example embed.
1291 * @param int $max_width The maximum allowed width.
1292 * @param int $max_height The maximum allowed height.
1293 * @return array The maximum possible width and height based on the example ratio.
1295 function wp_expand_dimensions( $example_width, $example_height, $max_width, $max_height ) {
1296 $example_width = (int) $example_width;
1297 $example_height = (int) $example_height;
1298 $max_width = (int) $max_width;
1299 $max_height = (int) $max_height;
1301 return wp_constrain_dimensions( $example_width * 1000000, $example_height * 1000000, $max_width, $max_height );
1305 * Attempts to fetch the embed HTML for a provided URL using oEmbed.
1310 * @uses _wp_oembed_get_object()
1311 * @uses WP_oEmbed::get_html()
1313 * @param string $url The URL that should be embedded.
1314 * @param array $args Additional arguments and parameters.
1315 * @return bool|string False on failure or the embed HTML on success.
1317 function wp_oembed_get( $url, $args = '' ) {
1318 require_once( ABSPATH . WPINC . '/class-oembed.php' );
1319 $oembed = _wp_oembed_get_object();
1320 return $oembed->get_html( $url, $args );
1324 * Adds a URL format and oEmbed provider URL pair.
1329 * @uses _wp_oembed_get_object()
1331 * @param string $format The format of URL that this provider can handle. You can use asterisks as wildcards.
1332 * @param string $provider The URL to the oEmbed provider.
1333 * @param boolean $regex Whether the $format parameter is in a regex format.
1335 function wp_oembed_add_provider( $format, $provider, $regex = false ) {
1336 require_once( ABSPATH . WPINC . '/class-oembed.php' );
1337 $oembed = _wp_oembed_get_object();
1338 $oembed->providers[$format] = array( $provider, $regex );
1342 * Removes an oEmbed provider.
1347 * @uses _wp_oembed_get_object()
1349 * @param string $format The URL format for the oEmbed provider to remove.
1351 function wp_oembed_remove_provider( $format ) {
1352 require_once( ABSPATH . WPINC . '/class-oembed.php' );
1354 $oembed = _wp_oembed_get_object();
1356 if ( isset( $oembed->providers[ $format ] ) ) {
1357 unset( $oembed->providers[ $format ] );
1365 * Determines if default embed handlers should be loaded.
1367 * Checks to make sure that the embeds library hasn't already been loaded. If
1368 * it hasn't, then it will load the embeds library.
1372 function wp_maybe_load_embeds() {
1373 if ( ! apply_filters( 'load_default_embeds', true ) )
1375 wp_embed_register_handler( 'googlevideo', '#http://video\.google\.([A-Za-z.]{2,5})/videoplay\?docid=([\d-]+)(.*?)#i', 'wp_embed_handler_googlevideo' );
1376 wp_embed_register_handler( 'audio', '#^https?://.+?\.(' . join( '|', wp_get_audio_extensions() ) . ')$#i', apply_filters( 'wp_audio_embed_handler', 'wp_embed_handler_audio' ), 9999 );
1377 wp_embed_register_handler( 'video', '#^https?://.+?\.(' . join( '|', wp_get_video_extensions() ) . ')$#i', apply_filters( 'wp_video_embed_handler', 'wp_embed_handler_video' ), 9999 );
1381 * The Google Video embed handler callback. Google Video does not support oEmbed.
1383 * @see WP_Embed::register_handler()
1384 * @see WP_Embed::shortcode()
1386 * @param array $matches The regex matches from the provided regex when calling {@link wp_embed_register_handler()}.
1387 * @param array $attr Embed attributes.
1388 * @param string $url The original URL that was matched by the regex.
1389 * @param array $rawattr The original unmodified attributes.
1390 * @return string The embed HTML.
1392 function wp_embed_handler_googlevideo( $matches, $attr, $url, $rawattr ) {
1393 // If the user supplied a fixed width AND height, use it
1394 if ( !empty($rawattr['width']) && !empty($rawattr['height']) ) {
1395 $width = (int) $rawattr['width'];
1396 $height = (int) $rawattr['height'];
1398 list( $width, $height ) = wp_expand_dimensions( 425, 344, $attr['width'], $attr['height'] );
1401 return apply_filters( 'embed_googlevideo', '<embed type="application/x-shockwave-flash" src="http://video.google.com/googleplayer.swf?docid=' . esc_attr($matches[2]) . '&hl=en&fs=true" style="width:' . esc_attr($width) . 'px;height:' . esc_attr($height) . 'px" allowFullScreen="true" allowScriptAccess="always" />', $matches, $attr, $url, $rawattr );
1405 * Audio embed handler callback.
1409 * @param array $matches The regex matches from the provided regex when calling {@link wp_embed_register_handler()}.
1410 * @param array $attr Embed attributes.
1411 * @param string $url The original URL that was matched by the regex.
1412 * @param array $rawattr The original unmodified attributes.
1413 * @return string The embed HTML.
1415 function wp_embed_handler_audio( $matches, $attr, $url, $rawattr ) {
1416 $audio = sprintf( '[audio src="%s" /]', esc_url( $url ) );
1417 return apply_filters( 'wp_embed_handler_audio', $audio, $attr, $url, $rawattr );
1421 * Video embed handler callback.
1425 * @param array $matches The regex matches from the provided regex when calling {@link wp_embed_register_handler()}.
1426 * @param array $attr Embed attributes.
1427 * @param string $url The original URL that was matched by the regex.
1428 * @param array $rawattr The original unmodified attributes.
1429 * @return string The embed HTML.
1431 function wp_embed_handler_video( $matches, $attr, $url, $rawattr ) {
1433 if ( ! empty( $rawattr['width'] ) && ! empty( $rawattr['height'] ) ) {
1434 $dimensions .= sprintf( 'width="%d" ', (int) $rawattr['width'] );
1435 $dimensions .= sprintf( 'height="%d" ', (int) $rawattr['height'] );
1437 $video = sprintf( '[video %s src="%s" /]', $dimensions, esc_url( $url ) );
1438 return apply_filters( 'wp_embed_handler_video', $video, $attr, $url, $rawattr );
1442 * Converts a shorthand byte value to an integer byte value.
1446 * @param string $size A shorthand byte value.
1447 * @return int An integer byte value.
1449 function wp_convert_hr_to_bytes( $size ) {
1450 $size = strtolower( $size );
1451 $bytes = (int) $size;
1452 if ( strpos( $size, 'k' ) !== false )
1453 $bytes = intval( $size ) * 1024;
1454 elseif ( strpos( $size, 'm' ) !== false )
1455 $bytes = intval($size) * 1024 * 1024;
1456 elseif ( strpos( $size, 'g' ) !== false )
1457 $bytes = intval( $size ) * 1024 * 1024 * 1024;
1462 * Determine the maximum upload size allowed in php.ini.
1466 * @return int Allowed upload size.
1468 function wp_max_upload_size() {
1469 $u_bytes = wp_convert_hr_to_bytes( ini_get( 'upload_max_filesize' ) );
1470 $p_bytes = wp_convert_hr_to_bytes( ini_get( 'post_max_size' ) );
1471 $bytes = apply_filters( 'upload_size_limit', min( $u_bytes, $p_bytes ), $u_bytes, $p_bytes );
1476 * Returns a WP_Image_Editor instance and loads file into it.
1481 * @param string $path Path to file to load
1482 * @param array $args Additional data. Accepts { 'mime_type'=>string, 'methods'=>{string, string, ...} }
1483 * @return WP_Image_Editor|WP_Error
1485 function wp_get_image_editor( $path, $args = array() ) {
1486 $args['path'] = $path;
1488 if ( ! isset( $args['mime_type'] ) ) {
1489 $file_info = wp_check_filetype( $args['path'] );
1491 // If $file_info['type'] is false, then we let the editor attempt to
1492 // figure out the file type, rather than forcing a failure based on extension.
1493 if ( isset( $file_info ) && $file_info['type'] )
1494 $args['mime_type'] = $file_info['type'];
1497 $implementation = _wp_image_editor_choose( $args );
1499 if ( $implementation ) {
1500 $editor = new $implementation( $path );
1501 $loaded = $editor->load();
1503 if ( is_wp_error( $loaded ) )
1509 return new WP_Error( 'image_no_editor', __('No editor could be selected.') );
1513 * Tests whether there is an editor that supports a given mime type or methods.
1518 * @param string|array $args Array of requirements. Accepts { 'mime_type'=>string, 'methods'=>{string, string, ...} }
1519 * @return boolean true if an eligible editor is found; false otherwise
1521 function wp_image_editor_supports( $args = array() ) {
1522 return (bool) _wp_image_editor_choose( $args );
1526 * Tests which editors are capable of supporting the request.
1531 * @param array $args Additional data. Accepts { 'mime_type'=>string, 'methods'=>{string, string, ...} }
1532 * @return string|bool Class name for the first editor that claims to support the request. False if no editor claims to support the request.
1534 function _wp_image_editor_choose( $args = array() ) {
1535 require_once ABSPATH . WPINC . '/class-wp-image-editor.php';
1536 require_once ABSPATH . WPINC . '/class-wp-image-editor-gd.php';
1537 require_once ABSPATH . WPINC . '/class-wp-image-editor-imagick.php';
1539 $implementations = apply_filters( 'wp_image_editors',
1540 array( 'WP_Image_Editor_Imagick', 'WP_Image_Editor_GD' ) );
1542 foreach ( $implementations as $implementation ) {
1543 if ( ! call_user_func( array( $implementation, 'test' ), $args ) )
1546 if ( isset( $args['mime_type'] ) &&
1548 array( $implementation, 'supports_mime_type' ),
1549 $args['mime_type'] ) ) {
1553 if ( isset( $args['methods'] ) &&
1554 array_diff( $args['methods'], get_class_methods( $implementation ) ) ) {
1558 return $implementation;
1565 * Prints default plupload arguments.
1569 function wp_plupload_default_settings() {
1572 $data = $wp_scripts->get_data( 'wp-plupload', 'data' );
1573 if ( $data && false !== strpos( $data, '_wpPluploadSettings' ) )
1576 $max_upload_size = wp_max_upload_size();
1579 'runtimes' => 'html5,silverlight,flash,html4',
1580 'file_data_name' => 'async-upload', // key passed to $_FILE.
1581 'multiple_queues' => true,
1582 'max_file_size' => $max_upload_size . 'b',
1583 'url' => admin_url( 'async-upload.php', 'relative' ),
1584 'flash_swf_url' => includes_url( 'js/plupload/plupload.flash.swf' ),
1585 'silverlight_xap_url' => includes_url( 'js/plupload/plupload.silverlight.xap' ),
1586 'filters' => array( array( 'title' => __( 'Allowed Files' ), 'extensions' => '*') ),
1587 'multipart' => true,
1588 'urlstream_upload' => true,
1591 // Multi-file uploading doesn't currently work in iOS Safari,
1592 // single-file allows the built-in camera to be used as source for images
1593 if ( wp_is_mobile() )
1594 $defaults['multi_selection'] = false;
1596 $defaults = apply_filters( 'plupload_default_settings', $defaults );
1599 'action' => 'upload-attachment',
1602 $params = apply_filters( 'plupload_default_params', $params );
1603 $params['_wpnonce'] = wp_create_nonce( 'media-form' );
1604 $defaults['multipart_params'] = $params;
1607 'defaults' => $defaults,
1609 'mobile' => wp_is_mobile(),
1610 'supported' => _device_can_upload(),
1612 'limitExceeded' => is_multisite() && ! is_upload_space_available()
1615 $script = 'var _wpPluploadSettings = ' . json_encode( $settings ) . ';';
1618 $script = "$data\n$script";
1620 $wp_scripts->add_data( 'wp-plupload', 'data', $script );
1622 add_action( 'customize_controls_enqueue_scripts', 'wp_plupload_default_settings' );
1625 * Prepares an attachment post object for JS, where it is expected
1626 * to be JSON-encoded and fit into an Attachment model.
1630 * @param mixed $attachment Attachment ID or object.
1631 * @return array Array of attachment details.
1633 function wp_prepare_attachment_for_js( $attachment ) {
1634 if ( ! $attachment = get_post( $attachment ) )
1637 if ( 'attachment' != $attachment->post_type )
1640 $meta = wp_get_attachment_metadata( $attachment->ID );
1641 if ( false !== strpos( $attachment->post_mime_type, '/' ) )
1642 list( $type, $subtype ) = explode( '/', $attachment->post_mime_type );
1644 list( $type, $subtype ) = array( $attachment->post_mime_type, '' );
1646 $attachment_url = wp_get_attachment_url( $attachment->ID );
1649 'id' => $attachment->ID,
1650 'title' => $attachment->post_title,
1651 'filename' => wp_basename( $attachment->guid ),
1652 'url' => $attachment_url,
1653 'link' => get_attachment_link( $attachment->ID ),
1654 'alt' => get_post_meta( $attachment->ID, '_wp_attachment_image_alt', true ),
1655 'author' => $attachment->post_author,
1656 'description' => $attachment->post_content,
1657 'caption' => $attachment->post_excerpt,
1658 'name' => $attachment->post_name,
1659 'status' => $attachment->post_status,
1660 'uploadedTo' => $attachment->post_parent,
1661 'date' => strtotime( $attachment->post_date_gmt ) * 1000,
1662 'modified' => strtotime( $attachment->post_modified_gmt ) * 1000,
1663 'menuOrder' => $attachment->menu_order,
1664 'mime' => $attachment->post_mime_type,
1666 'subtype' => $subtype,
1667 'icon' => wp_mime_type_icon( $attachment->ID ),
1668 'dateFormatted' => mysql2date( get_option('date_format'), $attachment->post_date ),
1673 'editLink' => false,
1676 if ( current_user_can( 'edit_post', $attachment->ID ) ) {
1677 $response['nonces']['update'] = wp_create_nonce( 'update-post_' . $attachment->ID );
1678 $response['editLink'] = get_edit_post_link( $attachment->ID, 'raw' );
1681 if ( current_user_can( 'delete_post', $attachment->ID ) )
1682 $response['nonces']['delete'] = wp_create_nonce( 'delete-post_' . $attachment->ID );
1684 if ( $meta && 'image' === $type ) {
1686 $possible_sizes = apply_filters( 'image_size_names_choose', array(
1687 'thumbnail' => __('Thumbnail'),
1688 'medium' => __('Medium'),
1689 'large' => __('Large'),
1690 'full' => __('Full Size'),
1692 unset( $possible_sizes['full'] );
1694 // Loop through all potential sizes that may be chosen. Try to do this with some efficiency.
1695 // First: run the image_downsize filter. If it returns something, we can use its data.
1696 // If the filter does not return something, then image_downsize() is just an expensive
1697 // way to check the image metadata, which we do second.
1698 foreach ( $possible_sizes as $size => $label ) {
1699 if ( $downsize = apply_filters( 'image_downsize', false, $attachment->ID, $size ) ) {
1700 if ( ! $downsize[3] )
1702 $sizes[ $size ] = array(
1703 'height' => $downsize[2],
1704 'width' => $downsize[1],
1705 'url' => $downsize[0],
1706 'orientation' => $downsize[2] > $downsize[1] ? 'portrait' : 'landscape',
1708 } elseif ( isset( $meta['sizes'][ $size ] ) ) {
1709 if ( ! isset( $base_url ) )
1710 $base_url = str_replace( wp_basename( $attachment_url ), '', $attachment_url );
1712 // Nothing from the filter, so consult image metadata if we have it.
1713 $size_meta = $meta['sizes'][ $size ];
1715 // We have the actual image size, but might need to further constrain it if content_width is narrower.
1716 // Thumbnail, medium, and full sizes are also checked against the site's height/width options.
1717 list( $width, $height ) = image_constrain_size_for_editor( $size_meta['width'], $size_meta['height'], $size, 'edit' );
1719 $sizes[ $size ] = array(
1720 'height' => $height,
1722 'url' => $base_url . $size_meta['file'],
1723 'orientation' => $height > $width ? 'portrait' : 'landscape',
1728 $sizes['full'] = array( 'url' => $attachment_url );
1730 if ( isset( $meta['height'], $meta['width'] ) ) {
1731 $sizes['full']['height'] = $meta['height'];
1732 $sizes['full']['width'] = $meta['width'];
1733 $sizes['full']['orientation'] = $meta['height'] > $meta['width'] ? 'portrait' : 'landscape';
1736 $response = array_merge( $response, array( 'sizes' => $sizes ), $sizes['full'] );
1737 } elseif ( $meta && 'video' === $type ) {
1738 if ( isset( $meta['width'] ) )
1739 $response['width'] = (int) $meta['width'];
1740 if ( isset( $meta['height'] ) )
1741 $response['height'] = (int) $meta['height'];
1744 if ( $meta && ( 'audio' === $type || 'video' === $type ) ) {
1745 if ( isset( $meta['length_formatted'] ) )
1746 $response['fileLength'] = $meta['length_formatted'];
1749 if ( function_exists('get_compat_media_markup') )
1750 $response['compat'] = get_compat_media_markup( $attachment->ID, array( 'in_modal' => true ) );
1752 return apply_filters( 'wp_prepare_attachment_for_js', $response, $attachment, $meta );
1756 * Enqueues all scripts, styles, settings, and templates necessary to use
1757 * all media JS APIs.
1761 function wp_enqueue_media( $args = array() ) {
1763 // Enqueue me just once per page, please.
1764 if ( did_action( 'wp_enqueue_media' ) )
1770 $args = wp_parse_args( $args, $defaults );
1772 // We're going to pass the old thickbox media tabs to `media_upload_tabs`
1773 // to ensure plugins will work. We will then unset those tabs.
1775 // handler action suffix => tab label
1782 $tabs = apply_filters( 'media_upload_tabs', $tabs );
1783 unset( $tabs['type'], $tabs['type_url'], $tabs['gallery'], $tabs['library'] );
1786 'link' => get_option( 'image_default_link_type' ), // db default is 'file'
1787 'align' => get_option( 'image_default_align' ), // empty default
1788 'size' => get_option( 'image_default_size' ), // empty default
1793 'tabUrl' => add_query_arg( array( 'chromeless' => true ), admin_url('media-upload.php') ),
1794 'mimeTypes' => wp_list_pluck( get_post_mime_types(), 0 ),
1795 'captions' => ! apply_filters( 'disable_captions', '' ),
1797 'sendToEditor' => wp_create_nonce( 'media-send-to-editor' ),
1802 'defaultProps' => $props,
1803 'embedExts' => array_merge( wp_get_audio_extensions(), wp_get_video_extensions() ),
1807 if ( isset( $args['post'] ) ) {
1808 $post = get_post( $args['post'] );
1809 $settings['post'] = array(
1811 'nonce' => wp_create_nonce( 'update-post_' . $post->ID ),
1814 if ( current_theme_supports( 'post-thumbnails', $post->post_type ) && post_type_supports( $post->post_type, 'thumbnail' ) ) {
1815 $featured_image_id = get_post_meta( $post->ID, '_thumbnail_id', true );
1816 $settings['post']['featuredImageId'] = $featured_image_id ? $featured_image_id : -1;
1820 $hier = $post && is_post_type_hierarchical( $post->post_type );
1824 'url' => __( 'URL' ),
1825 'addMedia' => __( 'Add Media' ),
1826 'search' => __( 'Search' ),
1827 'select' => __( 'Select' ),
1828 'cancel' => __( 'Cancel' ),
1829 /* translators: This is a would-be plural string used in the media manager.
1830 If there is not a word you can use in your language to avoid issues with the
1831 lack of plural support here, turn it into "selected: %d" then translate it.
1833 'selected' => __( '%d selected' ),
1834 'dragInfo' => __( 'Drag and drop to reorder images.' ),
1837 'uploadFilesTitle' => __( 'Upload Files' ),
1838 'uploadImagesTitle' => __( 'Upload Images' ),
1841 'mediaLibraryTitle' => __( 'Media Library' ),
1842 'insertMediaTitle' => __( 'Insert Media' ),
1843 'createNewGallery' => __( 'Create a new gallery' ),
1844 'returnToLibrary' => __( '← Return to library' ),
1845 'allMediaItems' => __( 'All media items' ),
1846 'noItemsFound' => __( 'No items found.' ),
1847 'insertIntoPost' => $hier ? __( 'Insert into page' ) : __( 'Insert into post' ),
1848 'uploadedToThisPost' => $hier ? __( 'Uploaded to this page' ) : __( 'Uploaded to this post' ),
1849 'warnDelete' => __( "You are about to permanently delete this item.\n 'Cancel' to stop, 'OK' to delete." ),
1852 'insertFromUrlTitle' => __( 'Insert from URL' ),
1855 'setFeaturedImageTitle' => __( 'Set Featured Image' ),
1856 'setFeaturedImage' => __( 'Set featured image' ),
1859 'createGalleryTitle' => __( 'Create Gallery' ),
1860 'editGalleryTitle' => __( 'Edit Gallery' ),
1861 'cancelGalleryTitle' => __( '← Cancel Gallery' ),
1862 'insertGallery' => __( 'Insert gallery' ),
1863 'updateGallery' => __( 'Update gallery' ),
1864 'addToGallery' => __( 'Add to gallery' ),
1865 'addToGalleryTitle' => __( 'Add to Gallery' ),
1866 'reverseOrder' => __( 'Reverse order' ),
1869 $settings = apply_filters( 'media_view_settings', $settings, $post );
1870 $strings = apply_filters( 'media_view_strings', $strings, $post );
1872 $strings['settings'] = $settings;
1874 wp_localize_script( 'media-views', '_wpMediaViewsL10n', $strings );
1876 wp_enqueue_script( 'media-editor' );
1877 wp_enqueue_style( 'media-views' );
1878 wp_plupload_default_settings();
1880 require_once ABSPATH . WPINC . '/media-template.php';
1881 add_action( 'admin_footer', 'wp_print_media_templates' );
1882 add_action( 'wp_footer', 'wp_print_media_templates' );
1884 do_action( 'wp_enqueue_media' );
1888 * Retrieve media attached to the passed post
1892 * @param string $type (Mime) type of media desired
1893 * @param mixed $post Post ID or object
1894 * @return array Found attachments
1896 function get_attached_media( $type, $post = 0 ) {
1897 if ( ! $post = get_post( $post ) )
1901 'post_parent' => $post->ID,
1902 'post_type' => 'attachment',
1903 'post_mime_type' => $type,
1904 'posts_per_page' => -1,
1905 'orderby' => 'menu_order',
1909 $args = apply_filters( 'get_attached_media_args', $args, $type, $post );
1911 $children = get_children( $args );
1913 return (array) apply_filters( 'get_attached_media', $children, $type, $post );
1917 * Check the content blob for an <audio>, <video> <object>, <embed>, or <iframe>
1921 * @param string $content A string which might contain media data.
1922 * @param array $types array of media types: 'audio', 'video', 'object', 'embed', or 'iframe'
1923 * @return array A list of found HTML media embeds
1925 function get_media_embedded_in_content( $content, $types = null ) {
1927 $allowed_media_types = array( 'audio', 'video', 'object', 'embed', 'iframe' );
1928 if ( ! empty( $types ) ) {
1929 if ( ! is_array( $types ) )
1930 $types = array( $types );
1931 $allowed_media_types = array_intersect( $allowed_media_types, $types );
1934 foreach ( $allowed_media_types as $tag ) {
1935 if ( preg_match( '#' . get_tag_regex( $tag ) . '#', $content, $matches ) ) {
1936 $html[] = $matches[0];
1944 * Retrieve galleries from the passed post's content
1948 * @param mixed $post Optional. Post ID or object.
1949 * @param boolean $html Whether to return HTML or data in the array
1950 * @return array A list of arrays, each containing gallery data and srcs parsed
1951 * from the expanded shortcode
1953 function get_post_galleries( $post, $html = true ) {
1954 if ( ! $post = get_post( $post ) )
1957 if ( ! has_shortcode( $post->post_content, 'gallery' ) )
1960 $galleries = array();
1961 if ( preg_match_all( '/' . get_shortcode_regex() . '/s', $post->post_content, $matches, PREG_SET_ORDER ) ) {
1962 foreach ( $matches as $shortcode ) {
1963 if ( 'gallery' === $shortcode[2] ) {
1967 $gallery = do_shortcode_tag( $shortcode );
1969 $galleries[] = $gallery;
1971 preg_match_all( '#src=([\'"])(.+?)\1#is', $gallery, $src, PREG_SET_ORDER );
1972 if ( ! empty( $src ) ) {
1973 foreach ( $src as $s )
1977 $data = shortcode_parse_atts( $shortcode[3] );
1978 $data['src'] = array_values( array_unique( $srcs ) );
1979 $galleries[] = $data;
1985 return apply_filters( 'get_post_galleries', $galleries, $post );
1989 * Check a specified post's content for gallery and, if present, return the first
1993 * @param mixed $post Optional. Post ID or object.
1994 * @param boolean $html Whether to return HTML or data
1995 * @return string|array Gallery data and srcs parsed from the expanded shortcode
1997 function get_post_gallery( $post = 0, $html = true ) {
1998 $galleries = get_post_galleries( $post, $html );
1999 $gallery = reset( $galleries );
2001 return apply_filters( 'get_post_gallery', $gallery, $post, $galleries );
2005 * Retrieve the image srcs from galleries from a post's content, if present
2009 * @param mixed $post Optional. Post ID or object.
2010 * @return array A list of lists, each containing image srcs parsed
2011 * from an expanded shortcode
2013 function get_post_galleries_images( $post = 0 ) {
2014 $galleries = get_post_galleries( $post, false );
2015 return wp_list_pluck( $galleries, 'src' );
2019 * Check a post's content for galleries and return the image srcs for the first found gallery
2023 * @param mixed $post Optional. Post ID or object.
2024 * @return array A list of a gallery's image srcs in order
2026 function get_post_gallery_images( $post = 0 ) {
2027 $gallery = get_post_gallery( $post, false );
2028 return empty( $gallery['src'] ) ? array() : $gallery['src'];