2008-02-21 07:00:15 +01:00
< ? php
2008-09-01 07:45:41 +02:00
/**
* WordPress API for media display .
*
* @ package WordPress
2012-12-06 08:10:20 +01:00
* @ subpackage Media
2008-09-01 07:45:41 +02:00
*/
2008-02-21 07:00:15 +01:00
2008-09-01 07:45:41 +02:00
/**
* Scale down the default size of an image .
*
* This is so that the image is a better fit for the editor and theme .
*
* The $size parameter accepts either an array or a string . The supported string
* values are 'thumb' or 'thumbnail' for the given thumbnail size or defaults at
* 128 width and 96 height in pixels . Also supported for the string value is
* 'medium' and 'full' . The 'full' isn ' t actually supported , but any value other
* than the supported will result in the content_width size or 500 if that is
* not set .
*
2011-09-30 00:57:43 +02:00
* Finally , there is a filter named 'editor_max_image_size' , that will be called
2008-09-01 07:45:41 +02:00
* on the calculated array for width and height , respectively . The second
* parameter will be the value that was in the $size parameter . The returned
* type for the hook is an array with the width as the first element and the
* height as the second element .
*
* @ since 2.5 . 0
* @ uses wp_constrain_dimensions () This function passes the widths and the heights .
*
* @ param int $width Width of the image
* @ param int $height Height of the image
* @ param string | array $size Size of what the result image should be .
2012-12-06 10:01:11 +01:00
* @ param context Could be 'display' ( like in a theme ) or 'edit' ( like inserting into an editor )
2008-09-01 07:45:41 +02:00
* @ return array Width and height of what the result image should resize to .
*/
2012-12-06 07:25:39 +01:00
function image_constrain_size_for_editor ( $width , $height , $size = 'medium' , $context = null ) {
2009-12-08 22:08:19 +01:00
global $content_width , $_wp_additional_image_sizes ;
2008-03-02 21:17:30 +01:00
2012-12-06 07:25:39 +01:00
if ( ! $context )
$context = is_admin () ? 'edit' : 'display' ;
2008-03-12 09:10:00 +01:00
if ( is_array ( $size ) ) {
$max_width = $size [ 0 ];
$max_height = $size [ 1 ];
}
elseif ( $size == 'thumb' || $size == 'thumbnail' ) {
2008-02-21 07:00:15 +01:00
$max_width = intval ( get_option ( 'thumbnail_size_w' ));
$max_height = intval ( get_option ( 'thumbnail_size_h' ));
// last chance thumbnail size defaults
if ( ! $max_width && ! $max_height ) {
$max_width = 128 ;
$max_height = 96 ;
}
}
elseif ( $size == 'medium' ) {
$max_width = intval ( get_option ( 'medium_size_w' ));
$max_height = intval ( get_option ( 'medium_size_h' ));
// if no width is set, default to the theme content width if available
}
2008-08-11 05:54:26 +02:00
elseif ( $size == 'large' ) {
2011-12-14 00:45:31 +01:00
// We're inserting a large size image into the editor. If it's a really
2008-09-18 08:14:46 +02:00
// big image we'll scale it down to fit reasonably within the editor
2011-12-14 00:45:31 +01:00
// itself, and within the theme's content width if it's known. The user
2008-09-18 08:14:46 +02:00
// can resize it in the editor if they wish.
2008-08-11 05:54:26 +02:00
$max_width = intval ( get_option ( 'large_size_w' ));
$max_height = intval ( get_option ( 'large_size_h' ));
if ( intval ( $content_width ) > 0 )
$max_width = min ( intval ( $content_width ), $max_width );
2009-12-08 22:08:19 +01:00
} elseif ( isset ( $_wp_additional_image_sizes ) && count ( $_wp_additional_image_sizes ) && in_array ( $size , array_keys ( $_wp_additional_image_sizes ) ) ) {
$max_width = intval ( $_wp_additional_image_sizes [ $size ][ 'width' ] );
$max_height = intval ( $_wp_additional_image_sizes [ $size ][ 'height' ] );
2012-12-06 07:25:39 +01:00
if ( intval ( $content_width ) > 0 && 'edit' == $context ) // Only in admin. Assume that theme authors know what they're doing.
2010-02-14 07:34:47 +01:00
$max_width = min ( intval ( $content_width ), $max_width );
2008-08-11 05:54:26 +02:00
}
// $size == 'full' has no constraint
else {
$max_width = $width ;
$max_height = $height ;
2008-02-21 07:00:15 +01:00
}
2012-12-06 07:25:39 +01:00
list ( $max_width , $max_height ) = apply_filters ( 'editor_max_image_size' , array ( $max_width , $max_height ), $size , $context );
2008-12-09 19:03:31 +01:00
2008-02-21 07:00:15 +01:00
return wp_constrain_dimensions ( $width , $height , $max_width , $max_height );
}
2008-09-01 07:45:41 +02:00
/**
* Retrieve width and height attributes using given width and height values .
*
* Both attributes are required in the sense that both parameters must have a
* value , but are optional in that if you set them to false or null , then they
* will not be added to the returned string .
*
* You can set the value using a string , but it will only take numeric values .
* If you wish to put 'px' after the numbers , then it will be stripped out of
* the return .
*
* @ since 2.5 . 0
*
* @ param int | string $width Optional . Width attribute value .
* @ param int | string $height Optional . Height attribute value .
* @ return string HTML attributes for width and , or height .
*/
2008-02-21 07:00:15 +01:00
function image_hwstring ( $width , $height ) {
$out = '' ;
if ( $width )
$out .= 'width="' . intval ( $width ) . '" ' ;
if ( $height )
$out .= 'height="' . intval ( $height ) . '" ' ;
return $out ;
}
2008-09-01 07:45:41 +02:00
/**
* Scale an image to fit a particular size ( such as 'thumb' or 'medium' ) .
*
* Array with image url , width , height , and whether is intermediate size , in
* that order is returned on success is returned . $is_intermediate is true if
* $url is a resized image , false if it is the original .
*
* The URL might be the original image , or it might be a resized version . This
* function won ' t create a new resized copy , it will just return an already
* resized one if it exists .
*
2008-09-18 08:14:46 +02:00
* A plugin may use the 'image_downsize' filter to hook into and offer image
* resizing services for images . The hook must return an array with the same
* elements that are returned in the function . The first element being the URL
* to the new image that was resized .
*
2008-09-01 07:45:41 +02:00
* @ since 2.5 . 0
* @ uses apply_filters () Calls 'image_downsize' on $id and $size to provide
2008-09-18 08:14:46 +02:00
* resize services .
2008-09-01 07:45:41 +02:00
*
* @ param int $id Attachment ID for image .
2011-03-23 19:46:38 +01:00
* @ param array | string $size Optional , default is 'medium' . Size of image , either array or string .
2008-09-01 07:45:41 +02:00
* @ return bool | array False on failure , array on success .
*/
2008-02-21 07:00:15 +01:00
function image_downsize ( $id , $size = 'medium' ) {
2008-03-02 21:17:30 +01:00
2008-03-10 22:31:33 +01:00
if ( ! wp_attachment_is_image ( $id ) )
return false ;
2013-02-14 05:30:55 +01:00
// plugins can use this to provide resize services
if ( $out = apply_filters ( 'image_downsize' , false , $id , $size ) )
return $out ;
2008-02-21 07:00:15 +01:00
$img_url = wp_get_attachment_url ( $id );
$meta = wp_get_attachment_metadata ( $id );
$width = $height = 0 ;
2008-08-11 05:54:26 +02:00
$is_intermediate = false ;
2010-11-02 18:19:55 +01:00
$img_url_basename = wp_basename ( $img_url );
2008-03-02 21:17:30 +01:00
2008-03-03 05:17:37 +01:00
// try for a new style intermediate size
if ( $intermediate = image_get_intermediate_size ( $id , $size ) ) {
2010-11-02 18:19:55 +01:00
$img_url = str_replace ( $img_url_basename , $intermediate [ 'file' ], $img_url );
2008-03-03 05:17:37 +01:00
$width = $intermediate [ 'width' ];
$height = $intermediate [ 'height' ];
2008-08-11 05:54:26 +02:00
$is_intermediate = true ;
2008-03-03 05:17:37 +01:00
}
elseif ( $size == 'thumbnail' ) {
// fall back to the old thumbnail
2008-07-04 18:15:29 +02:00
if ( ( $thumb_file = wp_get_attachment_thumb_file ( $id )) && $info = getimagesize ( $thumb_file ) ) {
2010-11-02 18:19:55 +01:00
$img_url = str_replace ( $img_url_basename , wp_basename ( $thumb_file ), $img_url );
2008-03-03 05:17:37 +01:00
$width = $info [ 0 ];
$height = $info [ 1 ];
2008-08-11 05:54:26 +02:00
$is_intermediate = true ;
2008-02-21 07:00:15 +01:00
}
}
2013-03-29 21:51:35 +01:00
if ( ! $width && ! $height && isset ( $meta [ 'width' ], $meta [ 'height' ] ) ) {
2008-08-11 05:54:26 +02:00
// any other type: use the real image
$width = $meta [ 'width' ];
$height = $meta [ 'height' ];
2008-02-21 07:00:15 +01:00
}
2008-12-09 19:03:31 +01:00
2008-08-11 05:54:26 +02:00
if ( $img_url ) {
// we have the actual image size, but might need to further constrain it if content_width is narrower
list ( $width , $height ) = image_constrain_size_for_editor ( $width , $height , $size );
2008-03-02 21:17:30 +01:00
2008-08-11 05:54:26 +02:00
return array ( $img_url , $width , $height , $is_intermediate );
}
2008-03-13 00:15:31 +01:00
return false ;
2008-03-02 21:17:30 +01:00
2008-02-21 07:00:15 +01:00
}
2009-12-08 22:08:19 +01:00
/**
* Registers a new image size
2011-09-30 00:57:43 +02:00
*
* @ since 2.9 . 0
2009-12-08 22:08:19 +01:00
*/
2010-10-27 02:33:29 +02:00
function add_image_size ( $name , $width = 0 , $height = 0 , $crop = false ) {
2009-12-08 22:08:19 +01:00
global $_wp_additional_image_sizes ;
2010-10-27 02:33:29 +02:00
$_wp_additional_image_sizes [ $name ] = array ( 'width' => absint ( $width ), 'height' => absint ( $height ), 'crop' => ( bool ) $crop );
2009-12-08 22:08:19 +01:00
}
/**
2009-12-10 07:14:36 +01:00
* Registers an image size for the post thumbnail
2011-09-30 00:57:43 +02:00
*
* @ since 2.9 . 0
2009-12-08 22:08:19 +01:00
*/
2010-10-27 02:33:29 +02:00
function set_post_thumbnail_size ( $width = 0 , $height = 0 , $crop = false ) {
2009-12-10 07:14:36 +01:00
add_image_size ( 'post-thumbnail' , $width , $height , $crop );
2009-12-08 22:08:19 +01:00
}
2008-05-31 21:12:55 +02:00
/**
* An < img src /> tag for an image attachment , scaling it down if requested .
*
2008-09-18 08:14:46 +02:00
* The filter 'get_image_tag_class' allows for changing the class name for the
* image without having to use regular expressions on the HTML content . The
* parameters are : what WordPress will use for the class , the Attachment ID ,
* image align value , and the size the image should be .
*
* The second filter 'get_image_tag' has the HTML content , which can then be
* further manipulated by a plugin to change all attribute values and even HTML
* content .
2008-05-31 21:12:55 +02:00
*
2008-09-01 07:45:41 +02:00
* @ since 2.5 . 0
*
2008-05-31 21:12:55 +02:00
* @ uses apply_filters () The 'get_image_tag_class' filter is the IMG element
* class attribute .
* @ uses apply_filters () The 'get_image_tag' filter is the full IMG element with
* all attributes .
*
* @ param int $id Attachment ID .
* @ param string $alt Image Description for the alt attribute .
* @ param string $title Image Description for the title attribute .
* @ param string $align Part of the class name for aligning the image .
* @ param string $size Optional . Default is 'medium' .
* @ return string HTML IMG element for given image attachment
*/
2008-03-22 00:21:27 +01:00
function get_image_tag ( $id , $alt , $title , $align , $size = 'medium' ) {
2008-02-21 07:00:15 +01:00
list ( $img_src , $width , $height ) = image_downsize ( $id , $size );
$hwstring = image_hwstring ( $width , $height );
2012-11-21 12:50:30 +01:00
$title = $title ? 'title="' . esc_attr ( $title ) . '" ' : '' ;
2009-05-05 21:43:53 +02:00
$class = 'align' . esc_attr ( $align ) . ' size-' . esc_attr ( $size ) . ' wp-image-' . $id ;
2008-05-31 21:12:55 +02:00
$class = apply_filters ( 'get_image_tag_class' , $class , $id , $align , $size );
2012-11-21 12:50:30 +01:00
$html = '<img src="' . esc_attr ( $img_src ) . '" alt="' . esc_attr ( $alt ) . '" ' . $title . $hwstring . 'class="' . $class . '" />' ;
2008-02-21 07:00:15 +01:00
2008-04-25 19:58:38 +02:00
$html = apply_filters ( 'get_image_tag' , $html , $id , $alt , $title , $align , $size );
2008-02-21 07:00:15 +01:00
return $html ;
}
2008-09-18 08:14:46 +02:00
/**
2011-09-05 21:08:15 +02:00
* Calculates the new dimensions for a downsampled image .
2008-09-18 08:14:46 +02:00
*
2010-01-25 19:50:01 +01:00
* If either width or height are empty , no constraint is applied on
2008-09-18 08:14:46 +02:00
* that dimension .
*
* @ since 2.5 . 0
*
* @ param int $current_width Current width of the image .
* @ param int $current_height Current height of the image .
* @ param int $max_width Optional . Maximum wanted width .
* @ param int $max_height Optional . Maximum wanted height .
* @ return array First item is the width , the second item is the height .
*/
2008-02-26 19:46:03 +01:00
function wp_constrain_dimensions ( $current_width , $current_height , $max_width = 0 , $max_height = 0 ) {
if ( ! $max_width and ! $max_height )
return array ( $current_width , $current_height );
2008-03-02 21:17:30 +01:00
2008-02-26 19:46:03 +01:00
$width_ratio = $height_ratio = 1.0 ;
2010-05-27 22:41:36 +02:00
$did_width = $did_height = false ;
2008-03-02 21:17:30 +01:00
2010-05-27 22:37:42 +02:00
if ( $max_width > 0 && $current_width > 0 && $current_width > $max_width ) {
2008-02-26 19:46:03 +01:00
$width_ratio = $max_width / $current_width ;
2010-05-27 22:37:42 +02:00
$did_width = true ;
}
2008-03-02 21:17:30 +01:00
2010-05-27 22:37:42 +02:00
if ( $max_height > 0 && $current_height > 0 && $current_height > $max_height ) {
2008-02-26 19:46:03 +01:00
$height_ratio = $max_height / $current_height ;
2010-05-27 22:37:42 +02:00
$did_height = true ;
}
2008-03-02 21:17:30 +01:00
2010-05-27 22:37:42 +02:00
// Calculate the larger/smaller ratios
$smaller_ratio = min ( $width_ratio , $height_ratio );
$larger_ratio = max ( $width_ratio , $height_ratio );
if ( intval ( $current_width * $larger_ratio ) > $max_width || intval ( $current_height * $larger_ratio ) > $max_height )
// The larger ratio is too big. It would result in an overflow.
$ratio = $smaller_ratio ;
else
// The larger ratio fits, and is likely to be a more "snug" fit.
$ratio = $larger_ratio ;
$w = intval ( $current_width * $ratio );
$h = intval ( $current_height * $ratio );
// Sometimes, due to rounding, we'll end up with a result like this: 465x700 in a 177x177 box is 117x176... a pixel short
2011-09-05 21:08:15 +02:00
// 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.
2010-05-27 22:37:42 +02:00
// Thus we look for dimensions that are one pixel shy of the max value and bump them up
2010-05-27 22:41:36 +02:00
if ( $did_width && $w == $max_width - 1 )
2010-05-27 22:37:42 +02:00
$w = $max_width ; // Round it up
2010-05-27 22:41:36 +02:00
if ( $did_height && $h == $max_height - 1 )
2010-05-27 22:37:42 +02:00
$h = $max_height ; // Round it up
return array ( $w , $h );
2008-02-26 19:46:03 +01:00
}
2008-09-18 08:14:46 +02:00
/**
2012-12-04 20:42:28 +01:00
* Retrieve calculated resized dimensions for use in WP_Image_Editor .
2008-09-18 08:14:46 +02:00
*
* Calculate dimensions and coordinates for a resized image that fits within a
* specified width and height . If $crop is true , the largest matching central
* portion of the image will be cropped out and resized to the required size .
*
* @ since 2.5 . 0
2012-05-02 22:15:44 +02:00
* @ uses apply_filters () Calls 'image_resize_dimensions' on $orig_w , $orig_h , $dest_w , $dest_h and
* $crop to provide custom resize dimensions .
2008-09-18 08:14:46 +02:00
*
* @ param int $orig_w Original width .
* @ param int $orig_h Original height .
* @ param int $dest_w New width .
* @ param int $dest_h New height .
* @ param bool $crop Optional , default is false . Whether to crop image or resize .
2011-09-30 00:57:43 +02:00
* @ return bool | array False on failure . Returned array matches parameters for imagecopyresampled () PHP function .
2008-09-18 08:14:46 +02:00
*/
2009-11-26 07:58:21 +01:00
function image_resize_dimensions ( $orig_w , $orig_h , $dest_w , $dest_h , $crop = false ) {
2008-03-02 21:17:30 +01:00
2008-02-26 19:46:03 +01:00
if ( $orig_w <= 0 || $orig_h <= 0 )
return false ;
// at least one of dest_w or dest_h must be specific
if ( $dest_w <= 0 && $dest_h <= 0 )
return false ;
2008-03-02 21:17:30 +01:00
2012-05-02 22:15:44 +02:00
// plugins can use this to provide custom resize dimensions
$output = apply_filters ( 'image_resize_dimensions' , null , $orig_w , $orig_h , $dest_w , $dest_h , $crop );
if ( null !== $output )
return $output ;
2008-02-26 19:46:03 +01:00
if ( $crop ) {
// crop the largest possible portion of the original image that we can size to $dest_w x $dest_h
$aspect_ratio = $orig_w / $orig_h ;
$new_w = min ( $dest_w , $orig_w );
$new_h = min ( $dest_h , $orig_h );
2009-11-26 07:58:21 +01:00
if ( ! $new_w ) {
2008-02-26 19:46:03 +01:00
$new_w = intval ( $new_h * $aspect_ratio );
}
2009-11-26 07:58:21 +01:00
if ( ! $new_h ) {
2008-02-26 19:46:03 +01:00
$new_h = intval ( $new_w / $aspect_ratio );
}
$size_ratio = max ( $new_w / $orig_w , $new_h / $orig_h );
2008-03-02 21:17:30 +01:00
2009-11-26 07:58:21 +01:00
$crop_w = round ( $new_w / $size_ratio );
$crop_h = round ( $new_h / $size_ratio );
2008-02-26 19:46:03 +01:00
2009-11-26 07:58:21 +01:00
$s_x = floor ( ( $orig_w - $crop_w ) / 2 );
$s_y = floor ( ( $orig_h - $crop_h ) / 2 );
} else {
2008-02-26 19:46:03 +01:00
// don't crop, just resize using $dest_w x $dest_h as a maximum bounding box
$crop_w = $orig_w ;
$crop_h = $orig_h ;
2008-03-02 21:17:30 +01:00
2008-02-26 19:46:03 +01:00
$s_x = 0 ;
$s_y = 0 ;
2008-03-02 21:17:30 +01:00
2008-02-26 19:46:03 +01:00
list ( $new_w , $new_h ) = wp_constrain_dimensions ( $orig_w , $orig_h , $dest_w , $dest_h );
}
2008-03-02 21:17:30 +01:00
2008-02-26 19:46:03 +01:00
// if the resulting image would be the same size or larger we don't want to resize it
2009-11-26 07:58:21 +01:00
if ( $new_w >= $orig_w && $new_h >= $orig_h )
2008-02-26 19:46:03 +01:00
return false ;
// the return array matches the parameters to imagecopyresampled()
// int dst_x, int dst_y, int src_x, int src_y, int dst_w, int dst_h, int src_w, int src_h
2009-12-12 09:06:24 +01:00
return array ( 0 , 0 , ( int ) $s_x , ( int ) $s_y , ( int ) $new_w , ( int ) $new_h , ( int ) $crop_w , ( int ) $crop_h );
2008-02-26 19:46:03 +01:00
}
2008-09-18 08:14:46 +02:00
/**
* Resize an image to make a thumbnail or intermediate size .
*
* The returned array has the file size , the image width , and image height . The
* filter 'image_make_intermediate_size' can be used to hook in and change the
* values of the returned array . The only parameter is the resized file path .
*
* @ since 2.5 . 0
*
* @ param string $file File path .
* @ param int $width Image width .
* @ param int $height Image height .
* @ param bool $crop Optional , default is false . Whether to crop image to specified height and width or resize .
* @ return bool | array False , if no image was created . Metadata array on success .
*/
2012-10-01 22:59:06 +02:00
function image_make_intermediate_size ( $file , $width , $height , $crop = false ) {
2008-03-03 05:17:37 +01:00
if ( $width || $height ) {
2012-11-22 10:52:16 +01:00
$editor = wp_get_image_editor ( $file );
2012-10-01 22:59:06 +02:00
2012-10-13 08:46:17 +02:00
if ( is_wp_error ( $editor ) || is_wp_error ( $editor -> resize ( $width , $height , $crop ) ) )
2012-10-01 22:59:06 +02:00
return false ;
$resized_file = $editor -> save ();
if ( ! is_wp_error ( $resized_file ) && $resized_file ) {
unset ( $resized_file [ 'path' ] );
return $resized_file ;
2008-03-03 05:17:37 +01:00
}
}
return false ;
}
2008-09-18 08:14:46 +02:00
/**
* Retrieve the image ' s intermediate size ( resized ) path , width , and height .
*
* The $size parameter can be an array with the width and height respectively .
* If the size matches the 'sizes' metadata array for width and height , then it
* will be used . If there is no direct match , then the nearest image size larger
* than the specified size will be used . If nothing is found , then the function
* will break out and return false .
2008-12-09 19:03:31 +01:00
*
2008-09-18 08:14:46 +02:00
* The metadata 'sizes' is used for compatible sizes that can be used for the
* parameter $size value .
*
* The url path will be given , when the $size parameter is a string .
*
2010-05-27 07:03:46 +02:00
* If you are passing an array for the $size , you should consider using
* add_image_size () so that a cropped version is generated . It ' s much more
* efficient than having to find the closest - sized image and then having the
* browser scale down the image .
*
2008-09-18 08:14:46 +02:00
* @ since 2.5 . 0
2010-05-27 07:03:46 +02:00
* @ see add_image_size ()
2008-09-18 08:14:46 +02:00
*
* @ param int $post_id Attachment ID for image .
* @ param array | string $size Optional , default is 'thumbnail' . Size of image , either array or string .
* @ return bool | array False on failure or array of file path , width , and height on success .
*/
2008-03-03 05:17:37 +01:00
function image_get_intermediate_size ( $post_id , $size = 'thumbnail' ) {
2008-07-06 18:40:15 +02:00
if ( ! is_array ( $imagedata = wp_get_attachment_metadata ( $post_id ) ) )
2008-03-03 05:17:37 +01:00
return false ;
2008-03-12 09:10:00 +01:00
// get the best one for a specified set of dimensions
if ( is_array ( $size ) && ! empty ( $imagedata [ 'sizes' ]) ) {
foreach ( $imagedata [ 'sizes' ] as $_size => $data ) {
// already cropped to width or height; so use this size
if ( ( $data [ 'width' ] == $size [ 0 ] && $data [ 'height' ] <= $size [ 1 ] ) || ( $data [ 'height' ] == $size [ 1 ] && $data [ 'width' ] <= $size [ 0 ] ) ) {
$file = $data [ 'file' ];
list ( $width , $height ) = image_constrain_size_for_editor ( $data [ 'width' ], $data [ 'height' ], $size );
return compact ( 'file' , 'width' , 'height' );
}
// add to lookup table: area => size
$areas [ $data [ 'width' ] * $data [ 'height' ]] = $_size ;
}
if ( ! $size || ! empty ( $areas ) ) {
// find for the smallest image not smaller than the desired size
ksort ( $areas );
foreach ( $areas as $_size ) {
$data = $imagedata [ 'sizes' ][ $_size ];
if ( $data [ 'width' ] >= $size [ 0 ] || $data [ 'height' ] >= $size [ 1 ] ) {
2010-02-14 09:21:07 +01:00
// Skip images with unexpectedly divergent aspect ratios (crops)
// First, we calculate what size the original image would be if constrained to a box the size of the current image in the loop
$maybe_cropped = image_resize_dimensions ( $imagedata [ 'width' ], $imagedata [ 'height' ], $data [ 'width' ], $data [ 'height' ], false );
2010-05-27 22:37:42 +02:00
// 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
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' ] ) ) )
2010-02-14 09:21:07 +01:00
continue ;
// If we're still here, then we're going to use this size
2008-03-12 09:10:00 +01:00
$file = $data [ 'file' ];
list ( $width , $height ) = image_constrain_size_for_editor ( $data [ 'width' ], $data [ 'height' ], $size );
return compact ( 'file' , 'width' , 'height' );
}
}
}
}
if ( is_array ( $size ) || empty ( $size ) || empty ( $imagedata [ 'sizes' ][ $size ]) )
2008-03-03 05:17:37 +01:00
return false ;
2008-08-09 07:36:14 +02:00
2008-03-13 00:15:31 +01:00
$data = $imagedata [ 'sizes' ][ $size ];
// include the full filesystem path of the intermediate file
if ( empty ( $data [ 'path' ]) && ! empty ( $data [ 'file' ]) ) {
$file_url = wp_get_attachment_url ( $post_id );
$data [ 'path' ] = path_join ( dirname ( $imagedata [ 'file' ]), $data [ 'file' ] );
$data [ 'url' ] = path_join ( dirname ( $file_url ), $data [ 'file' ] );
}
return $data ;
2008-03-03 05:17:37 +01:00
}
2010-01-08 09:51:12 +01:00
/**
* Get the available image sizes
2010-03-26 20:13:36 +01:00
* @ since 3.0 . 0
2010-01-08 09:51:12 +01:00
* @ return array Returns a filtered array of image size strings
*/
function get_intermediate_image_sizes () {
global $_wp_additional_image_sizes ;
$image_sizes = array ( 'thumbnail' , 'medium' , 'large' ); // Standard sizes
if ( isset ( $_wp_additional_image_sizes ) && count ( $_wp_additional_image_sizes ) )
$image_sizes = array_merge ( $image_sizes , array_keys ( $_wp_additional_image_sizes ) );
return apply_filters ( 'intermediate_image_sizes' , $image_sizes );
}
2008-09-18 08:14:46 +02:00
/**
* Retrieve an image to represent an attachment .
*
* A mime icon for files , thumbnail or intermediate size for images .
*
* @ since 2.5 . 0
*
* @ param int $attachment_id Image attachment ID .
* @ param string $size Optional , default is 'thumbnail' .
* @ param bool $icon Optional , default is false . Whether it is an icon .
* @ return bool | array Returns an array ( url , width , height ), or false , if no image is available .
*/
2008-03-12 09:10:00 +01:00
function wp_get_attachment_image_src ( $attachment_id , $size = 'thumbnail' , $icon = false ) {
2008-08-09 07:36:14 +02:00
2008-03-04 05:21:37 +01:00
// get a thumbnail or intermediate image if there is one
2008-03-10 22:31:33 +01:00
if ( $image = image_downsize ( $attachment_id , $size ) )
return $image ;
2009-06-06 17:02:55 +02:00
$src = false ;
2008-03-12 09:10:00 +01:00
if ( $icon && $src = wp_mime_type_icon ( $attachment_id ) ) {
2008-11-14 19:32:10 +01:00
$icon_dir = apply_filters ( 'icon_dir' , ABSPATH . WPINC . '/images/crystal' );
2010-11-02 18:19:55 +01:00
$src_file = $icon_dir . '/' . wp_basename ( $src );
2008-03-04 05:21:37 +01:00
@ list ( $width , $height ) = getimagesize ( $src_file );
}
if ( $src && $width && $height )
return array ( $src , $width , $height );
return false ;
}
2008-09-18 08:14:46 +02:00
/**
2009-03-08 06:42:17 +01:00
* Get an HTML img element representing an image attachment
2008-09-18 08:14:46 +02:00
*
2010-05-27 07:03:46 +02:00
* While $size will accept an array , it is better to register a size with
* add_image_size () so that a cropped version is generated . It ' s much more
* efficient than having to find the closest - sized image and then having the
* browser scale down the image .
*
* @ see add_image_size ()
2009-03-08 06:42:17 +01:00
* @ uses apply_filters () Calls 'wp_get_attachment_image_attributes' hook on attributes array
* @ uses wp_get_attachment_image_src () Gets attachment file URL and dimensions
2008-09-18 08:14:46 +02:00
* @ since 2.5 . 0
*
* @ param int $attachment_id Image attachment ID .
* @ param string $size Optional , default is 'thumbnail' .
* @ param bool $icon Optional , default is false . Whether it is an icon .
2013-03-15 18:19:10 +01:00
* @ param mixed $attr Optional , attributes for the image markup .
2008-09-18 08:14:46 +02:00
* @ return string HTML img element or empty string on failure .
*/
2009-10-15 14:31:48 +02:00
function wp_get_attachment_image ( $attachment_id , $size = 'thumbnail' , $icon = false , $attr = '' ) {
2008-03-04 05:21:37 +01:00
$html = '' ;
2008-03-12 09:10:00 +01:00
$image = wp_get_attachment_image_src ( $attachment_id , $size , $icon );
2008-03-04 05:21:37 +01:00
if ( $image ) {
list ( $src , $width , $height ) = $image ;
2008-11-26 03:27:37 +01:00
$hwstring = image_hwstring ( $width , $height );
2008-03-12 09:10:00 +01:00
if ( is_array ( $size ) )
$size = join ( 'x' , $size );
2012-08-23 22:01:10 +02:00
$attachment = get_post ( $attachment_id );
2009-10-15 14:31:48 +02:00
$default_attr = array (
2009-03-08 06:42:17 +01:00
'src' => $src ,
'class' => " attachment- $size " ,
2010-04-18 10:52:18 +02:00
'alt' => trim ( strip_tags ( get_post_meta ( $attachment_id , '_wp_attachment_image_alt' , true ) )), // Use Alt field first
2009-10-15 14:31:48 +02:00
);
2010-04-18 10:52:18 +02:00
if ( empty ( $default_attr [ 'alt' ]) )
$default_attr [ 'alt' ] = trim ( strip_tags ( $attachment -> post_excerpt )); // If not, Use the Caption
if ( empty ( $default_attr [ 'alt' ]) )
$default_attr [ 'alt' ] = trim ( strip_tags ( $attachment -> post_title )); // Finally, use the title
2009-10-15 14:31:48 +02:00
$attr = wp_parse_args ( $attr , $default_attr );
2009-03-08 06:42:17 +01:00
$attr = apply_filters ( 'wp_get_attachment_image_attributes' , $attr , $attachment );
2009-05-05 21:43:53 +02:00
$attr = array_map ( 'esc_attr' , $attr );
2009-03-08 06:42:17 +01:00
$html = rtrim ( " <img $hwstring " );
foreach ( $attr as $name => $value ) {
$html .= " $name = " . '"' . $value . '"' ;
}
$html .= ' />' ;
2008-03-04 05:21:37 +01:00
}
2008-08-09 07:36:14 +02:00
2008-03-04 05:21:37 +01:00
return $html ;
}
2008-03-03 05:17:37 +01:00
2009-10-15 16:27:04 +02:00
/**
2011-09-30 00:57:43 +02:00
* Adds a 'wp-post-image' class to post thumbnails
2009-12-10 07:14:36 +01:00
* Uses the begin_fetch_post_thumbnail_html and end_fetch_post_thumbnail_html action hooks to
2011-09-30 00:57:43 +02:00
* dynamically add / remove itself so as to only filter post thumbnails
2009-10-15 22:26:21 +02:00
*
2009-10-15 16:27:04 +02:00
* @ since 2.9 . 0
* @ param array $attr Attributes including src , class , alt , title
* @ return array
*/
2009-12-10 07:14:36 +01:00
function _wp_post_thumbnail_class_filter ( $attr ) {
2009-10-15 16:27:04 +02:00
$attr [ 'class' ] .= ' wp-post-image' ;
return $attr ;
}
/**
2009-12-10 07:14:36 +01:00
* Adds _wp_post_thumbnail_class_filter to the wp_get_attachment_image_attributes filter
2009-10-15 22:26:21 +02:00
*
2009-10-15 16:27:04 +02:00
* @ since 2.9 . 0
*/
2009-12-10 07:14:36 +01:00
function _wp_post_thumbnail_class_filter_add ( $attr ) {
add_filter ( 'wp_get_attachment_image_attributes' , '_wp_post_thumbnail_class_filter' );
2009-10-15 16:27:04 +02:00
}
/**
2009-12-10 07:14:36 +01:00
* Removes _wp_post_thumbnail_class_filter from the wp_get_attachment_image_attributes filter
2009-10-15 22:26:21 +02:00
*
2009-10-15 16:27:04 +02:00
* @ since 2.9 . 0
*/
2009-12-10 07:14:36 +01:00
function _wp_post_thumbnail_class_filter_remove ( $attr ) {
remove_filter ( 'wp_get_attachment_image_attributes' , '_wp_post_thumbnail_class_filter' );
2009-10-15 16:27:04 +02:00
}
2008-07-09 01:37:56 +02:00
add_shortcode ( 'wp_caption' , 'img_caption_shortcode' );
2008-07-11 17:59:14 +02:00
add_shortcode ( 'caption' , 'img_caption_shortcode' );
2008-07-02 20:41:11 +02:00
2008-09-18 08:14:46 +02:00
/**
* The Caption shortcode .
*
* Allows a plugin to replace the content that would otherwise be returned . The
* filter is 'img_caption_shortcode' and passes an empty string , the attr
* parameter and the content parameter values .
*
* The supported attributes for the shortcode are 'id' , 'align' , 'width' , and
* 'caption' .
*
* @ since 2.6 . 0
*
* @ param array $attr Attributes attributed to the shortcode .
* @ param string $content Optional . Shortcode content .
* @ return string
*/
2008-07-09 01:37:56 +02:00
function img_caption_shortcode ( $attr , $content = null ) {
2012-05-02 03:14:52 +02:00
// New-style shortcode with the caption inside the shortcode with the link and image tags.
if ( ! isset ( $attr [ 'caption' ] ) ) {
if ( preg_match ( '#((?:<a [^>]+>\s*)?<img [^>]+>(?:\s*</a>)?)(.*)#is' , $content , $matches ) ) {
$content = $matches [ 1 ];
$attr [ 'caption' ] = trim ( $matches [ 2 ] );
}
}
2008-07-11 17:59:14 +02:00
2008-07-02 20:41:11 +02:00
// Allow plugins/themes to override the default caption template.
2008-07-09 01:37:56 +02:00
$output = apply_filters ( 'img_caption_shortcode' , '' , $attr , $content );
2008-07-02 20:41:11 +02:00
if ( $output != '' )
return $output ;
extract ( shortcode_atts ( array (
'id' => '' ,
'align' => 'alignnone' ,
'width' => '' ,
'caption' => ''
2013-03-06 21:07:40 +01:00
), $attr , 'caption' ));
2008-08-09 07:36:14 +02:00
2008-07-02 20:41:11 +02:00
if ( 1 > ( int ) $width || empty ( $caption ) )
return $content ;
2008-08-09 07:36:14 +02:00
2009-08-18 18:05:07 +02:00
if ( $id ) $id = 'id="' . esc_attr ( $id ) . '" ' ;
2008-08-09 07:36:14 +02:00
2009-08-18 18:05:07 +02:00
return '<div ' . $id . 'class="wp-caption ' . esc_attr ( $align ) . '" style="width: ' . ( 10 + ( int ) $width ) . 'px">'
2009-02-04 18:07:26 +01:00
. do_shortcode ( $content ) . '<p class="wp-caption-text">' . $caption . '</p></div>' ;
2008-07-02 20:41:11 +02:00
}
2008-04-25 02:43:44 +02:00
add_shortcode ( 'gallery' , 'gallery_shortcode' );
2008-03-06 20:48:54 +01:00
2008-09-18 08:14:46 +02:00
/**
* The Gallery shortcode .
*
* This implements the functionality of the Gallery Shortcode for displaying
* WordPress images on a post .
*
* @ since 2.5 . 0
*
2011-09-30 00:57:43 +02:00
* @ param array $attr Attributes of the shortcode .
2008-09-18 08:14:46 +02:00
* @ return string HTML content to display gallery .
*/
2008-03-06 20:48:54 +01:00
function gallery_shortcode ( $attr ) {
2012-09-04 18:29:28 +02:00
$post = get_post ();
2009-05-25 01:47:49 +02:00
2009-05-15 10:52:04 +02:00
static $instance = 0 ;
$instance ++ ;
2008-03-06 20:48:54 +01:00
2012-11-28 04:51:27 +01:00
if ( ! empty ( $attr [ 'ids' ] ) ) {
2012-12-03 06:32:25 +01:00
// 'ids' is explicitly ordered, unless you specify otherwise.
if ( empty ( $attr [ 'orderby' ] ) )
$attr [ 'orderby' ] = 'post__in' ;
2012-11-28 04:51:27 +01:00
$attr [ 'include' ] = $attr [ 'ids' ];
}
2008-03-06 20:48:54 +01:00
// Allow plugins/themes to override the default gallery template.
$output = apply_filters ( 'post_gallery' , '' , $attr );
if ( $output != '' )
return $output ;
2008-04-03 05:05:49 +02:00
// We're trusting author input, so let's at least make sure it looks like a valid orderby statement
if ( isset ( $attr [ 'orderby' ] ) ) {
$attr [ 'orderby' ] = sanitize_sql_orderby ( $attr [ 'orderby' ] );
if ( ! $attr [ 'orderby' ] )
unset ( $attr [ 'orderby' ] );
}
2008-03-24 03:57:19 +01:00
extract ( shortcode_atts ( array (
2008-05-05 17:46:32 +02:00
'order' => 'ASC' ,
'orderby' => 'menu_order ID' ,
2008-03-24 03:57:19 +01:00
'id' => $post -> ID ,
'itemtag' => 'dl' ,
'icontag' => 'dt' ,
'captiontag' => 'dd' ,
'columns' => 3 ,
2009-08-04 09:32:18 +02:00
'size' => 'thumbnail' ,
'include' => '' ,
'exclude' => ''
2013-03-06 21:07:40 +01:00
), $attr , 'gallery' ));
2008-03-24 03:57:19 +01:00
$id = intval ( $id );
2009-08-04 09:32:18 +02:00
if ( 'RAND' == $order )
$orderby = 'none' ;
if ( ! empty ( $include ) ) {
$_attachments = get_posts ( array ( 'include' => $include , 'post_status' => 'inherit' , 'post_type' => 'attachment' , 'post_mime_type' => 'image' , 'order' => $order , 'orderby' => $orderby ) );
$attachments = array ();
foreach ( $_attachments as $key => $val ) {
$attachments [ $val -> ID ] = $_attachments [ $key ];
}
} elseif ( ! empty ( $exclude ) ) {
$attachments = get_children ( array ( 'post_parent' => $id , 'exclude' => $exclude , 'post_status' => 'inherit' , 'post_type' => 'attachment' , 'post_mime_type' => 'image' , 'order' => $order , 'orderby' => $orderby ) );
} else {
$attachments = get_children ( array ( 'post_parent' => $id , 'post_status' => 'inherit' , 'post_type' => 'attachment' , 'post_mime_type' => 'image' , 'order' => $order , 'orderby' => $orderby ) );
}
2008-03-06 20:48:54 +01:00
if ( empty ( $attachments ) )
return '' ;
2008-03-14 20:23:56 +01:00
if ( is_feed () ) {
$output = " \n " ;
2009-05-15 10:52:04 +02:00
foreach ( $attachments as $att_id => $attachment )
$output .= wp_get_attachment_link ( $att_id , $size , true ) . " \n " ;
2008-03-14 20:23:56 +01:00
return $output ;
}
2008-03-24 03:57:19 +01:00
$itemtag = tag_escape ( $itemtag );
$captiontag = tag_escape ( $captiontag );
2013-01-22 16:36:57 +01:00
$icontag = tag_escape ( $icontag );
$valid_tags = wp_kses_allowed_html ( 'post' );
if ( ! isset ( $valid_tags [ $itemtag ] ) )
$itemtag = 'dl' ;
if ( ! isset ( $valid_tags [ $captiontag ] ) )
$captiontag = 'dd' ;
if ( ! isset ( $valid_tags [ $icontag ] ) )
$icontag = 'dt' ;
2008-03-24 03:57:19 +01:00
$columns = intval ( $columns );
2008-03-26 04:34:55 +01:00
$itemwidth = $columns > 0 ? floor ( 100 / $columns ) : 100 ;
2010-05-03 07:49:19 +02:00
$float = is_rtl () ? 'right' : 'left' ;
2010-01-15 23:11:12 +01:00
2009-05-15 10:52:04 +02:00
$selector = " gallery- { $instance } " ;
2008-08-09 07:36:14 +02:00
2010-12-10 20:15:37 +01:00
$gallery_style = $gallery_div = '' ;
if ( apply_filters ( 'use_default_gallery_style' , true ) )
$gallery_style = "
2008-03-06 20:48:54 +01:00
< style type = 'text/css' >
2009-05-15 10:52:04 +02:00
#{$selector} {
2008-03-06 20:48:54 +01:00
margin : auto ;
}
2009-05-15 10:52:04 +02:00
#{$selector} .gallery-item {
2009-12-08 13:45:32 +01:00
float : { $float };
2008-03-06 20:48:54 +01:00
margin - top : 10 px ;
text - align : center ;
2010-12-10 20:15:37 +01:00
width : { $itemwidth } % ;
}
2009-05-15 10:52:04 +02:00
#{$selector} img {
2008-03-06 20:48:54 +01:00
border : 2 px solid #cfcfcf;
}
2009-05-15 10:52:04 +02:00
#{$selector} .gallery-caption {
2008-03-24 03:57:19 +01:00
margin - left : 0 ;
}
2008-03-06 20:48:54 +01:00
</ style >
2010-12-10 20:15:37 +01:00
<!-- see gallery_shortcode () in wp - includes / media . php --> " ;
$size_class = sanitize_html_class ( $size );
$gallery_div = " <div id=' $selector ' class='gallery galleryid- { $id } gallery-columns- { $columns } gallery-size- { $size_class } '> " ;
$output = apply_filters ( 'gallery_style' , $gallery_style . " \n \t \t " . $gallery_div );
2008-03-06 20:48:54 +01:00
2008-10-22 20:45:09 +02:00
$i = 0 ;
2008-03-06 20:48:54 +01:00
foreach ( $attachments as $id => $attachment ) {
2008-11-26 03:27:37 +01:00
$link = isset ( $attr [ 'link' ]) && 'file' == $attr [ 'link' ] ? wp_get_attachment_link ( $id , $size , false , false ) : wp_get_attachment_link ( $id , $size , true , false );
2013-03-08 17:13:15 +01:00
$image_meta = wp_get_attachment_metadata ( $id );
2013-03-29 21:51:35 +01:00
$orientation = '' ;
if ( isset ( $image_meta [ 'height' ], $image_meta [ 'width' ] ) )
$orientation = ( $image_meta [ 'height' ] > $image_meta [ 'width' ] ) ? 'portrait' : 'landscape' ;
2008-11-23 07:37:15 +01:00
2008-03-24 03:57:19 +01:00
$output .= " < { $itemtag } class='gallery-item'> " ;
2008-03-06 20:48:54 +01:00
$output .= "
2013-03-08 17:13:15 +01:00
< { $icontag } class = 'gallery-icon {$orientation}' >
2008-03-06 20:48:54 +01:00
$link
2008-03-24 03:57:19 +01:00
</ { $icontag } > " ;
if ( $captiontag && trim ( $attachment -> post_excerpt ) ) {
$output .= "
2010-12-10 20:05:50 +01:00
< { $captiontag } class = 'wp-caption-text gallery-caption' >
2009-05-15 01:15:28 +02:00
" . wptexturize( $attachment->post_excerpt ) . "
2008-03-24 03:57:19 +01:00
</ { $captiontag } > " ;
}
$output .= " </ { $itemtag } > " ;
if ( $columns > 0 && ++ $i % $columns == 0 )
2008-03-06 20:48:54 +01:00
$output .= '<br style="clear: both" />' ;
}
$output .= "
2008-03-30 18:41:43 +02:00
< br style = 'clear: both;' />
2008-03-06 20:48:54 +01:00
</ div > \n " ;
return $output ;
}
2013-03-16 06:25:44 +01:00
/**
* Provide a No - JS Flash fallback as a last resort for audio / video
*
* @ since 3.6 . 0
*
* @ param string $url
* @ return string Fallback HTML
*/
function wp_mediaelement_fallback ( $url ) {
return apply_filters ( 'wp_mediaelement_fallback' , sprintf ( '<a href="%1$s">%1$s</a>' , esc_url ( $url ) ), $url );
}
/**
* Return a filtered list of WP - supported audio formats
*
* @ since 3.6 . 0
* @ return array
*/
function wp_get_audio_extensions () {
return apply_filters ( 'wp_audio_extensions' , array ( 'mp3' , 'ogg' , 'wma' , 'm4a' , 'wav' ) );
}
/**
* The Audio shortcode .
*
* This implements the functionality of the Audio Shortcode for displaying
* WordPress mp3s in a post .
*
* @ since 3.6 . 0
*
* @ param array $attr Attributes of the shortcode .
* @ return string HTML content to display audio .
*/
function wp_audio_shortcode ( $attr ) {
$post_id = get_post () ? get_the_ID () : 0 ;
static $instances = 0 ;
$instances ++ ;
$audio = null ;
$default_types = wp_get_audio_extensions ();
$defaults_atts = array ( 'src' => '' );
foreach ( $default_types as $type )
$defaults_atts [ $type ] = '' ;
2013-04-05 19:46:31 +02:00
$atts = shortcode_atts ( $defaults_atts , $attr , 'audio' );
2013-03-16 06:25:44 +01:00
extract ( $atts );
$primary = false ;
if ( ! empty ( $src ) ) {
$type = wp_check_filetype ( $src );
if ( ! in_array ( $type [ 'ext' ], $default_types ) ) {
printf ( '<a class="wp-post-format-link-audio" href="%1$s">%1$s</a>' , $src );
return ;
}
$primary = true ;
array_unshift ( $default_types , 'src' );
} else {
foreach ( $default_types as $ext ) {
if ( ! empty ( $$ext ) ) {
$type = wp_check_filetype ( $$ext );
if ( $type [ 'ext' ] === $ext )
$primary = true ;
}
}
}
if ( ! $primary ) {
2013-03-22 06:20:38 +01:00
$audios = get_attached_audio ( $post_id );
2013-03-16 06:25:44 +01:00
if ( empty ( $audios ) )
return ;
$audio = reset ( $audios );
$src = wp_get_attachment_url ( $audio -> ID );
if ( empty ( $src ) )
return ;
array_unshift ( $default_types , 'src' );
}
$library = apply_filters ( 'wp_audio_shortcode_library' , 'mediaelement' );
2013-03-27 19:34:59 +01:00
if ( 'mediaelement' === $library && did_action ( 'init' ) ) {
2013-03-16 06:25:44 +01:00
wp_enqueue_style ( 'wp-mediaelement' );
wp_enqueue_script ( 'wp-mediaelement' );
}
$atts = array (
sprintf ( 'class="%s"' , apply_filters ( 'wp_audio_shortcode_class' , 'wp-audio-shortcode' ) ),
sprintf ( 'id="audio-%d-%d"' , $post_id , $instances ),
);
$html = sprintf ( '<audio %s controls="controls" preload="none">' , join ( ' ' , $atts ) );
$fileurl = '' ;
$source = '<source type="%s" src="%s" />' ;
foreach ( $default_types as $fallback ) {
if ( ! empty ( $$fallback ) ) {
if ( empty ( $fileurl ) )
$fileurl = $$fallback ;
$type = wp_check_filetype ( $$fallback );
$html .= sprintf ( $source , $type [ 'type' ], $$fallback );
}
}
if ( 'mediaelement' === $library )
$html .= wp_mediaelement_fallback ( $fileurl );
$html .= '</audio>' ;
return apply_filters ( 'wp_audio_shortcode' , $html , $atts , $audio , $post_id );
}
add_shortcode ( 'audio' , apply_filters ( 'wp_audio_shortcode_handler' , 'wp_audio_shortcode' ) );
/**
* Return a filtered list of WP - supported video formats
*
* @ since 3.6 . 0
* @ return array
*/
function wp_get_video_extensions () {
return apply_filters ( 'wp_video_extensions' , array ( 'mp4' , 'm4v' , 'webm' , 'ogv' , 'wmv' , 'flv' ) );
}
/**
* The Video shortcode .
*
* This implements the functionality of the Video Shortcode for displaying
* WordPress mp4s in a post .
*
* @ since 3.6 . 0
*
* @ param array $attr Attributes of the shortcode .
* @ return string HTML content to display video .
*/
function wp_video_shortcode ( $attr ) {
global $content_width ;
$post_id = get_post () ? get_the_ID () : 0 ;
static $instances = 0 ;
$instances ++ ;
$video = null ;
$default_types = wp_get_video_extensions ();
$defaults_atts = array (
'src' => '' ,
'poster' => '' ,
'height' => 360 ,
'width' => empty ( $content_width ) ? 640 : $content_width ,
);
foreach ( $default_types as $type )
$defaults_atts [ $type ] = '' ;
2013-04-05 19:46:31 +02:00
$atts = shortcode_atts ( $defaults_atts , $attr , 'video' );
2013-03-16 06:25:44 +01:00
extract ( $atts );
$primary = false ;
if ( ! empty ( $src ) ) {
$type = wp_check_filetype ( $src );
if ( ! in_array ( $type [ 'ext' ], $default_types ) ) {
printf ( '<a class="wp-post-format-link-video" href="%1$s">%1$s</a>' , $src );
return ;
}
$primary = true ;
array_unshift ( $default_types , 'src' );
} else {
foreach ( $default_types as $ext ) {
if ( ! empty ( $$ext ) ) {
$type = wp_check_filetype ( $$ext );
if ( $type [ 'ext' ] === $ext )
$primary = true ;
}
}
}
if ( ! $primary ) {
2013-03-22 06:20:38 +01:00
$videos = get_attached_video ( $post_id );
2013-03-16 06:25:44 +01:00
if ( empty ( $videos ) )
return ;
$video = reset ( $videos );
$src = wp_get_attachment_url ( $video -> ID );
if ( empty ( $src ) )
return ;
array_unshift ( $default_types , 'src' );
}
$library = apply_filters ( 'wp_video_shortcode_library' , 'mediaelement' );
2013-03-27 19:34:59 +01:00
if ( 'mediaelement' === $library && did_action ( 'init' ) ) {
2013-03-16 06:25:44 +01:00
wp_enqueue_style ( 'wp-mediaelement' );
wp_enqueue_script ( 'wp-mediaelement' );
}
$atts = array (
sprintf ( 'class="%s"' , apply_filters ( 'wp_video_shortcode_class' , 'wp-video-shortcode' ) ),
sprintf ( 'id="video-%d-%d"' , $post_id , $instances ),
sprintf ( 'width="%d"' , $width ),
sprintf ( 'height="%d"' , $height ),
);
if ( ! empty ( $poster ) )
$atts [] = sprintf ( 'poster="%s"' , esc_url ( $poster ) );
$html = sprintf ( '<video %s controls="controls" preload="none">' , join ( ' ' , $atts ) );
$fileurl = '' ;
$source = '<source type="%s" src="%s" />' ;
foreach ( $default_types as $fallback ) {
if ( ! empty ( $$fallback ) ) {
if ( empty ( $fileurl ) )
$fileurl = $$fallback ;
$type = wp_check_filetype ( $$fallback );
// m4v sometimes shows up as video/mpeg which collides with mp4
if ( 'm4v' === $type [ 'ext' ] )
$type [ 'type' ] = 'video/m4v' ;
$html .= sprintf ( $source , $type [ 'type' ], $$fallback );
}
}
if ( 'mediaelement' === $library )
$html .= wp_mediaelement_fallback ( $fileurl , $width , $height );
$html .= '</video>' ;
return apply_filters ( 'wp_video_shortcode' , $html , $atts , $video , $post_id );
}
add_shortcode ( 'video' , apply_filters ( 'wp_video_shortcode_handler' , 'wp_video_shortcode' ) );
2008-09-01 07:45:41 +02:00
/**
* Display previous image link that has the same post parent .
*
* @ since 2.5 . 0
2009-02-04 16:12:24 +01:00
* @ param string $size Optional , default is 'thumbnail' . Size of image , either array or string . 0 or 'none' will default to post_title or $text ;
* @ param string $text Optional , default is false . If included , link will reflect $text variable .
* @ return string HTML content .
2008-09-01 07:45:41 +02:00
*/
2009-02-04 16:12:24 +01:00
function previous_image_link ( $size = 'thumbnail' , $text = false ) {
adjacent_image_link ( true , $size , $text );
2008-03-11 01:09:14 +01:00
}
2008-09-01 07:45:41 +02:00
/**
* Display next image link that has the same post parent .
*
* @ since 2.5 . 0
2009-02-04 16:12:24 +01:00
* @ param string $size Optional , default is 'thumbnail' . Size of image , either array or string . 0 or 'none' will default to post_title or $text ;
* @ param string $text Optional , default is false . If included , link will reflect $text variable .
* @ return string HTML content .
2008-09-01 07:45:41 +02:00
*/
2009-02-04 16:12:24 +01:00
function next_image_link ( $size = 'thumbnail' , $text = false ) {
adjacent_image_link ( false , $size , $text );
2008-03-11 01:09:14 +01:00
}
2008-09-01 07:45:41 +02:00
/**
* Display next or previous image link that has the same post parent .
*
* Retrieves the current attachment object from the $post global .
*
* @ since 2.5 . 0
*
2011-09-30 00:57:43 +02:00
* @ param bool $prev Optional . Default is true to display previous link , false for next .
2008-09-01 07:45:41 +02:00
*/
2009-02-04 16:12:24 +01:00
function adjacent_image_link ( $prev = true , $size = 'thumbnail' , $text = false ) {
2012-09-04 18:29:28 +02:00
$post = get_post ();
$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' ) ) );
2008-03-11 01:09:14 +01:00
foreach ( $attachments as $k => $attachment )
if ( $attachment -> ID == $post -> ID )
break ;
$k = $prev ? $k - 1 : $k + 1 ;
2012-12-09 20:54:23 +01:00
$output = $attachment_id = null ;
if ( isset ( $attachments [ $k ] ) ) {
$attachment_id = $attachments [ $k ] -> ID ;
$output = wp_get_attachment_link ( $attachment_id , $size , true , false , $text );
}
$adjacent = $prev ? 'previous' : 'next' ;
echo apply_filters ( " { $adjacent } _image_link " , $output , $attachment_id , $size , $text );
2008-03-11 01:09:14 +01:00
}
2008-09-18 08:14:46 +02:00
/**
* Retrieve taxonomies attached to the attachment .
*
* @ since 2.5 . 0
*
* @ param int | array | object $attachment Attachment ID , Attachment data array , or Attachment data object .
* @ return array Empty array on failure . List of taxonomies on success .
*/
2008-03-26 07:37:19 +01:00
function get_attachment_taxonomies ( $attachment ) {
if ( is_int ( $attachment ) )
$attachment = get_post ( $attachment );
else if ( is_array ( $attachment ) )
$attachment = ( object ) $attachment ;
if ( ! is_object ( $attachment ) )
return array ();
$filename = basename ( $attachment -> guid );
$objects = array ( 'attachment' );
if ( false !== strpos ( $filename , '.' ) )
$objects [] = 'attachment:' . substr ( $filename , strrpos ( $filename , '.' ) + 1 );
if ( ! empty ( $attachment -> post_mime_type ) ) {
$objects [] = 'attachment:' . $attachment -> post_mime_type ;
if ( false !== strpos ( $attachment -> post_mime_type , '/' ) )
foreach ( explode ( '/' , $attachment -> post_mime_type ) as $token )
if ( ! empty ( $token ) )
$objects [] = " attachment: $token " ;
}
$taxonomies = array ();
foreach ( $objects as $object )
if ( $taxes = get_object_taxonomies ( $object ) )
$taxonomies = array_merge ( $taxonomies , $taxes );
return array_unique ( $taxonomies );
}
2009-09-11 00:07:33 +02:00
2012-09-22 00:52:54 +02:00
/**
* Return all of the taxonomy names that are registered for attachments .
*
* Handles mime - type - specific taxonomies such as attachment : image and attachment : video .
*
* @ since 3.5 . 0
* @ see get_attachment_taxonomies ()
* @ uses get_taxonomies ()
*
* @ param string $output The type of output to return , either taxonomy 'names' or 'objects' . 'names' is the default .
* @ return array The names of all taxonomy of $object_type .
*/
function get_taxonomies_for_attachments ( $output = 'names' ) {
$taxonomies = array ();
foreach ( get_taxonomies ( array (), 'objects' ) as $taxonomy ) {
foreach ( $taxonomy -> object_type as $object_type ) {
if ( 'attachment' == $object_type || 0 === strpos ( $object_type , 'attachment:' ) ) {
if ( 'names' == $output )
$taxonomies [] = $taxonomy -> name ;
else
$taxonomies [ $taxonomy -> name ] = $taxonomy ;
break ;
}
}
}
return $taxonomies ;
}
2009-09-11 00:07:33 +02:00
/**
* Create new GD image resource with transparency support
2012-10-01 22:59:06 +02:00
* @ TODO : Deprecate if possible .
2009-09-11 00:07:33 +02:00
*
* @ since 2.9 . 0
*
2010-09-07 13:21:11 +02:00
* @ param int $width Image width
* @ param int $height Image height
2009-09-11 00:07:33 +02:00
* @ return image resource
*/
function wp_imagecreatetruecolor ( $width , $height ) {
$img = imagecreatetruecolor ( $width , $height );
if ( is_resource ( $img ) && function_exists ( 'imagealphablending' ) && function_exists ( 'imagesavealpha' ) ) {
imagealphablending ( $img , false );
imagesavealpha ( $img , true );
}
return $img ;
}
2009-10-13 19:04:22 +02:00
/**
* Register an embed handler . This function should probably only be used for sites that do not support oEmbed .
*
2009-10-14 00:36:24 +02:00
* @ since 2.9 . 0
2009-10-13 19:04:22 +02:00
* @ see WP_Embed :: register_handler ()
*/
function wp_embed_register_handler ( $id , $regex , $callback , $priority = 10 ) {
global $wp_embed ;
$wp_embed -> register_handler ( $id , $regex , $callback , $priority );
}
/**
* Unregister a previously registered embed handler .
*
2009-10-14 00:36:24 +02:00
* @ since 2.9 . 0
2009-10-13 19:04:22 +02:00
* @ see WP_Embed :: unregister_handler ()
*/
function wp_embed_unregister_handler ( $id , $priority = 10 ) {
global $wp_embed ;
$wp_embed -> unregister_handler ( $id , $priority );
}
/**
* Create default array of embed parameters .
*
2012-09-25 09:10:09 +02:00
* The width defaults to the content width as specified by the theme . If the
* theme does not specify a content width , then 500 px is used .
*
* The default height is 1.5 times the width , or 1000 px , whichever is smaller .
*
* The 'embed_defaults' filter can be used to adjust either of these values .
*
2009-10-14 00:36:24 +02:00
* @ since 2.9 . 0
*
2009-10-13 19:04:22 +02:00
* @ return array Default embed parameters .
*/
function wp_embed_defaults () {
2012-09-25 09:10:09 +02:00
if ( ! empty ( $GLOBALS [ 'content_width' ] ) )
$width = ( int ) $GLOBALS [ 'content_width' ];
2009-10-13 19:04:22 +02:00
2012-09-25 09:10:09 +02:00
if ( empty ( $width ) )
2009-10-13 19:04:22 +02:00
$width = 500 ;
2012-09-25 09:10:09 +02:00
$height = min ( ceil ( $width * 1.5 ), 1000 );
2010-01-27 15:38:48 +01:00
2012-09-25 09:10:09 +02:00
return apply_filters ( 'embed_defaults' , compact ( 'width' , 'height' ) );
2009-10-13 19:04:22 +02:00
}
/**
* Based on a supplied width / height example , return the biggest possible dimensions based on the max width / height .
*
2009-10-14 00:36:24 +02:00
* @ since 2.9 . 0
2009-10-13 19:04:22 +02:00
* @ uses wp_constrain_dimensions () This function passes the widths and the heights .
*
* @ param int $example_width The width of an example embed .
* @ param int $example_height The height of an example embed .
* @ param int $max_width The maximum allowed width .
* @ param int $max_height The maximum allowed height .
* @ return array The maximum possible width and height based on the example ratio .
*/
function wp_expand_dimensions ( $example_width , $example_height , $max_width , $max_height ) {
$example_width = ( int ) $example_width ;
$example_height = ( int ) $example_height ;
$max_width = ( int ) $max_width ;
$max_height = ( int ) $max_height ;
return wp_constrain_dimensions ( $example_width * 1000000 , $example_height * 1000000 , $max_width , $max_height );
}
/**
* Attempts to fetch the embed HTML for a provided URL using oEmbed .
*
2009-10-14 00:36:24 +02:00
* @ since 2.9 . 0
2009-10-13 19:04:22 +02:00
* @ see WP_oEmbed
*
* @ uses _wp_oembed_get_object ()
* @ uses WP_oEmbed :: get_html ()
*
2011-09-05 21:08:15 +02:00
* @ param string $url The URL that should be embedded .
2011-09-30 00:57:43 +02:00
* @ param array $args Additional arguments and parameters .
2012-04-22 13:19:56 +02:00
* @ return bool | string False on failure or the embed HTML on success .
2009-10-13 19:04:22 +02:00
*/
function wp_oembed_get ( $url , $args = '' ) {
2010-04-18 11:51:19 +02:00
require_once ( ABSPATH . WPINC . '/class-oembed.php' );
2009-10-13 19:04:22 +02:00
$oembed = _wp_oembed_get_object ();
return $oembed -> get_html ( $url , $args );
}
2009-10-14 00:36:24 +02:00
/**
* Adds a URL format and oEmbed provider URL pair .
*
* @ since 2.9 . 0
* @ see WP_oEmbed
*
* @ uses _wp_oembed_get_object ()
*
2009-10-23 21:33:24 +02:00
* @ param string $format The format of URL that this provider can handle . You can use asterisks as wildcards .
2009-10-14 00:36:24 +02:00
* @ param string $provider The URL to the oEmbed provider .
2010-02-24 21:13:23 +01:00
* @ param boolean $regex Whether the $format parameter is in a regex format .
2009-10-14 00:36:24 +02:00
*/
2009-10-23 21:33:24 +02:00
function wp_oembed_add_provider ( $format , $provider , $regex = false ) {
2010-04-18 11:51:19 +02:00
require_once ( ABSPATH . WPINC . '/class-oembed.php' );
2009-10-14 00:36:24 +02:00
$oembed = _wp_oembed_get_object ();
2009-10-23 21:33:24 +02:00
$oembed -> providers [ $format ] = array ( $provider , $regex );
2011-04-28 19:03:23 +02:00
}
2012-07-26 22:18:27 +02:00
/**
* Removes an oEmbed provider .
*
2012-12-20 16:22:21 +01:00
* @ since 3.5 . 0
2012-07-26 22:18:27 +02:00
* @ see WP_oEmbed
*
* @ uses _wp_oembed_get_object ()
*
* @ param string $format The URL format for the oEmbed provider to remove .
*/
function wp_oembed_remove_provider ( $format ) {
require_once ( ABSPATH . WPINC . '/class-oembed.php' );
$oembed = _wp_oembed_get_object ();
if ( isset ( $oembed -> providers [ $format ] ) ) {
unset ( $oembed -> providers [ $format ] );
return true ;
}
return false ;
}
2011-04-28 19:03:23 +02:00
/**
* Determines if default embed handlers should be loaded .
*
* Checks to make sure that the embeds library hasn ' t already been loaded . If
* it hasn ' t , then it will load the embeds library .
*
* @ since 2.9 . 0
*/
function wp_maybe_load_embeds () {
if ( ! apply_filters ( 'load_default_embeds' , true ) )
return ;
wp_embed_register_handler ( 'googlevideo' , '#http://video\.google\.([A-Za-z.]{2,5})/videoplay\?docid=([\d-]+)(.*?)#i' , 'wp_embed_handler_googlevideo' );
}
/**
* The Google Video embed handler callback . Google Video does not support oEmbed .
*
* @ see WP_Embed :: register_handler ()
* @ see WP_Embed :: shortcode ()
*
* @ param array $matches The regex matches from the provided regex when calling { @ link wp_embed_register_handler ()} .
* @ param array $attr Embed attributes .
* @ param string $url The original URL that was matched by the regex .
* @ param array $rawattr The original unmodified attributes .
* @ return string The embed HTML .
*/
function wp_embed_handler_googlevideo ( $matches , $attr , $url , $rawattr ) {
// If the user supplied a fixed width AND height, use it
if ( ! empty ( $rawattr [ 'width' ]) && ! empty ( $rawattr [ 'height' ]) ) {
$width = ( int ) $rawattr [ 'width' ];
$height = ( int ) $rawattr [ 'height' ];
} else {
list ( $width , $height ) = wp_expand_dimensions ( 425 , 344 , $attr [ 'width' ], $attr [ 'height' ] );
}
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 );
}
2012-03-15 05:14:05 +01:00
2012-09-27 22:59:57 +02:00
/**
2013-02-16 03:52:57 +01:00
* Converts a shorthand byte value to an integer byte value .
2012-09-27 22:59:57 +02:00
*
* @ since 2.3 . 0
*
2013-02-16 03:52:57 +01:00
* @ param string $size A shorthand byte value .
* @ return int An integer byte value .
2012-09-27 22:59:57 +02:00
*/
function wp_convert_hr_to_bytes ( $size ) {
$size = strtolower ( $size );
$bytes = ( int ) $size ;
if ( strpos ( $size , 'k' ) !== false )
$bytes = intval ( $size ) * 1024 ;
elseif ( strpos ( $size , 'm' ) !== false )
$bytes = intval ( $size ) * 1024 * 1024 ;
elseif ( strpos ( $size , 'g' ) !== false )
$bytes = intval ( $size ) * 1024 * 1024 * 1024 ;
return $bytes ;
}
/**
2013-02-16 03:52:57 +01:00
* Determine the maximum upload size allowed in php . ini .
2012-09-27 22:59:57 +02:00
*
* @ since 2.5 . 0
*
2013-02-16 03:52:57 +01:00
* @ return int Allowed upload size .
2012-09-27 22:59:57 +02:00
*/
function wp_max_upload_size () {
$u_bytes = wp_convert_hr_to_bytes ( ini_get ( 'upload_max_filesize' ) );
$p_bytes = wp_convert_hr_to_bytes ( ini_get ( 'post_max_size' ) );
$bytes = apply_filters ( 'upload_size_limit' , min ( $u_bytes , $p_bytes ), $u_bytes , $p_bytes );
return $bytes ;
}
2012-11-22 10:52:16 +01:00
/**
* Returns a WP_Image_Editor instance and loads file into it .
*
* @ since 3.5 . 0
* @ access public
*
* @ param string $path Path to file to load
* @ param array $args Additional data . Accepts { 'mime_type' => string , 'methods' => { string , string , ... } }
* @ return WP_Image_Editor | WP_Error
*/
function wp_get_image_editor ( $path , $args = array () ) {
$args [ 'path' ] = $path ;
if ( ! isset ( $args [ 'mime_type' ] ) ) {
$file_info = wp_check_filetype ( $args [ 'path' ] );
// If $file_info['type'] is false, then we let the editor attempt to
// figure out the file type, rather than forcing a failure based on extension.
if ( isset ( $file_info ) && $file_info [ 'type' ] )
$args [ 'mime_type' ] = $file_info [ 'type' ];
}
2012-11-27 03:27:11 +01:00
$implementation = _wp_image_editor_choose ( $args );
2012-11-22 10:52:16 +01:00
if ( $implementation ) {
$editor = new $implementation ( $path );
$loaded = $editor -> load ();
if ( is_wp_error ( $loaded ) )
return $loaded ;
return $editor ;
}
return new WP_Error ( 'image_no_editor' , __ ( 'No editor could be selected.' ) );
}
/**
* Tests whether there is an editor that supports a given mime type or methods .
*
* @ since 3.5 . 0
* @ access public
*
* @ param string | array $args Array of requirements . Accepts { 'mime_type' => string , 'methods' => { string , string , ... } }
* @ return boolean true if an eligible editor is found ; false otherwise
*/
function wp_image_editor_supports ( $args = array () ) {
return ( bool ) _wp_image_editor_choose ( $args );
}
/**
* Tests which editors are capable of supporting the request .
*
* @ since 3.5 . 0
* @ access private
*
* @ param array $args Additional data . Accepts { 'mime_type' => string , 'methods' => { string , string , ... } }
* @ return string | bool Class name for the first editor that claims to support the request . False if no editor claims to support the request .
*/
function _wp_image_editor_choose ( $args = array () ) {
require_once ABSPATH . WPINC . '/class-wp-image-editor.php' ;
require_once ABSPATH . WPINC . '/class-wp-image-editor-gd.php' ;
require_once ABSPATH . WPINC . '/class-wp-image-editor-imagick.php' ;
$implementations = apply_filters ( 'wp_image_editors' ,
array ( 'WP_Image_Editor_Imagick' , 'WP_Image_Editor_GD' ) );
foreach ( $implementations as $implementation ) {
if ( ! call_user_func ( array ( $implementation , 'test' ), $args ) )
continue ;
if ( isset ( $args [ 'mime_type' ] ) &&
! call_user_func (
array ( $implementation , 'supports_mime_type' ),
$args [ 'mime_type' ] ) ) {
continue ;
}
if ( isset ( $args [ 'methods' ] ) &&
array_diff ( $args [ 'methods' ], get_class_methods ( $implementation ) ) ) {
continue ;
}
return $implementation ;
}
return false ;
}
2012-03-15 05:14:05 +01:00
/**
* Prints default plupload arguments .
*
* @ since 3.4 . 0
*/
function wp_plupload_default_settings () {
global $wp_scripts ;
2012-11-09 05:51:25 +01:00
$data = $wp_scripts -> get_data ( 'wp-plupload' , 'data' );
if ( $data && false !== strpos ( $data , '_wpPluploadSettings' ) )
return ;
2012-03-15 05:14:05 +01:00
$max_upload_size = wp_max_upload_size ();
2012-06-06 23:45:17 +02:00
$defaults = array (
2012-03-15 05:14:05 +01:00
'runtimes' => 'html5,silverlight,flash,html4' ,
'file_data_name' => 'async-upload' , // key passed to $_FILE.
'multiple_queues' => true ,
'max_file_size' => $max_upload_size . 'b' ,
2012-11-28 21:17:57 +01:00
'url' => admin_url ( 'async-upload.php' , 'relative' ),
2012-03-15 05:14:05 +01:00
'flash_swf_url' => includes_url ( 'js/plupload/plupload.flash.swf' ),
'silverlight_xap_url' => includes_url ( 'js/plupload/plupload.silverlight.xap' ),
'filters' => array ( array ( 'title' => __ ( 'Allowed Files' ), 'extensions' => '*' ) ),
'multipart' => true ,
'urlstream_upload' => true ,
);
2012-11-28 00:20:12 +01:00
2012-11-27 17:17:53 +01:00
// Multi-file uploading doesn't currently work in iOS Safari,
// single-file allows the built-in camera to be used as source for images
if ( wp_is_mobile () )
$defaults [ 'multi_selection' ] = false ;
2012-03-15 05:14:05 +01:00
2012-06-06 23:45:17 +02:00
$defaults = apply_filters ( 'plupload_default_settings' , $defaults );
2012-03-15 05:14:05 +01:00
2012-03-15 13:50:18 +01:00
$params = array (
'action' => 'upload-attachment' ,
);
$params = apply_filters ( 'plupload_default_params' , $params );
$params [ '_wpnonce' ] = wp_create_nonce ( 'media-form' );
2012-06-06 23:45:17 +02:00
$defaults [ 'multipart_params' ] = $params ;
$settings = array (
'defaults' => $defaults ,
'browser' => array (
'mobile' => wp_is_mobile (),
'supported' => _device_can_upload (),
),
2012-11-22 12:46:03 +01:00
'limitExceeded' => is_multisite () && ! is_upload_space_available ()
2012-06-06 23:45:17 +02:00
);
2012-03-15 13:50:18 +01:00
2012-06-06 23:45:17 +02:00
$script = 'var _wpPluploadSettings = ' . json_encode ( $settings ) . ';' ;
2012-03-15 05:14:05 +01:00
if ( $data )
$script = " $data\n $script " ;
$wp_scripts -> add_data ( 'wp-plupload' , 'data' , $script );
}
2012-03-15 20:46:15 +01:00
add_action ( 'customize_controls_enqueue_scripts' , 'wp_plupload_default_settings' );
2012-08-31 04:04:40 +02:00
/**
* Prepares an attachment post object for JS , where it is expected
* to be JSON - encoded and fit into an Attachment model .
*
* @ since 3.5 . 0
*
* @ param mixed $attachment Attachment ID or object .
* @ return array Array of attachment details .
*/
function wp_prepare_attachment_for_js ( $attachment ) {
if ( ! $attachment = get_post ( $attachment ) )
2012-11-23 17:32:21 +01:00
return ;
2012-08-31 04:04:40 +02:00
if ( 'attachment' != $attachment -> post_type )
2012-11-23 17:32:21 +01:00
return ;
2012-08-31 04:04:40 +02:00
$meta = wp_get_attachment_metadata ( $attachment -> ID );
2012-11-23 17:32:21 +01:00
if ( false !== strpos ( $attachment -> post_mime_type , '/' ) )
list ( $type , $subtype ) = explode ( '/' , $attachment -> post_mime_type );
else
list ( $type , $subtype ) = array ( $attachment -> post_mime_type , '' );
2012-08-31 04:04:40 +02:00
$attachment_url = wp_get_attachment_url ( $attachment -> ID );
$response = array (
'id' => $attachment -> ID ,
'title' => $attachment -> post_title ,
'filename' => basename ( $attachment -> guid ),
'url' => $attachment_url ,
2012-10-10 23:54:21 +02:00
'link' => get_attachment_link ( $attachment -> ID ),
2012-08-31 04:04:40 +02:00
'alt' => get_post_meta ( $attachment -> ID , '_wp_attachment_image_alt' , true ),
'author' => $attachment -> post_author ,
'description' => $attachment -> post_content ,
'caption' => $attachment -> post_excerpt ,
'name' => $attachment -> post_name ,
'status' => $attachment -> post_status ,
'uploadedTo' => $attachment -> post_parent ,
2012-08-31 21:14:43 +02:00
'date' => strtotime ( $attachment -> post_date_gmt ) * 1000 ,
'modified' => strtotime ( $attachment -> post_modified_gmt ) * 1000 ,
2012-11-28 00:20:12 +01:00
'menuOrder' => $attachment -> menu_order ,
2012-08-31 04:04:40 +02:00
'mime' => $attachment -> post_mime_type ,
'type' => $type ,
'subtype' => $subtype ,
2012-11-19 09:44:37 +01:00
'icon' => wp_mime_type_icon ( $attachment -> ID ),
2012-11-10 19:25:04 +01:00
'dateFormatted' => mysql2date ( get_option ( 'date_format' ), $attachment -> post_date ),
2012-11-27 16:50:59 +01:00
'nonces' => array (
2012-12-04 19:33:51 +01:00
'update' => false ,
'delete' => false ,
2012-11-27 16:50:59 +01:00
),
2012-12-06 06:52:19 +01:00
'editLink' => false ,
2012-08-31 04:04:40 +02:00
);
2012-12-06 06:52:19 +01:00
if ( current_user_can ( 'edit_post' , $attachment -> ID ) ) {
2012-12-04 19:33:51 +01:00
$response [ 'nonces' ][ 'update' ] = wp_create_nonce ( 'update-post_' . $attachment -> ID );
2012-12-06 06:52:19 +01:00
$response [ 'editLink' ] = get_edit_post_link ( $attachment -> ID , 'raw' );
}
2012-12-04 19:33:51 +01:00
if ( current_user_can ( 'delete_post' , $attachment -> ID ) )
$response [ 'nonces' ][ 'delete' ] = wp_create_nonce ( 'delete-post_' . $attachment -> ID );
2012-09-06 11:50:41 +02:00
if ( $meta && 'image' === $type ) {
2012-08-31 04:04:40 +02:00
$sizes = array ();
2012-11-26 23:46:56 +01:00
$possible_sizes = apply_filters ( 'image_size_names_choose' , array (
'thumbnail' => __ ( 'Thumbnail' ),
'medium' => __ ( 'Medium' ),
'large' => __ ( 'Large' ),
'full' => __ ( 'Full Size' ),
) );
unset ( $possible_sizes [ 'full' ] );
// Loop through all potential sizes that may be chosen. Try to do this with some efficiency.
// First: run the image_downsize filter. If it returns something, we can use its data.
// If the filter does not return something, then image_downsize() is just an expensive
// way to check the image metadata, which we do second.
foreach ( $possible_sizes as $size => $label ) {
if ( $downsize = apply_filters ( 'image_downsize' , false , $attachment -> ID , $size ) ) {
if ( ! $downsize [ 3 ] )
continue ;
$sizes [ $size ] = array (
'height' => $downsize [ 2 ],
'width' => $downsize [ 1 ],
'url' => $downsize [ 0 ],
'orientation' => $downsize [ 2 ] > $downsize [ 1 ] ? 'portrait' : 'landscape' ,
);
} elseif ( isset ( $meta [ 'sizes' ][ $size ] ) ) {
if ( ! isset ( $base_url ) )
$base_url = str_replace ( wp_basename ( $attachment_url ), '' , $attachment_url );
// Nothing from the filter, so consult image metadata if we have it.
$size_meta = $meta [ 'sizes' ][ $size ];
2012-12-06 07:25:39 +01:00
// We have the actual image size, but might need to further constrain it if content_width is narrower.
2013-01-04 09:52:18 +01:00
// Thumbnail, medium, and full sizes are also checked against the site's height/width options.
list ( $width , $height ) = image_constrain_size_for_editor ( $size_meta [ 'width' ], $size_meta [ 'height' ], $size , 'edit' );
2012-12-06 07:25:39 +01:00
2012-11-26 23:46:56 +01:00
$sizes [ $size ] = array (
2012-12-06 07:25:39 +01:00
'height' => $height ,
'width' => $width ,
2012-11-26 23:46:56 +01:00
'url' => $base_url . $size_meta [ 'file' ],
2012-12-06 07:25:39 +01:00
'orientation' => $height > $width ? 'portrait' : 'landscape' ,
2012-09-06 11:50:41 +02:00
);
}
2012-08-31 04:04:40 +02:00
}
2013-03-29 21:51:35 +01:00
$sizes [ 'full' ] = array ( 'url' => $attachment_url );
if ( isset ( $meta [ 'height' ], $meta [ 'width' ] ) ) {
$sizes [ 'full' ][ 'height' ] = $meta [ 'height' ];
$sizes [ 'full' ][ 'width' ] = $meta [ 'width' ];
$sizes [ 'full' ][ 'orientation' ] = $meta [ 'height' ] > $meta [ 'width' ] ? 'portrait' : 'landscape' ;
}
2012-11-14 23:08:02 +01:00
$response = array_merge ( $response , array ( 'sizes' => $sizes ), $sizes [ 'full' ] );
2012-08-31 04:04:40 +02:00
}
2012-11-11 02:26:42 +01:00
if ( function_exists ( 'get_compat_media_markup' ) )
Restore the Description field to the media UI in 3.5.
We tried in vain -- a noble but ultimately failed effort -- to reduce the number of fields for attachments from four (title, caption, alt, description) to one (caption for images, title otherwise). Alternative text needed to stay for accessibility reasons, of course.
Eventually title returned due to heavy plugin reliance. Description is too used by too many plugins (often times incorrectly -- the caption is more likely the proper field), hence its less-than-triumphant return today.
Version 3.5 has tried to streamline media in a number of ways. Removing fields may have been too much at once, as it forced not only a user interface change, but a paradigm change as well.
Finally, on upload we populate the description field with IPTC/EXIF captions, rather than the caption field. See #22768, this should be fixed. For now, Description stays.
This commit also restores 'Title' attribute editing to the main tab of the Edit Image dialog. The "Title" field no longer populates title attributes for <img> tags by design (for accessibility and other purposes, see #18984). So, here is a more obvious 'workaround' for the tooltip community.
Finally, this:
* Cleans up the post.php attachment editor, including by showing a prettier form of the mime type.
* Enables plugins to specifically hide attachment_fields_to_edit from either post.php (where you can create meta boxes) or the modal (which you may not want to clutter), for compatibility reasons.
* Hides the 'Describe this file...' placeholder when a field is read-only in the modal.
props nacin, helenyhou.
fixes #22759.
git-svn-id: http://core.svn.wordpress.org/trunk@23083 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-12-06 01:41:06 +01:00
$response [ 'compat' ] = get_compat_media_markup ( $attachment -> ID , array ( 'in_modal' => true ) );
2012-11-11 02:26:42 +01:00
2012-08-31 04:04:40 +02:00
return apply_filters ( 'wp_prepare_attachment_for_js' , $response , $attachment , $meta );
}
Add new media workflow scripts, styles, and templates.
Please note that this commit does not integrate media into the existing UI. If you would like to see the new UI, navigate to the post editor and run the following in your browser's Javascript console:
new wp.media.controller.Workflow().render().modal.open();
The Javascript is broken up into two files, with the slugs media-models and media-views.
* media-models: The models are UI agnostic, and can be used independent of the views. If you'd like to create custom UIs, this is the script for you.
* media-views: This is the Media Experience. The views (and controllers) depend on the models (which are listed as a dependency and will automatically be included thanks to wp_enqueue_script). The views also require the media templates, media-view styles, and the plupload bridge settings. Perhaps we should create a function to include the whole shebang, but in the meantime...
To include media-views in the admin, run the following PHP in or after 'admin_enqueue_scripts':
wp_enqueue_script( 'media-views' );
wp_enqueue_style( 'media-views' );
wp_plupload_default_settings();
add_action( 'admin_footer', 'wp_print_media_templates' );
see #21390.
git-svn-id: http://core.svn.wordpress.org/trunk@21683 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-08-31 06:54:23 +02:00
2012-11-09 05:57:25 +01:00
/**
* Enqueues all scripts , styles , settings , and templates necessary to use
* all media JS APIs .
*
* @ since 3.5 . 0
*/
2012-11-14 10:06:10 +01:00
function wp_enqueue_media ( $args = array () ) {
2012-12-27 17:07:12 +01:00
// Enqueue me just once per page, please.
if ( did_action ( 'wp_enqueue_media' ) )
return ;
2012-11-14 10:06:10 +01:00
$defaults = array (
'post' => null ,
);
$args = wp_parse_args ( $args , $defaults );
2012-11-10 08:51:37 +01:00
// We're going to pass the old thickbox media tabs to `media_upload_tabs`
// to ensure plugins will work. We will then unset those tabs.
$tabs = array (
2012-11-10 08:56:17 +01:00
// handler action suffix => tab label
'type' => '' ,
'type_url' => '' ,
'gallery' => '' ,
'library' => '' ,
2012-11-10 08:51:37 +01:00
);
$tabs = apply_filters ( 'media_upload_tabs' , $tabs );
unset ( $tabs [ 'type' ], $tabs [ 'type_url' ], $tabs [ 'gallery' ], $tabs [ 'library' ] );
2013-01-04 09:02:16 +01:00
$props = array (
'link' => get_option ( 'image_default_link_type' ), // db default is 'file'
'align' => get_option ( 'image_default_align' ), // empty default
'size' => get_option ( 'image_default_size' ), // empty default
);
2012-11-10 08:51:37 +01:00
$settings = array (
2012-11-21 11:18:59 +01:00
'tabs' => $tabs ,
'tabUrl' => add_query_arg ( array ( 'chromeless' => true ), admin_url ( 'media-upload.php' ) ),
'mimeTypes' => wp_list_pluck ( get_post_mime_types (), 0 ),
2012-11-21 15:27:22 +01:00
'captions' => ! apply_filters ( 'disable_captions' , '' ),
2012-11-21 17:02:20 +01:00
'nonce' => array (
'sendToEditor' => wp_create_nonce ( 'media-send-to-editor' ),
),
2012-12-03 08:17:10 +01:00
'post' => array (
'id' => 0 ,
),
2013-01-04 09:02:16 +01:00
'defaultProps' => $props ,
2012-11-10 08:51:37 +01:00
);
2012-11-20 03:58:33 +01:00
$post = null ;
if ( isset ( $args [ 'post' ] ) ) {
$post = get_post ( $args [ 'post' ] );
2012-12-03 08:17:10 +01:00
$settings [ 'post' ] = array (
'id' => $post -> ID ,
'nonce' => wp_create_nonce ( 'update-post_' . $post -> ID ),
);
2012-12-03 03:38:10 +01:00
if ( current_theme_supports ( 'post-thumbnails' , $post -> post_type ) && post_type_supports ( $post -> post_type , 'thumbnail' ) ) {
2012-12-03 08:17:10 +01:00
$featured_image_id = get_post_meta ( $post -> ID , '_thumbnail_id' , true );
$settings [ 'post' ][ 'featuredImageId' ] = $featured_image_id ? $featured_image_id : - 1 ;
2012-12-03 03:38:10 +01:00
}
2012-11-20 03:58:33 +01:00
}
2012-11-10 08:51:37 +01:00
2012-11-21 00:22:03 +01:00
$hier = $post && is_post_type_hierarchical ( $post -> post_type );
2012-11-20 03:58:33 +01:00
$strings = array (
2012-11-10 01:37:13 +01:00
// Generic
2012-11-12 06:57:12 +01:00
'url' => __ ( 'URL' ),
2012-11-28 18:18:50 +01:00
'addMedia' => __ ( 'Add Media' ),
2012-11-10 01:37:13 +01:00
'search' => __ ( 'Search' ),
'select' => __ ( 'Select' ),
'cancel' => __ ( 'Cancel' ),
2012-12-05 20:03:38 +01:00
/* translators : This is a would - be plural string used in the media manager .
If there is not a word you can use in your language to avoid issues with the
lack of plural support here , turn it into " selected: %d " then translate it .
*/
'selected' => __ ( '%d selected' ),
2012-11-10 10:11:33 +01:00
'dragInfo' => __ ( 'Drag and drop to reorder images.' ),
2012-11-10 01:37:13 +01:00
// Upload
'uploadFilesTitle' => __ ( 'Upload Files' ),
'uploadImagesTitle' => __ ( 'Upload Images' ),
// Library
2012-11-21 11:18:59 +01:00
'mediaLibraryTitle' => __ ( 'Media Library' ),
2012-12-04 02:26:03 +01:00
'insertMediaTitle' => __ ( 'Insert Media' ),
2012-11-21 11:18:59 +01:00
'createNewGallery' => __ ( 'Create a new gallery' ),
'returnToLibrary' => __ ( '← Return to library' ),
2012-11-20 14:49:35 +01:00
'allMediaItems' => __ ( 'All media items' ),
2012-12-04 02:26:03 +01:00
'noItemsFound' => __ ( 'No items found.' ),
2012-11-21 11:18:59 +01:00
'insertIntoPost' => $hier ? __ ( 'Insert into page' ) : __ ( 'Insert into post' ),
2012-11-21 00:22:03 +01:00
'uploadedToThisPost' => $hier ? __ ( 'Uploaded to this page' ) : __ ( 'Uploaded to this post' ),
2012-11-27 16:50:59 +01:00
'warnDelete' => __ ( " You are about to permanently delete this item. \n 'Cancel' to stop, 'OK' to delete. " ),
2012-11-20 14:49:35 +01:00
2012-11-27 16:35:36 +01:00
// From URL
2012-12-05 20:07:48 +01:00
'insertFromUrlTitle' => __ ( 'Insert from URL' ),
2012-11-10 01:37:13 +01:00
2012-12-03 03:38:10 +01:00
// Featured Images
2012-12-05 20:07:48 +01:00
'setFeaturedImageTitle' => __ ( 'Set Featured Image' ),
2012-12-03 03:38:10 +01:00
'setFeaturedImage' => __ ( 'Set featured image' ),
2012-11-10 01:37:13 +01:00
// Gallery
'createGalleryTitle' => __ ( 'Create Gallery' ),
'editGalleryTitle' => __ ( 'Edit Gallery' ),
'cancelGalleryTitle' => __ ( '← Cancel Gallery' ),
'insertGallery' => __ ( 'Insert gallery' ),
'updateGallery' => __ ( 'Update gallery' ),
'addToGallery' => __ ( 'Add to gallery' ),
2012-12-04 02:26:03 +01:00
'addToGalleryTitle' => __ ( 'Add to Gallery' ),
2012-12-03 06:32:25 +01:00
'reverseOrder' => __ ( 'Reverse order' ),
2012-11-20 03:58:33 +01:00
);
$settings = apply_filters ( 'media_view_settings' , $settings , $post );
$strings = apply_filters ( 'media_view_strings' , $strings , $post );
$strings [ 'settings' ] = $settings ;
wp_localize_script ( 'media-views' , '_wpMediaViewsL10n' , $strings );
2012-11-10 01:37:13 +01:00
2012-11-21 17:46:32 +01:00
wp_enqueue_script ( 'media-editor' );
2012-11-09 05:57:25 +01:00
wp_enqueue_style ( 'media-views' );
wp_plupload_default_settings ();
2012-12-06 08:10:20 +01:00
require_once ABSPATH . WPINC . '/media-template.php' ;
2012-11-09 05:57:25 +01:00
add_action ( 'admin_footer' , 'wp_print_media_templates' );
add_action ( 'wp_footer' , 'wp_print_media_templates' );
2012-12-02 17:33:20 +01:00
do_action ( 'wp_enqueue_media' );
2012-11-09 05:57:25 +01:00
}
2013-03-16 06:25:44 +01:00
/**
2013-03-22 09:08:46 +01:00
* Retrieve media attached to the passed post
2013-03-16 06:25:44 +01:00
*
* @ since 3.6 . 0
*
2013-03-22 09:08:46 +01:00
* @ param string $type ( Mime ) type of media desired
2013-03-16 06:25:44 +01:00
* @ param int $post_id Post ID
2013-03-22 09:08:46 +01:00
* @ return array Found attachments
2013-03-16 06:25:44 +01:00
*/
2013-03-22 09:08:46 +01:00
function get_attached_media ( $type , $post_id = 0 ) {
2013-03-16 06:25:44 +01:00
$post = empty ( $post_id ) ? get_post () : get_post ( $post_id );
if ( empty ( $post ) )
return ;
2013-03-22 09:08:46 +01:00
$args = array (
2013-03-16 06:25:44 +01:00
'post_parent' => $post -> ID ,
'post_type' => 'attachment' ,
2013-03-22 09:08:46 +01:00
'post_mime_type' => $type ,
'posts_per_page' => - 1 ,
'orderby' => 'menu_order' ,
'order' => 'ASC' ,
);
$args = apply_filters ( 'get_attached_media_args' , $args , $type , $post );
$children = get_children ( $args );
return ( array ) apply_filters ( 'get_attached_media' , $children , $type , $post );
}
2013-03-16 06:25:44 +01:00
2013-03-22 09:08:46 +01:00
/**
* Retrieve audio attached to the passed post
*
* @ since 3.6 . 0
*
* @ param int $post_id Post ID
* @ return array Found audio attachments
*/
function get_attached_audio ( $post_id = 0 ) {
return get_attached_media ( 'audio' , $post_id );
2013-03-16 06:25:44 +01:00
}
/**
* Retrieve video attached to the passed post
*
* @ since 3.6 . 0
*
* @ param int $post_id Post ID
* @ return array Found video attachments
*/
2013-03-22 06:20:38 +01:00
function get_attached_video ( $post_id = 0 ) {
2013-03-22 09:08:46 +01:00
return get_attached_media ( 'video' , $post_id );
2013-03-16 06:25:44 +01:00
}
2013-03-22 06:55:08 +01:00
/**
2013-03-27 19:34:59 +01:00
* Extract and parse { media type } shortcodes or srcs from the passed content
2013-03-22 06:55:08 +01:00
*
* @ since 3.6 . 0
*
2013-03-27 19:34:59 +01:00
* @ param string $type Type of media : audio or video
2013-03-22 06:55:08 +01:00
* @ param string $content A string which might contain media data .
2013-03-27 19:34:59 +01:00
* @ param boolean $html Whether to return HTML or URLs
2013-03-22 06:55:08 +01:00
* @ param boolean $remove Whether to remove the found URL from the passed content .
2013-03-27 19:34:59 +01:00
* @ return array A list of parsed shortcodes or extracted srcs
2013-03-22 06:55:08 +01:00
*/
2013-03-27 19:34:59 +01:00
function get_content_media ( $type , & $content , $html = true , $remove = false ) {
2013-03-22 06:55:08 +01:00
$items = array ();
$matches = array ();
if ( preg_match_all ( '/' . get_shortcode_regex () . '/s' , $content , $matches , PREG_SET_ORDER ) && ! empty ( $matches ) ) {
foreach ( $matches as $shortcode ) {
if ( $type === $shortcode [ 2 ] ) {
$count = 1 ;
if ( $remove )
2013-03-27 19:34:59 +01:00
$content =& str_replace ( $shortcode [ 0 ], '' , $content , $count );
2013-03-22 06:55:08 +01:00
2013-03-27 19:34:59 +01:00
$items [] = do_shortcode_tag ( $shortcode );
2013-03-22 06:55:08 +01:00
}
}
}
2013-03-27 19:34:59 +01:00
if ( $html )
return $items ;
$src = '' ;
$data = array ();
foreach ( $items as $item ) {
preg_match_all ( '#src=[\'"](.+?)[\'"]#is' , $item , $src , PREG_SET_ORDER );
if ( ! empty ( $src ) ) {
$srcs = array ();
foreach ( $src as $s )
$srcs [] = $s [ 1 ];
$data [] = array_values ( array_unique ( $srcs ) );
}
}
return $data ;
2013-03-22 06:55:08 +01:00
}
/**
* Check the content blob for an < { media type } > , < object > , < embed > , or < iframe > , in that order
* If no HTML tag is found , check the first line of the post for a URL
*
* @ since 3.6 . 0
*
2013-03-27 19:34:59 +01:00
* @ param string $type Type of media : audio or video
2013-03-22 06:55:08 +01:00
* @ param string $content A string which might contain media data .
* @ param boolean $remove Whether to remove the found URL from the passed content .
2013-03-27 19:34:59 +01:00
* @ param int $limit Optional . The number of galleries to return
2013-03-22 06:55:08 +01:00
* @ return array A list of found HTML media embeds and possibly a URL by itself
*/
2013-03-27 19:34:59 +01:00
function get_embedded_media ( $type , & $content , $remove = false , $limit = 0 ) {
2013-03-22 06:55:08 +01:00
$html = array ();
$matches = '' ;
foreach ( array ( $type , 'object' , 'embed' , 'iframe' ) as $tag ) {
if ( preg_match ( '#' . get_tag_regex ( $tag ) . '#' , $content , $matches ) ) {
$html [] = $matches [ 1 ];
if ( $remove )
$content = str_replace ( $matches [ 0 ], '' , $content );
2013-03-27 19:34:59 +01:00
if ( $limit > 0 && count ( $html ) >= $limit )
break ;
2013-03-22 06:55:08 +01:00
}
}
2013-03-27 19:34:59 +01:00
if ( ! empty ( $html ) && count ( $html ) >= $limit )
return $html ;
2013-03-22 06:55:08 +01:00
$lines = explode ( " \n " , trim ( $content ) );
$line = trim ( array_shift ( $lines ) );
if ( 0 === stripos ( $line , 'http' ) ) {
if ( $remove )
$content = join ( " \n " , $lines );
$html [] = $line ;
}
return $html ;
}
/**
2013-03-27 19:34:59 +01:00
* Extract the HTML or < source > srcs from the content ' s [ audio ]
2013-03-22 06:55:08 +01:00
*
* @ since 3.6 . 0
*
* @ param string $content A string which might contain audio data .
2013-03-27 19:34:59 +01:00
* @ param boolean $html Whether to return HTML or URLs
2013-03-22 06:55:08 +01:00
* @ param boolean $remove Whether to remove the found URL from the passed content .
2013-03-27 19:34:59 +01:00
* @ return array A list of lists . Each item has a list of HTML or srcs corresponding
* to an [ audio ] ' s HTML or primary src and specified fallbacks
2013-03-22 06:55:08 +01:00
*/
2013-03-27 19:34:59 +01:00
function get_content_audio ( & $content , $html = true , $remove = false ) {
return get_content_media ( 'audio' , $content , $html , $remove );
2013-03-22 06:55:08 +01:00
}
/**
* Check the content blob for an < audio > , < object > , < embed > , or < iframe > , in that order
* If no HTML tag is found , check the first line of the post for a URL
*
* @ since 3.6 . 0
*
* @ param string $content A string which might contain audio data .
* @ param boolean $remove Whether to remove the found URL from the passed content .
* @ return array A list of found HTML audio embeds and possibly a URL by itself
*/
function get_embedded_audio ( & $content , $remove = false ) {
return get_embedded_media ( 'audio' , $content , $remove );
}
/**
2013-03-27 19:34:59 +01:00
* Extract the HTML or < source > srcs from the content ' s [ video ]
2013-03-22 06:55:08 +01:00
*
* @ since 3.6 . 0
*
* @ param string $content A string which might contain video data .
2013-03-27 19:34:59 +01:00
* @ param boolean $html Whether to return HTML or URLs
2013-03-22 06:55:08 +01:00
* @ param boolean $remove Whether to remove the found URL from the passed content .
2013-03-27 19:34:59 +01:00
* @ return array A list of lists . Each item has a list of HTML or srcs corresponding
* to a [ video ] ' s HTML or primary src and specified fallbacks
2013-03-22 06:55:08 +01:00
*/
2013-03-27 19:34:59 +01:00
function get_content_video ( & $content , $html = true , $remove = false ) {
return get_content_media ( 'video' , $content , $html , $remove );
2013-03-22 06:55:08 +01:00
}
/**
* Check the content blob for a < video > , < object > , < embed > , or < iframe > , in that order
* If no HTML tag is found , check the first line of the post for a URL
*
* @ since 3.6 . 0
*
* @ param string $content A string which might contain video data .
* @ param boolean $remove Whether to remove the found URL from the passed content .
* @ return array A list of found HTML video embeds and possibly a URL by itself
*/
function get_embedded_video ( & $content , $remove = false ) {
return get_embedded_media ( 'video' , $content , $remove );
}
2013-03-16 06:25:44 +01:00
/**
* Audio embed handler callback .
*
2013-03-22 06:20:38 +01:00
* @ since 3.6 . 0
*
2013-03-16 06:25:44 +01:00
* @ param array $matches The regex matches from the provided regex when calling { @ link wp_embed_register_handler ()} .
* @ param array $attr Embed attributes .
* @ param string $url The original URL that was matched by the regex .
* @ param array $rawattr The original unmodified attributes .
* @ return string The embed HTML .
*/
function wp_audio_embed ( $matches , $attr , $url , $rawattr ) {
$audio = $url ;
if ( shortcode_exists ( 'audio' ) )
$audio = do_shortcode ( '[audio src="' . $url . '" /]' );
return apply_filters ( 'wp_audio_embed' , $audio , $attr , $url , $rawattr );
}
wp_embed_register_handler ( 'wp_audio_embed' , '#https?://.+?\.(' . join ( '|' , wp_get_audio_extensions () ) . ')#i' , apply_filters ( 'wp_audio_embed_handler' , 'wp_audio_embed' ), 9999 );
/**
* Video embed handler callback .
*
2013-03-22 06:20:38 +01:00
* @ since 3.6 . 0
*
2013-03-16 06:25:44 +01:00
* @ param array $matches The regex matches from the provided regex when calling { @ link wp_embed_register_handler ()} .
* @ param array $attr Embed attributes .
* @ param string $url The original URL that was matched by the regex .
* @ param array $rawattr The original unmodified attributes .
* @ return string The embed HTML .
*/
function wp_video_embed ( $matches , $attr , $url , $rawattr ) {
$dimensions = '' ;
$video = $url ;
if ( shortcode_exists ( 'video' ) ) {
if ( ! empty ( $rawattr [ 'width' ] ) && ! empty ( $rawattr [ 'height' ] ) ) {
$dimensions .= sprintf ( 'width="%d" ' , ( int ) $rawattr [ 'width' ] );
$dimensions .= sprintf ( 'height="%d" ' , ( int ) $rawattr [ 'height' ] );
}
$video = do_shortcode ( '[video ' . $dimensions . 'src="' . $url . '" /]' );
}
return apply_filters ( 'wp_video_embed' , $video , $attr , $url , $rawattr );
}
wp_embed_register_handler ( 'wp_video_embed' , '#https?://.+?\.(' . join ( '|' , wp_get_video_extensions () ) . ')#i' , apply_filters ( 'wp_video_embed_handler' , 'wp_video_embed' ), 9999 );
2013-03-22 06:20:38 +01:00
2013-03-27 19:34:59 +01:00
/**
* Return suitable HTML code for output based on the content related to the global $post
* If found , remove the content from the @ global $post ' s post_content field
*
* @ since 3.6 . 0
*
* @ param string $type Required . 'audio' or 'video'
* @ param WP_Post $post Optional . Used instead of global $post when passed .
* @ return string
*/
2013-04-04 10:09:02 +02:00
function get_the_post_format_media ( $type , & $post = null ) {
2013-03-27 19:34:59 +01:00
global $wp_embed ;
if ( empty ( $post ) )
$post =& get_post ();
if ( empty ( $post ) )
return '' ;
if ( isset ( $post -> format_content ) )
return $post -> format_content ;
$count = 1 ;
2013-04-09 15:42:53 +02:00
if ( has_post_format ( $type , $post ) ) {
2013-03-27 19:34:59 +01:00
$meta = get_post_format_meta ( $post -> ID );
2013-03-29 04:35:41 +01:00
if ( ! empty ( $meta [ $type ] ) ) {
if ( is_integer ( $meta [ $type ] ) ) {
$url = wp_get_attachment_url ( $meta [ $type ] );
2013-03-27 19:34:59 +01:00
$shortcode = sprintf ( '[%s src="%s"]' , $type , $url );
2013-03-29 04:35:41 +01:00
} elseif ( preg_match ( '/' . get_shortcode_regex () . '/s' , $meta [ $type ] ) ) {
$shortcode = $meta [ $type ];
} elseif ( preg_match ( '#<[^>]+>#' , $meta [ $type ] ) ) {
$post -> format_content = $meta [ $type ];
2013-03-27 19:34:59 +01:00
return $post -> format_content ;
2013-03-29 04:35:41 +01:00
} elseif ( 0 === strpos ( $meta [ $type ], 'http' ) ) {
$post -> split_content = str_replace ( $meta [ $type ], '' , $post -> post_content , $count );
if ( strstr ( $meta [ $type ], home_url () ) ) {
$shortcode = sprintf ( '[%s src="%s"]' , $type , $meta [ $type ] );
2013-03-27 19:34:59 +01:00
} else {
2013-03-29 04:35:41 +01:00
$post -> format_content = $wp_embed -> autoembed ( $meta [ $type ] );
2013-03-27 19:34:59 +01:00
return $post -> format_content ;
}
}
if ( ! empty ( $shortcode ) ) {
$post -> format_content = do_shortcode ( $shortcode );
return $post -> format_content ;
}
}
}
2013-03-29 20:10:31 +01:00
// these functions expect a reference, so we should make a copy of post content to avoid changing it
$content = $post -> post_content ;
2013-03-27 19:34:59 +01:00
$htmls = get_content_media ( $type , $content , true , true );
if ( ! empty ( $htmls ) ) {
$html = reset ( $htmls );
$post -> split_content = $content ;
$post -> format_content = $html ;
return $post -> format_content ;
}
$embeds = get_embedded_media ( $type , $content , true , 1 );
if ( ! empty ( $embeds ) ) {
$embed = reset ( $embeds );
$post -> split_content = $content ;
if ( 0 === strpos ( $embed , 'http' ) ) {
if ( strstr ( $embed , home_url () ) ) {
$post -> format_content = do_shortcode ( sprintf ( '[%s src="%s"]' , $type , $embed ) );
} else {
$post -> format_content = $wp_embed -> autoembed ( $embed );
}
} else {
$post -> format_content = $embed ;
}
return $post -> format_content ;
}
2013-04-09 15:42:53 +02:00
$medias = call_user_func ( 'get_attached_' . $type , $post -> ID );
2013-03-28 08:28:27 +01:00
if ( ! empty ( $medias ) ) {
$media = reset ( $medias );
$url = wp_get_attachment_url ( $media -> ID );
$shortcode = sprintf ( '[%s src="%s"]' , $type , $url );
$post -> format_content = do_shortcode ( $shortcode );
return $post -> format_content ;
}
2013-03-27 19:34:59 +01:00
return '' ;
}
/**
* Output the first video in the current ( @ global ) post ' s content
*
* @ since 3.6 . 0
*
*/
2013-04-04 10:09:02 +02:00
function the_post_format_video () {
echo get_the_post_format_media ( 'video' );
2013-03-27 19:34:59 +01:00
}
/**
* Output the first audio in the current ( @ global ) post ' s content
*
* @ since 3.6 . 0
*
*/
2013-04-04 10:09:02 +02:00
function the_post_format_audio () {
echo get_the_post_format_media ( 'audio' );
2013-03-27 19:34:59 +01:00
}
2013-03-22 06:20:38 +01:00
/**
* Retrieve images attached to the passed post
*
* @ since 3.6 . 0
*
* @ param int $post_id Optional . Post ID .
* @ return array Found image attachments
*/
function get_attached_images ( $post_id = 0 ) {
2013-03-22 09:08:46 +01:00
return get_attached_media ( 'image' , $post_id );
2013-03-22 06:20:38 +01:00
}
/**
* Retrieve images attached to the passed post
*
* @ since 3.6 . 0
*
* @ param int $post_id Optional . Post ID .
* @ return array Found image attachments
*/
function get_attached_image_srcs ( $post_id = 0 ) {
$children = get_attached_images ( $post_id );
if ( empty ( $children ) )
return array ();
$srcs = array ();
foreach ( $children as $attachment )
$srcs [] = wp_get_attachment_url ( $attachment -> ID );
return $srcs ;
}
/**
2013-03-27 19:34:59 +01:00
* Check the content blob for images or image srcs
2013-03-22 06:20:38 +01:00
*
* @ since 3.6 . 0
*
* @ param string $content A string which might contain image data .
2013-03-27 19:34:59 +01:00
* @ param boolean $html Whether to return HTML or URLs
2013-03-22 06:20:38 +01:00
* @ param boolean $remove Whether to remove the found data from the passed content .
* @ param int $limit Optional . The number of image srcs to return
2013-03-27 19:34:59 +01:00
* @ return array The found images or srcs
2013-03-22 06:20:38 +01:00
*/
2013-03-27 19:34:59 +01:00
function get_content_images ( & $content , $html = true , $remove = false , $limit = 0 ) {
2013-03-22 06:20:38 +01:00
$matches = array ();
2013-03-27 19:34:59 +01:00
$tags = array ();
$captions = array ();
2013-03-22 06:20:38 +01:00
if ( $remove && preg_match_all ( '/' . get_shortcode_regex () . '/s' , $content , $matches , PREG_SET_ORDER ) && ! empty ( $matches ) ) {
foreach ( $matches as $shortcode ) {
if ( 'caption' === $shortcode [ 2 ] )
$captions [] = $shortcode [ 0 ];
}
}
if ( preg_match_all ( '#<img[^>]+/?>#i' , $content , $matches , PREG_SET_ORDER ) && ! empty ( $matches ) ) {
foreach ( $matches as $tag ) {
$count = 1 ;
if ( $remove ) {
foreach ( $captions as $caption ) {
if ( strstr ( $caption , $tag [ 0 ] ) ) {
$content = str_replace ( $caption , '' , $content , $count );
}
}
$content = str_replace ( $tag [ 0 ], '' , $content , $count );
}
2013-03-27 19:34:59 +01:00
$tags [] = $tag [ 0 ];
if ( $limit > 0 && count ( $tags ) >= $limit )
break ;
}
}
if ( $html )
return $tags ;
$src = '' ;
$srcs = array ();
foreach ( $tags as $tag ) {
preg_match ( '#src=[\'"](.+?)[\'"]#is' , $tag , $src );
if ( ! empty ( $src [ 1 ] ) ) {
$srcs [] = $src [ 1 ];
if ( $limit > 0 && count ( $srcs ) >= $limit )
break ;
2013-03-22 06:20:38 +01:00
}
}
2013-03-27 20:07:58 +01:00
return apply_filters ( 'content_images' , array_values ( array_unique ( $srcs ) ), $content );
2013-03-22 06:20:38 +01:00
}
/**
2013-03-27 19:34:59 +01:00
* Check the content blob for images or srcs and return the first
2013-03-22 06:20:38 +01:00
*
* @ since 3.6 . 0
*
* @ param string $content A string which might contain image data .
2013-03-27 19:34:59 +01:00
* @ param boolean $html Whether to return HTML or URLs
2013-03-22 06:20:38 +01:00
* @ param boolean $remove Whether to remove the found data from the passed content .
* @ return string The found data
*/
2013-03-27 19:34:59 +01:00
function get_content_image ( & $content , $html = true , $remove = false ) {
$srcs = get_content_images ( $content , $html , $remove , 1 );
2013-03-22 06:20:38 +01:00
if ( empty ( $srcs ) )
return '' ;
2013-03-27 20:07:58 +01:00
return apply_filters ( 'content_image' , reset ( $srcs ), $content );
2013-03-22 06:20:38 +01:00
}
/**
* Check the content blob for galleries and return their image srcs
*
* @ since 3.6 . 0
*
* @ param string $content A string which might contain image data .
* @ param boolean $remove Optional . Whether to remove the found data from the passed content .
* @ param int $limit Optional . The number of galleries to return
* @ return array A list of galleries , which in turn are a list of their srcs in order
*/
function get_content_galleries ( & $content , $remove = false , $limit = 0 ) {
$src = '' ;
$galleries = array ();
$matches = array ();
if ( preg_match_all ( '/' . get_shortcode_regex () . '/s' , $content , $matches , PREG_SET_ORDER ) && ! empty ( $matches ) ) {
foreach ( $matches as $shortcode ) {
if ( 'gallery' === $shortcode [ 2 ] ) {
$srcs = array ();
$count = 1 ;
if ( $remove )
$content = str_replace ( $shortcode [ 0 ], '' , $content , $count );
$data = shortcode_parse_atts ( $shortcode [ 3 ] );
$gallery = do_shortcode_tag ( $shortcode );
preg_match_all ( '#src=[\'"](.+?)[\'"]#is' , $gallery , $src , PREG_SET_ORDER );
if ( ! empty ( $src ) ) {
foreach ( $src as $s )
$srcs [] = $s [ 1 ];
}
$data [ 'src' ] = array_values ( array_unique ( $srcs ) );
$galleries [] = $data ;
if ( $limit > 0 && count ( $galleries ) >= $limit )
break ;
}
}
}
2013-03-27 20:07:58 +01:00
return apply_filters ( 'content_galleries' , $galleries , $content );
2013-03-22 06:20:38 +01:00
}
/**
* Retrieve galleries from the passed post ' s content
*
* @ since 3.6 . 0
*
* @ param int $post_id Optional . Post ID .
* @ return array A list of arrays , each containing gallery data and srcs parsed
* from the expanded shortcode
*/
function get_post_galleries ( $post_id = 0 ) {
$post = empty ( $post_id ) ? clone get_post () : get_post ( $post_id );
if ( empty ( $post ) || ! has_shortcode ( $post -> post_content , 'gallery' ) )
return array ();
return get_content_galleries ( $post -> post_content );
}
/**
* Retrieve the image srcs from galleries from a post ' s content , if present
*
* @ since 3.6 . 0
*
* @ param int $post_id Optional . Post ID .
* @ return array A list of lists , each containing image srcs parsed
* from an expanded shortcode
*/
function get_post_galleries_images ( $post_id = 0 ) {
$post = empty ( $post_id ) ? clone get_post () : get_post ( $post_id );
if ( empty ( $post ) || ! has_shortcode ( $post -> post_content , 'gallery' ) )
return array ();
$data = get_content_galleries ( $post -> post_content );
return wp_list_pluck ( $data , 'src' );
}
/**
* Check a specified post ' s content for gallery and , if present , return the first
*
* @ since 3.6 . 0
*
* @ param int $post_id Optional . Post ID .
* @ return array Gallery data and srcs parsed from the expanded shortcode
*/
function get_post_gallery ( $post_id = 0 ) {
$post = empty ( $post_id ) ? clone get_post () : get_post ( $post_id );
if ( empty ( $post ) || ! has_shortcode ( $post -> post_content , 'gallery' ) )
return array ();
$data = get_content_galleries ( $post -> post_content , false , 1 );
return reset ( $data );
}
/**
* Check a post ' s content for galleries and return the image srcs for the first found gallery
*
* @ since 3.6 . 0
*
* @ param int $post_id Optional . Post ID .
* @ return array A list of a gallery ' s image srcs in order
*/
function get_post_gallery_images ( $post_id = 0 ) {
$gallery = get_post_gallery ( $post_id );
if ( empty ( $gallery [ 'src' ] ) )
return array ();
return $gallery [ 'src' ];
2013-03-27 19:34:59 +01:00
}
/**
* Return the first image in the current ( @ global ) post ' s content
*
* @ since 3.6 . 0
*
* @ param string $attached_size If an attached image is found , the size to display it .
* @ param WP_Post $post Optional . Used instead of global $post when passed .
*/
2013-04-04 10:09:02 +02:00
function get_the_post_format_image ( $attached_size = 'full' , & $post = null ) {
2013-03-27 19:34:59 +01:00
if ( empty ( $post ) )
$post = get_post ();
if ( empty ( $post ) )
return '' ;
if ( isset ( $post -> format_content ) )
return $post -> format_content ;
2013-03-29 06:21:23 +01:00
$meta = get_post_format_meta ( $post -> ID );
if ( ! empty ( $meta [ 'image' ] ) ) {
$post -> format_content = wp_get_attachment_image ( $meta [ 'image' ], $attached_size );
return $post -> format_content ;
}
2013-04-09 18:28:09 +02:00
$medias = get_attached_images ( $post -> ID );
2013-03-27 19:34:59 +01:00
if ( ! empty ( $medias ) ) {
$media = reset ( $medias );
$sizes = get_intermediate_image_sizes ();
$urls = array ();
foreach ( $sizes as $size ) {
$urls [] = reset ( wp_get_attachment_image_src ( $media -> ID , $size ) );
$urls [] = get_attachment_link ( $media -> ID );
}
$count = 1 ;
$matches = array ();
2013-03-29 20:10:31 +01:00
$content = $post -> post_content ;
2013-03-27 19:34:59 +01:00
if ( preg_match_all ( '/' . get_shortcode_regex () . '/s' , $content , $matches , PREG_SET_ORDER ) && ! empty ( $matches ) ) {
foreach ( $matches as $shortcode ) {
if ( 'caption' === $shortcode [ 2 ] ) {
foreach ( $urls as $url ) {
if ( strstr ( $shortcode [ 0 ], $url ) )
$content = str_replace ( $shortcode [ 0 ], '' , $content , $count );
}
}
}
}
foreach ( array ( 'a' , 'img' ) as $tag ) {
if ( preg_match_all ( '#' . get_tag_regex ( $tag ) . '#' , $content , $matches , PREG_SET_ORDER ) && ! empty ( $matches ) ) {
foreach ( $matches as $match ) {
foreach ( $urls as $url ) {
if ( strstr ( $match [ 0 ], $url ) )
$content = str_replace ( $match [ 0 ], '' , $content , $count );
}
}
}
}
$post -> split_content = $content ;
$post -> format_content = wp_get_attachment_image ( $media -> ID , $attached_size );
return $post -> format_content ;
}
2013-03-29 20:10:31 +01:00
$content = $post -> post_content ;
2013-03-27 19:34:59 +01:00
$htmls = get_content_images ( $content , true , true , 1 );
if ( ! empty ( $htmls ) ) {
$html = reset ( $htmls );
$post -> split_content = $content ;
$post -> format_content = $html ;
return $post -> format_content ;
}
}
/**
* Output the first image in the current ( @ global ) post ' s content
*
* @ since 3.6 . 0
*
* @ param string $attached_size If an attached image is found , the size to display it .
*/
2013-04-04 10:09:02 +02:00
function the_post_format_image ( $attached_size = 'full' ) {
echo get_the_post_format_image ( $attached_size );
2013-03-22 06:20:38 +01:00
}