* WordPress API for media display.
*
* @package WordPress
+ * @subpackage Media
*/
/**
*
* 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
+ * 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.
*
- * Finally, there is a filter named, 'editor_max_image_size' that will be called
- * on the calculated array for width and height, respectively. The second
+ * Finally, there is a filter named {@see 'editor_max_image_size'}, that will be
+ * called 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.
+ * @param int $width Width of the image in pixels.
+ * @param int $height Height of the image in pixels.
+ * @param string|array $size Optional. Size or array of sizes of what the result image
+ * should be. Accepts any valid image size name. Default 'medium'.
+ * @param string $context Optional. Could be 'display' (like in a theme) or 'edit'
+ * (like inserting into an editor). Default null.
* @return array Width and height of what the result image should resize to.
*/
-function image_constrain_size_for_editor($width, $height, $size = 'medium') {
+function image_constrain_size_for_editor( $width, $height, $size = 'medium', $context = null ) {
global $content_width, $_wp_additional_image_sizes;
+ if ( ! $context )
+ $context = is_admin() ? 'edit' : 'display';
+
if ( is_array($size) ) {
$max_width = $size[0];
$max_height = $size[1];
// if no width is set, default to the theme content width if available
}
elseif ( $size == 'large' ) {
- // we're inserting a large size image into the editor. if it's a really
+ // We're inserting a large size image into the editor. If it's a really
// big image we'll scale it down to fit reasonably within the editor
- // itself, and within the theme's content width if it's known. the user
+ // itself, and within the theme's content width if it's known. The user
// can resize it in the editor if they wish.
$max_width = intval(get_option('large_size_w'));
$max_height = intval(get_option('large_size_h'));
} 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'] );
- if ( intval($content_width) > 0 && is_admin() ) // Only in admin. Assume that theme authors know what they're doing.
+ if ( intval($content_width) > 0 && 'edit' == $context ) // Only in admin. Assume that theme authors know what they're doing.
$max_width = min( intval($content_width), $max_width );
}
// $size == 'full' has no constraint
$max_height = $height;
}
- list( $max_width, $max_height ) = apply_filters( 'editor_max_image_size', array( $max_width, $max_height ), $size );
+ /**
+ * Filter the maximum image size dimensions for the editor.
+ *
+ * @since 2.5.0
+ *
+ * @param array $max_image_size An array with the width as the first element,
+ * and the height as the second element.
+ * @param string|array $size Size of what the result image should be.
+ * @param string $context The context the image is being resized for.
+ * Possible values are 'display' (like in a theme)
+ * or 'edit' (like inserting into an editor).
+ */
+ list( $max_width, $max_height ) = apply_filters( 'editor_max_image_size', array( $max_width, $max_height ), $size, $context );
return wp_constrain_dimensions( $width, $height, $max_width, $max_height );
}
* to the new image that was resized.
*
* @since 2.5.0
- * @uses apply_filters() Calls 'image_downsize' on $id and $size to provide
- * resize services.
*
* @param int $id Attachment ID for image.
* @param array|string $size Optional, default is 'medium'. Size of image, either array or string.
if ( !wp_attachment_is_image($id) )
return false;
+ /**
+ * Filter whether to preempt the output of image_downsize().
+ *
+ * Passing a truthy value to the filter will effectively short-circuit
+ * down-sizing the image, returning that value as output instead.
+ *
+ * @since 2.5.0
+ *
+ * @param bool $downsize Whether to short-circuit the image downsize. Default false.
+ * @param int $id Attachment ID for image.
+ * @param array|string $size Size of image, either array or string. Default 'medium'.
+ */
+ if ( $out = apply_filters( 'image_downsize', false, $id, $size ) ) {
+ return $out;
+ }
+
$img_url = wp_get_attachment_url($id);
$meta = wp_get_attachment_metadata($id);
$width = $height = 0;
$is_intermediate = false;
$img_url_basename = wp_basename($img_url);
- // plugins can use this to provide resize services
- if ( $out = apply_filters('image_downsize', false, $id, $size) )
- return $out;
-
// try for a new style intermediate size
if ( $intermediate = image_get_intermediate_size($id, $size) ) {
$img_url = str_replace($img_url_basename, $intermediate['file'], $img_url);
$is_intermediate = true;
}
}
- if ( !$width && !$height && isset($meta['width'], $meta['height']) ) {
+ if ( !$width && !$height && isset( $meta['width'], $meta['height'] ) ) {
// any other type: use the real image
$width = $meta['width'];
$height = $meta['height'];
}
/**
- * Registers a new image size
+ * Register a new image size.
+ *
+ * Cropping behavior for the image size is dependent on the value of $crop:
+ * 1. If false (default), images will be scaled, not cropped.
+ * 2. If an array in the form of array( x_crop_position, y_crop_position ):
+ * - x_crop_position accepts 'left' 'center', or 'right'.
+ * - y_crop_position accepts 'top', 'center', or 'bottom'.
+ * Images will be cropped to the specified dimensions within the defined crop area.
+ * 3. If true, images will be cropped to the specified dimensions using center positions.
+ *
+ * @since 2.9.0
+ *
+ * @global array $_wp_additional_image_sizes Associative array of additional image sizes.
+ *
+ * @param string $name Image size identifier.
+ * @param int $width Image width in pixels.
+ * @param int $height Image height in pixels.
+ * @param bool|array $crop Optional. Whether to crop images to specified height and width or resize.
+ * An array can specify positioning of the crop area. Default false.
*/
function add_image_size( $name, $width = 0, $height = 0, $crop = false ) {
global $_wp_additional_image_sizes;
- $_wp_additional_image_sizes[$name] = array( 'width' => absint( $width ), 'height' => absint( $height ), 'crop' => (bool) $crop );
+
+ $_wp_additional_image_sizes[ $name ] = array(
+ 'width' => absint( $width ),
+ 'height' => absint( $height ),
+ 'crop' => $crop,
+ );
+}
+
+/**
+ * Check if an image size exists.
+ *
+ * @since 3.9.0
+ *
+ * @param string $name The image size to check.
+ * @return bool True if the image size exists, false if not.
+ */
+function has_image_size( $name ) {
+ global $_wp_additional_image_sizes;
+
+ return isset( $_wp_additional_image_sizes[ $name ] );
+}
+
+/**
+ * Remove a new image size.
+ *
+ * @since 3.9.0
+ *
+ * @param string $name The image size to remove.
+ * @return bool True if the image size was successfully removed, false on failure.
+ */
+function remove_image_size( $name ) {
+ global $_wp_additional_image_sizes;
+
+ if ( isset( $_wp_additional_image_sizes[ $name ] ) ) {
+ unset( $_wp_additional_image_sizes[ $name ] );
+ return true;
+ }
+
+ return false;
}
/**
- * Registers an image size for the post thumbnail
+ * Registers an image size for the post thumbnail.
+ *
+ * @since 2.9.0
+ *
+ * @see add_image_size() for details on cropping behavior.
+ *
+ * @param int $width Image width in pixels.
+ * @param int $height Image height in pixels.
+ * @param bool|array $crop Optional. Whether to crop images to specified height and width or resize.
+ * An array can specify positioning of the crop area. Default false.
*/
function set_post_thumbnail_size( $width = 0, $height = 0, $crop = false ) {
add_image_size( 'post-thumbnail', $width, $height, $crop );
*
* @since 2.5.0
*
- * @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.
list( $img_src, $width, $height ) = image_downsize($id, $size);
$hwstring = image_hwstring($width, $height);
+ $title = $title ? 'title="' . esc_attr( $title ) . '" ' : '';
+
$class = 'align' . esc_attr($align) .' size-' . esc_attr($size) . ' wp-image-' . $id;
- $class = apply_filters('get_image_tag_class', $class, $id, $align, $size);
- $html = '<img src="' . esc_attr($img_src) . '" alt="' . esc_attr($alt) . '" title="' . esc_attr($title).'" '.$hwstring.'class="'.$class.'" />';
+ /**
+ * Filter the value of the attachment's image tag class attribute.
+ *
+ * @since 2.6.0
+ *
+ * @param string $class CSS class name or space-separated list of classes.
+ * @param int $id Attachment ID.
+ * @param string $align Part of the class name for aligning the image.
+ * @param string $size Optional. Default is 'medium'.
+ */
+ $class = apply_filters( 'get_image_tag_class', $class, $id, $align, $size );
+
+ $html = '<img src="' . esc_attr($img_src) . '" alt="' . esc_attr($alt) . '" ' . $title . $hwstring . 'class="' . $class . '" />';
+ /**
+ * Filter the HTML content for the image tag.
+ *
+ * @since 2.6.0
+ *
+ * @param string $html HTML content for the image.
+ * @param int $id Attachment ID.
+ * @param string $alt Alternate text.
+ * @param string $title Attachment title.
+ * @param string $align Part of the class name for aligning the image.
+ * @param string $size Optional. Default is 'medium'.
+ */
$html = apply_filters( 'get_image_tag', $html, $id, $alt, $title, $align, $size );
return $html;
}
/**
- * Load an image from a string, if PHP supports it.
- *
- * @since 2.1.0
- *
- * @param string $file Filename of the image to load.
- * @return resource The resulting image resource on success, Error string on failure.
- */
-function wp_load_image( $file ) {
- if ( is_numeric( $file ) )
- $file = get_attached_file( $file );
-
- if ( ! file_exists( $file ) )
- return sprintf(__('File “%s” doesn’t exist?'), $file);
-
- if ( ! function_exists('imagecreatefromstring') )
- return __('The GD image library is not installed.');
-
- // Set artificially high because GD uses uncompressed images in memory
- @ini_set( 'memory_limit', apply_filters( 'image_memory_limit', WP_MAX_MEMORY_LIMIT ) );
- $image = imagecreatefromstring( file_get_contents( $file ) );
-
- if ( !is_resource( $image ) )
- return sprintf(__('File “%s” is not an image.'), $file);
-
- return $image;
-}
-
-/**
- * Calculates the new dimentions for a downsampled image.
+ * Calculates the new dimensions for a downsampled image.
*
* If either width or height are empty, no constraint is applied on
* that dimension.
$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 )
+ if ( (int) round( $current_width * $larger_ratio ) > $max_width || (int) round( $current_height * $larger_ratio ) > $max_height ) {
// The larger ratio is too big. It would result in an overflow.
$ratio = $smaller_ratio;
- else
+ } 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 );
+ // Very small dimensions may result in 0, 1 should be the minimum.
+ $w = max ( 1, (int) round( $current_width * $ratio ) );
+ $h = max ( 1, (int) round( $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
- // We also have issues with recursive calls resulting in an ever-changing result. Contraining to the result of a constraint should yield the original result.
+ // 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.
// Thus we look for dimensions that are one pixel shy of the max value and bump them up
- if ( $did_width && $w == $max_width - 1 )
+
+ // Note: $did_width means it is possible $smaller_ratio == $width_ratio.
+ if ( $did_width && $w == $max_width - 1 ) {
$w = $max_width; // Round it up
- if ( $did_height && $h == $max_height - 1 )
+ }
+
+ // Note: $did_height means it is possible $smaller_ratio == $height_ratio.
+ if ( $did_height && $h == $max_height - 1 ) {
$h = $max_height; // Round it up
+ }
- return array( $w, $h );
+ return apply_filters( 'wp_constrain_dimensions', array( $w, $h ), $current_width, $current_height, $max_width, $max_height );
}
/**
- * Retrieve calculated resized dimensions for use in imagecopyresampled().
+ * Retrieve calculated resize dimensions for use in WP_Image_Editor.
+ *
+ * Calculates dimensions and coordinates for a resized image that fits
+ * within a specified width and height.
*
- * 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.
+ * Cropping behavior is dependent on the value of $crop:
+ * 1. If false (default), images will not be cropped.
+ * 2. If an array in the form of array( x_crop_position, y_crop_position ):
+ * - x_crop_position accepts 'left' 'center', or 'right'.
+ * - y_crop_position accepts 'top', 'center', or 'bottom'.
+ * Images will be cropped to the specified dimensions within the defined crop area.
+ * 3. If true, images will be cropped to the specified dimensions using center positions.
*
* @since 2.5.0
*
- * @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.
- * @return bool|array False, on failure. Returned array matches parameters for imagecopyresampled() PHP function.
+ * @param int $orig_w Original width in pixels.
+ * @param int $orig_h Original height in pixels.
+ * @param int $dest_w New width in pixels.
+ * @param int $dest_h New height in pixels.
+ * @param bool|array $crop Optional. Whether to crop image to specified height and width or resize.
+ * An array can specify positioning of the crop area. Default false.
+ * @return bool|array False on failure. Returned array matches parameters for `imagecopyresampled()`.
*/
function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop = false) {
if ($dest_w <= 0 && $dest_h <= 0)
return false;
+ /**
+ * Filter whether to preempt calculating the image resize dimensions.
+ *
+ * Passing a non-null value to the filter will effectively short-circuit
+ * image_resize_dimensions(), returning that value instead.
+ *
+ * @since 3.4.0
+ *
+ * @param null|mixed $null Whether to preempt output of the resize dimensions.
+ * @param int $orig_w Original width in pixels.
+ * @param int $orig_h Original height in pixels.
+ * @param int $dest_w New width in pixels.
+ * @param int $dest_h New height in pixels.
+ * @param bool|array $crop Whether to crop image to specified height and width or resize.
+ * An array can specify positioning of the crop area. Default false.
+ */
+ $output = apply_filters( 'image_resize_dimensions', null, $orig_w, $orig_h, $dest_w, $dest_h, $crop );
+ if ( null !== $output )
+ return $output;
+
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);
- if ( !$new_w ) {
- $new_w = intval($new_h * $aspect_ratio);
+ if ( ! $new_w ) {
+ $new_w = (int) round( $new_h * $aspect_ratio );
}
- if ( !$new_h ) {
- $new_h = intval($new_w / $aspect_ratio);
+ if ( ! $new_h ) {
+ $new_h = (int) round( $new_w / $aspect_ratio );
}
$size_ratio = max($new_w / $orig_w, $new_h / $orig_h);
$crop_w = round($new_w / $size_ratio);
$crop_h = round($new_h / $size_ratio);
- $s_x = floor( ($orig_w - $crop_w) / 2 );
- $s_y = floor( ($orig_h - $crop_h) / 2 );
+ if ( ! is_array( $crop ) || count( $crop ) !== 2 ) {
+ $crop = array( 'center', 'center' );
+ }
+
+ list( $x, $y ) = $crop;
+
+ if ( 'left' === $x ) {
+ $s_x = 0;
+ } elseif ( 'right' === $x ) {
+ $s_x = $orig_w - $crop_w;
+ } else {
+ $s_x = floor( ( $orig_w - $crop_w ) / 2 );
+ }
+
+ if ( 'top' === $y ) {
+ $s_y = 0;
+ } elseif ( 'bottom' === $y ) {
+ $s_y = $orig_h - $crop_h;
+ } else {
+ $s_y = floor( ( $orig_h - $crop_h ) / 2 );
+ }
} else {
// don't crop, just resize using $dest_w x $dest_h as a maximum bounding box
$crop_w = $orig_w;
}
// if the resulting image would be the same size or larger we don't want to resize it
- if ( $new_w >= $orig_w && $new_h >= $orig_h )
+ if ( $new_w >= $orig_w && $new_h >= $orig_h && $dest_w != $orig_w && $dest_h != $orig_h ) {
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
}
-/**
- * Scale down an image to fit a particular size and save a new copy of the image.
- *
- * The PNG transparency will be preserved using the function, as well as the
- * image type. If the file going in is PNG, then the resized image is going to
- * be PNG. The only supported image types are PNG, GIF, and JPEG.
- *
- * Some functionality requires API to exist, so some PHP version may lose out
- * support. This is not the fault of WordPress (where functionality is
- * downgraded, not actual defects), but of your PHP version.
- *
- * @since 2.5.0
- *
- * @param string $file Image file path.
- * @param int $max_w Maximum width to resize to.
- * @param int $max_h Maximum height to resize to.
- * @param bool $crop Optional. Whether to crop image or resize.
- * @param string $suffix Optional. File Suffix.
- * @param string $dest_path Optional. New image file path.
- * @param int $jpeg_quality Optional, default is 90. Image quality percentage.
- * @return mixed WP_Error on failure. String with new destination path.
- */
-function image_resize( $file, $max_w, $max_h, $crop = false, $suffix = null, $dest_path = null, $jpeg_quality = 90 ) {
-
- $image = wp_load_image( $file );
- if ( !is_resource( $image ) )
- return new WP_Error( 'error_loading_image', $image, $file );
-
- $size = @getimagesize( $file );
- if ( !$size )
- return new WP_Error('invalid_image', __('Could not read image size'), $file);
- list($orig_w, $orig_h, $orig_type) = $size;
-
- $dims = image_resize_dimensions($orig_w, $orig_h, $max_w, $max_h, $crop);
- if ( !$dims )
- return new WP_Error( 'error_getting_dimensions', __('Could not calculate resized image dimensions') );
- list($dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h) = $dims;
-
- $newimage = wp_imagecreatetruecolor( $dst_w, $dst_h );
-
- imagecopyresampled( $newimage, $image, $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h);
-
- // convert from full colors to index colors, like original PNG.
- if ( IMAGETYPE_PNG == $orig_type && function_exists('imageistruecolor') && !imageistruecolor( $image ) )
- imagetruecolortopalette( $newimage, false, imagecolorstotal( $image ) );
-
- // we don't need the original in memory anymore
- imagedestroy( $image );
-
- // $suffix will be appended to the destination filename, just before the extension
- if ( !$suffix )
- $suffix = "{$dst_w}x{$dst_h}";
-
- $info = pathinfo($file);
- $dir = $info['dirname'];
- $ext = $info['extension'];
- $name = wp_basename($file, ".$ext");
-
- if ( !is_null($dest_path) and $_dest_path = realpath($dest_path) )
- $dir = $_dest_path;
- $destfilename = "{$dir}/{$name}-{$suffix}.{$ext}";
-
- if ( IMAGETYPE_GIF == $orig_type ) {
- if ( !imagegif( $newimage, $destfilename ) )
- return new WP_Error('resize_path_invalid', __( 'Resize path invalid' ));
- } elseif ( IMAGETYPE_PNG == $orig_type ) {
- if ( !imagepng( $newimage, $destfilename ) )
- return new WP_Error('resize_path_invalid', __( 'Resize path invalid' ));
- } else {
- // all other formats are converted to jpg
- $destfilename = "{$dir}/{$name}-{$suffix}.jpg";
- if ( !imagejpeg( $newimage, $destfilename, apply_filters( 'jpeg_quality', $jpeg_quality, 'image_resize' ) ) )
- return new WP_Error('resize_path_invalid', __( 'Resize path invalid' ));
- }
-
- imagedestroy( $newimage );
-
- // Set correct file permissions
- $stat = stat( dirname( $destfilename ));
- $perms = $stat['mode'] & 0000666; //same permissions as parent folder, strip off the executable bits
- @ chmod( $destfilename, $perms );
-
- return $destfilename;
-}
-
/**
* Resize an image to make a thumbnail or intermediate size.
*
* @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.
*/
-function image_make_intermediate_size($file, $width, $height, $crop=false) {
+function image_make_intermediate_size( $file, $width, $height, $crop = false ) {
if ( $width || $height ) {
- $resized_file = image_resize($file, $width, $height, $crop);
- if ( !is_wp_error($resized_file) && $resized_file && $info = getimagesize($resized_file) ) {
- $resized_file = apply_filters('image_make_intermediate_size', $resized_file);
- return array(
- 'file' => wp_basename( $resized_file ),
- 'width' => $info[0],
- 'height' => $info[1],
- );
+ $editor = wp_get_image_editor( $file );
+
+ if ( is_wp_error( $editor ) || is_wp_error( $editor->resize( $width, $height, $crop ) ) )
+ return false;
+
+ $resized_file = $editor->save();
+
+ if ( ! is_wp_error( $resized_file ) && $resized_file ) {
+ unset( $resized_file['path'] );
+ return $resized_file;
}
}
return false;
if ( isset( $_wp_additional_image_sizes ) && count( $_wp_additional_image_sizes ) )
$image_sizes = array_merge( $image_sizes, array_keys( $_wp_additional_image_sizes ) );
+ /**
+ * Filter the list of intermediate image sizes.
+ *
+ * @since 2.5.0
+ *
+ * @param array $image_sizes An array of intermediate image sizes. Defaults
+ * are 'thumbnail', 'medium', 'large'.
+ */
return apply_filters( 'intermediate_image_sizes', $image_sizes );
}
$src = false;
if ( $icon && $src = wp_mime_type_icon($attachment_id) ) {
- $icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/crystal' );
+ /** This filter is documented in wp-includes/post.php */
+ $icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/media' );
$src_file = $icon_dir . '/' . wp_basename($src);
@list($width, $height) = getimagesize($src_file);
}
* efficient than having to find the closest-sized image and then having the
* browser scale down the image.
*
- * @see add_image_size()
- * @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
* @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.
+ * @see add_image_size()
+ *
+ * @param int $attachment_id Image attachment ID.
+ * @param string|array $size Optional. Default 'thumbnail'.
+ * @param bool $icon Optional. Whether it is an icon. Default false.
+ * @param string|array $attr Optional. Attributes for the image markup. Default empty string.
* @return string HTML img element or empty string on failure.
*/
function wp_get_attachment_image($attachment_id, $size = 'thumbnail', $icon = false, $attr = '') {
if ( $image ) {
list($src, $width, $height) = $image;
$hwstring = image_hwstring($width, $height);
- if ( is_array($size) )
- $size = join('x', $size);
- $attachment =& get_post($attachment_id);
+ $size_class = $size;
+ if ( is_array( $size_class ) ) {
+ $size_class = join( 'x', $size_class );
+ }
+ $attachment = get_post($attachment_id);
$default_attr = array(
'src' => $src,
- 'class' => "attachment-$size",
+ 'class' => "attachment-$size_class",
'alt' => trim(strip_tags( get_post_meta($attachment_id, '_wp_attachment_image_alt', true) )), // Use Alt field first
- 'title' => trim(strip_tags( $attachment->post_title )),
);
if ( empty($default_attr['alt']) )
$default_attr['alt'] = trim(strip_tags( $attachment->post_excerpt )); // If not, Use the Caption
$default_attr['alt'] = trim(strip_tags( $attachment->post_title )); // Finally, use the title
$attr = wp_parse_args($attr, $default_attr);
- $attr = apply_filters( 'wp_get_attachment_image_attributes', $attr, $attachment );
+
+ /**
+ * Filter the list of attachment image attributes.
+ *
+ * @since 2.8.0
+ *
+ * @param array $attr Attributes for the image markup.
+ * @param WP_Post $attachment Image attachment post.
+ * @param string|array $size Requested size.
+ */
+ $attr = apply_filters( 'wp_get_attachment_image_attributes', $attr, $attachment, $size );
$attr = array_map( 'esc_attr', $attr );
$html = rtrim("<img $hwstring");
foreach ( $attr as $name => $value ) {
}
/**
- * Adds a 'wp-post-image' class to post thumbnail thumbnails
+ * Adds a 'wp-post-image' class to post thumbnails
* Uses the begin_fetch_post_thumbnail_html and end_fetch_post_thumbnail_html action hooks to
- * dynamically add/remove itself so as to only filter post thumbnail thumbnails
+ * dynamically add/remove itself so as to only filter post thumbnails
*
* @since 2.9.0
* @param array $attr Attributes including src, class, alt, title
*
* @since 2.6.0
*
- * @param array $attr Attributes attributed to the shortcode.
+ * @param array $attr {
+ * Attributes of the caption shortcode.
+ *
+ * @type string $id ID of the div element for the caption.
+ * @type string $align Class name that aligns the caption. Default 'alignnone'. Accepts 'alignleft',
+ * 'aligncenter', alignright', 'alignnone'.
+ * @type int $width The width of the caption, in pixels.
+ * @type string $caption The caption text.
+ * @type string $class Additional class name(s) added to the caption container.
+ * }
* @param string $content Optional. Shortcode content.
- * @return string
+ * @return string HTML content to display the caption.
*/
-function img_caption_shortcode($attr, $content = null) {
+function img_caption_shortcode( $attr, $content = null ) {
+ // 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] );
+ }
+ }
- // Allow plugins/themes to override the default caption template.
- $output = apply_filters('img_caption_shortcode', '', $attr, $content);
+ /**
+ * Filter the default caption shortcode output.
+ *
+ * If the filtered output isn't empty, it will be used instead of generating
+ * the default caption template.
+ *
+ * @since 2.6.0
+ *
+ * @see img_caption_shortcode()
+ *
+ * @param string $output The caption output. Default empty.
+ * @param array $attr Attributes of the caption shortcode.
+ * @param string $content The image element, possibly wrapped in a hyperlink.
+ */
+ $output = apply_filters( 'img_caption_shortcode', '', $attr, $content );
if ( $output != '' )
return $output;
- extract(shortcode_atts(array(
- 'id' => '',
- 'align' => 'alignnone',
- 'width' => '',
- 'caption' => ''
- ), $attr));
+ $atts = shortcode_atts( array(
+ 'id' => '',
+ 'align' => 'alignnone',
+ 'width' => '',
+ 'caption' => '',
+ 'class' => '',
+ ), $attr, 'caption' );
- if ( 1 > (int) $width || empty($caption) )
+ $atts['width'] = (int) $atts['width'];
+ if ( $atts['width'] < 1 || empty( $atts['caption'] ) )
return $content;
- if ( $id ) $id = 'id="' . esc_attr($id) . '" ';
+ if ( ! empty( $atts['id'] ) )
+ $atts['id'] = 'id="' . esc_attr( $atts['id'] ) . '" ';
+
+ $class = trim( 'wp-caption ' . $atts['align'] . ' ' . $atts['class'] );
+
+ if ( current_theme_supports( 'html5', 'caption' ) ) {
+ return '<figure ' . $atts['id'] . 'style="width: ' . (int) $atts['width'] . 'px;" class="' . esc_attr( $class ) . '">'
+ . do_shortcode( $content ) . '<figcaption class="wp-caption-text">' . $atts['caption'] . '</figcaption></figure>';
+ }
+
+ $caption_width = 10 + $atts['width'];
+
+ /**
+ * Filter the width of an image's caption.
+ *
+ * By default, the caption is 10 pixels greater than the width of the image,
+ * to prevent post content from running up against a floated image.
+ *
+ * @since 3.7.0
+ *
+ * @see img_caption_shortcode()
+ *
+ * @param int $caption_width Width of the caption in pixels. To remove this inline style,
+ * return zero.
+ * @param array $atts Attributes of the caption shortcode.
+ * @param string $content The image element, possibly wrapped in a hyperlink.
+ */
+ $caption_width = apply_filters( 'img_caption_shortcode_width', $caption_width, $atts, $content );
+
+ $style = '';
+ if ( $caption_width )
+ $style = 'style="width: ' . (int) $caption_width . 'px" ';
- return '<div ' . $id . 'class="wp-caption ' . esc_attr($align) . '" style="width: ' . (10 + (int) $width) . 'px">'
- . do_shortcode( $content ) . '<p class="wp-caption-text">' . $caption . '</p></div>';
+ return '<div ' . $atts['id'] . $style . 'class="' . esc_attr( $class ) . '">'
+ . do_shortcode( $content ) . '<p class="wp-caption-text">' . $atts['caption'] . '</p></div>';
}
add_shortcode('gallery', 'gallery_shortcode');
*
* @since 2.5.0
*
- * @param array $attr Attributes attributed to the shortcode.
+ * @param array $attr {
+ * Attributes of the gallery shortcode.
+ *
+ * @type string $order Order of the images in the gallery. Default 'ASC'. Accepts 'ASC', 'DESC'.
+ * @type string $orderby The field to use when ordering the images. Default 'menu_order ID'.
+ * Accepts any valid SQL ORDERBY statement.
+ * @type int $id Post ID.
+ * @type string $itemtag HTML tag to use for each image in the gallery.
+ * Default 'dl', or 'figure' when the theme registers HTML5 gallery support.
+ * @type string $icontag HTML tag to use for each image's icon.
+ * Default 'dt', or 'div' when the theme registers HTML5 gallery support.
+ * @type string $captiontag HTML tag to use for each image's caption.
+ * Default 'dd', or 'figcaption' when the theme registers HTML5 gallery support.
+ * @type int $columns Number of columns of images to display. Default 3.
+ * @type string $size Size of the images to display. Default 'thumbnail'.
+ * @type string $ids A comma-separated list of IDs of attachments to display. Default empty.
+ * @type string $include A comma-separated list of IDs of attachments to include. Default empty.
+ * @type string $exclude A comma-separated list of IDs of attachments to exclude. Default empty.
+ * @type string $link What to link each image to. Default empty (links to the attachment page).
+ * Accepts 'file', 'none'.
+ * }
* @return string HTML content to display gallery.
*/
-function gallery_shortcode($attr) {
- global $post, $wp_locale;
+function gallery_shortcode( $attr ) {
+ $post = get_post();
static $instance = 0;
$instance++;
- // Allow plugins/themes to override the default gallery template.
- $output = apply_filters('post_gallery', '', $attr);
- if ( $output != '' )
- return $output;
+ if ( ! empty( $attr['ids'] ) ) {
+ // 'ids' is explicitly ordered, unless you specify otherwise.
+ if ( empty( $attr['orderby'] ) ) {
+ $attr['orderby'] = 'post__in';
+ }
+ $attr['include'] = $attr['ids'];
+ }
- // 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'] );
+ /**
+ * Filter the default gallery shortcode output.
+ *
+ * If the filtered output isn't empty, it will be used instead of generating
+ * the default gallery template.
+ *
+ * @since 2.5.0
+ *
+ * @see gallery_shortcode()
+ *
+ * @param string $output The gallery output. Default empty.
+ * @param array $attr Attributes of the gallery shortcode.
+ */
+ $output = apply_filters( 'post_gallery', '', $attr );
+ if ( $output != '' ) {
+ return $output;
}
- extract(shortcode_atts(array(
+ $html5 = current_theme_supports( 'html5', 'gallery' );
+ $atts = shortcode_atts( array(
'order' => 'ASC',
'orderby' => 'menu_order ID',
- 'id' => $post->ID,
- 'itemtag' => 'dl',
- 'icontag' => 'dt',
- 'captiontag' => 'dd',
+ 'id' => $post ? $post->ID : 0,
+ 'itemtag' => $html5 ? 'figure' : 'dl',
+ 'icontag' => $html5 ? 'div' : 'dt',
+ 'captiontag' => $html5 ? 'figcaption' : 'dd',
'columns' => 3,
'size' => 'thumbnail',
'include' => '',
- 'exclude' => ''
- ), $attr));
+ 'exclude' => '',
+ 'link' => ''
+ ), $attr, 'gallery' );
- $id = intval($id);
- if ( 'RAND' == $order )
- $orderby = 'none';
+ $id = intval( $atts['id'] );
- if ( !empty($include) ) {
- $include = preg_replace( '/[^0-9,]+/', '', $include );
- $_attachments = get_posts( array('include' => $include, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $order, 'orderby' => $orderby) );
+ if ( ! empty( $atts['include'] ) ) {
+ $_attachments = get_posts( array( 'include' => $atts['include'], 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $atts['order'], 'orderby' => $atts['orderby'] ) );
$attachments = array();
foreach ( $_attachments as $key => $val ) {
$attachments[$val->ID] = $_attachments[$key];
}
- } elseif ( !empty($exclude) ) {
- $exclude = preg_replace( '/[^0-9,]+/', '', $exclude );
- $attachments = get_children( array('post_parent' => $id, 'exclude' => $exclude, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $order, 'orderby' => $orderby) );
+ } elseif ( ! empty( $atts['exclude'] ) ) {
+ $attachments = get_children( array( 'post_parent' => $id, 'exclude' => $atts['exclude'], 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $atts['order'], 'orderby' => $atts['orderby'] ) );
} else {
- $attachments = get_children( array('post_parent' => $id, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $order, 'orderby' => $orderby) );
+ $attachments = get_children( array( 'post_parent' => $id, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $atts['order'], 'orderby' => $atts['orderby'] ) );
}
- if ( empty($attachments) )
+ if ( empty( $attachments ) ) {
return '';
+ }
if ( is_feed() ) {
$output = "\n";
- foreach ( $attachments as $att_id => $attachment )
- $output .= wp_get_attachment_link($att_id, $size, true) . "\n";
+ foreach ( $attachments as $att_id => $attachment ) {
+ $output .= wp_get_attachment_link( $att_id, $atts['size'], true ) . "\n";
+ }
return $output;
}
- $itemtag = tag_escape($itemtag);
- $captiontag = tag_escape($captiontag);
- $columns = intval($columns);
+ $itemtag = tag_escape( $atts['itemtag'] );
+ $captiontag = tag_escape( $atts['captiontag'] );
+ $icontag = tag_escape( $atts['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';
+ }
+
+ $columns = intval( $atts['columns'] );
$itemwidth = $columns > 0 ? floor(100/$columns) : 100;
$float = is_rtl() ? 'right' : 'left';
$selector = "gallery-{$instance}";
- $gallery_style = $gallery_div = '';
- if ( apply_filters( 'use_default_gallery_style', true ) )
+ $gallery_style = '';
+
+ /**
+ * Filter whether to print default gallery styles.
+ *
+ * @since 3.1.0
+ *
+ * @param bool $print Whether to print default gallery styles.
+ * Defaults to false if the theme supports HTML5 galleries.
+ * Otherwise, defaults to true.
+ */
+ if ( apply_filters( 'use_default_gallery_style', ! $html5 ) ) {
$gallery_style = "
<style type='text/css'>
#{$selector} {
#{$selector} .gallery-caption {
margin-left: 0;
}
- </style>
- <!-- see gallery_shortcode() in wp-includes/media.php -->";
- $size_class = sanitize_html_class( $size );
+ /* see gallery_shortcode() in wp-includes/media.php */
+ </style>\n\t\t";
+ }
+
+ $size_class = sanitize_html_class( $atts['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 );
+
+ /**
+ * Filter the default gallery shortcode CSS styles.
+ *
+ * @since 2.5.0
+ *
+ * @param string $gallery_style Default CSS styles and opening HTML div container
+ * for the gallery shortcode output.
+ */
+ $output = apply_filters( 'gallery_style', $gallery_style . $gallery_div );
$i = 0;
foreach ( $attachments as $id => $attachment ) {
- $link = isset($attr['link']) && 'file' == $attr['link'] ? wp_get_attachment_link($id, $size, false, false) : wp_get_attachment_link($id, $size, true, false);
+ $attr = ( trim( $attachment->post_excerpt ) ) ? array( 'aria-describedby' => "$selector-$id" ) : '';
+ if ( ! empty( $atts['link'] ) && 'file' === $atts['link'] ) {
+ $image_output = wp_get_attachment_link( $id, $atts['size'], false, false, false, $attr );
+ } elseif ( ! empty( $atts['link'] ) && 'none' === $atts['link'] ) {
+ $image_output = wp_get_attachment_image( $id, $atts['size'], false, $attr );
+ } else {
+ $image_output = wp_get_attachment_link( $id, $atts['size'], true, false, false, $attr );
+ }
+ $image_meta = wp_get_attachment_metadata( $id );
+
+ $orientation = '';
+ if ( isset( $image_meta['height'], $image_meta['width'] ) ) {
+ $orientation = ( $image_meta['height'] > $image_meta['width'] ) ? 'portrait' : 'landscape';
+ }
$output .= "<{$itemtag} class='gallery-item'>";
$output .= "
- <{$icontag} class='gallery-icon'>
- $link
+ <{$icontag} class='gallery-icon {$orientation}'>
+ $image_output
</{$icontag}>";
if ( $captiontag && trim($attachment->post_excerpt) ) {
$output .= "
- <{$captiontag} class='wp-caption-text gallery-caption'>
+ <{$captiontag} class='wp-caption-text gallery-caption' id='$selector-$id'>
" . wptexturize($attachment->post_excerpt) . "
</{$captiontag}>";
}
$output .= "</{$itemtag}>";
- if ( $columns > 0 && ++$i % $columns == 0 )
+ if ( ! $html5 && $columns > 0 && ++$i % $columns == 0 ) {
$output .= '<br style="clear: both" />';
+ }
+ }
+
+ if ( ! $html5 && $columns > 0 && $i % $columns !== 0 ) {
+ $output .= "
+ <br style='clear: both' />";
}
$output .= "
- <br style='clear: both;' />
</div>\n";
return $output;
}
/**
- * Display previous image link that has the same post parent.
- *
- * @since 2.5.0
- * @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.
- */
-function previous_image_link($size = 'thumbnail', $text = false) {
- adjacent_image_link(true, $size, $text);
-}
-
-/**
- * Display next image link that has the same post parent.
+ * Output the templates used by playlists.
*
- * @since 2.5.0
- * @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.
+ * @since 3.9.0
*/
-function next_image_link($size = 'thumbnail', $text = false) {
- adjacent_image_link(false, $size, $text);
+function wp_underscore_playlist_templates() {
+?>
+<script type="text/html" id="tmpl-wp-playlist-current-item">
+ <# if ( data.image ) { #>
+ <img src="{{ data.thumb.src }}"/>
+ <# } #>
+ <div class="wp-playlist-caption">
+ <span class="wp-playlist-item-meta wp-playlist-item-title">“{{ data.title }}”</span>
+ <# if ( data.meta.album ) { #><span class="wp-playlist-item-meta wp-playlist-item-album">{{ data.meta.album }}</span><# } #>
+ <# if ( data.meta.artist ) { #><span class="wp-playlist-item-meta wp-playlist-item-artist">{{ data.meta.artist }}</span><# } #>
+ </div>
+</script>
+<script type="text/html" id="tmpl-wp-playlist-item">
+ <div class="wp-playlist-item">
+ <a class="wp-playlist-caption" href="{{ data.src }}">
+ {{ data.index ? ( data.index + '. ' ) : '' }}
+ <# if ( data.caption ) { #>
+ {{ data.caption }}
+ <# } else { #>
+ <span class="wp-playlist-item-title">“{{{ data.title }}}”</span>
+ <# if ( data.artists && data.meta.artist ) { #>
+ <span class="wp-playlist-item-artist"> — {{ data.meta.artist }}</span>
+ <# } #>
+ <# } #>
+ </a>
+ <# if ( data.meta.length_formatted ) { #>
+ <div class="wp-playlist-item-length">{{ data.meta.length_formatted }}</div>
+ <# } #>
+ </div>
+</script>
+<?php
}
/**
- * Display next or previous image link that has the same post parent.
- *
- * Retrieves the current attachment object from the $post global.
+ * Output and enqueue default scripts and styles for playlists.
*
- * @since 2.5.0
+ * @since 3.9.0
*
- * @param bool $prev Optional. Default is true to display previous link, true for next.
+ * @param string $type Type of playlist. Accepts 'audio' or 'video'.
*/
-function adjacent_image_link($prev = true, $size = 'thumbnail', $text = false) {
- global $post;
- $post = get_post($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') ));
-
- foreach ( $attachments as $k => $attachment )
- if ( $attachment->ID == $post->ID )
- break;
-
- $k = $prev ? $k - 1 : $k + 1;
-
- if ( isset($attachments[$k]) )
- echo wp_get_attachment_link($attachments[$k]->ID, $size, true, false, $text);
+function wp_playlist_scripts( $type ) {
+ wp_enqueue_style( 'wp-mediaelement' );
+ wp_enqueue_script( 'wp-playlist' );
+?>
+<!--[if lt IE 9]><script>document.createElement('<?php echo esc_js( $type ) ?>');</script><![endif]-->
+<?php
+ add_action( 'wp_footer', 'wp_underscore_playlist_templates', 0 );
+ add_action( 'admin_footer', 'wp_underscore_playlist_templates', 0 );
}
+add_action( 'wp_playlist_scripts', 'wp_playlist_scripts' );
/**
- * 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.
+ * The playlist shortcode.
+ *
+ * This implements the functionality of the playlist shortcode for displaying
+ * a collection of WordPress audio or video files in a post.
+ *
+ * @since 3.9.0
+ *
+ * @param array $attr {
+ * Array of default playlist attributes.
+ *
+ * @type string $type Type of playlist to display. Accepts 'audio' or 'video'. Default 'audio'.
+ * @type string $order Designates ascending or descending order of items in the playlist.
+ * Accepts 'ASC', 'DESC'. Default 'ASC'.
+ * @type string $orderby Any column, or columns, to sort the playlist. If $ids are
+ * passed, this defaults to the order of the $ids array ('post__in').
+ * Otherwise default is 'menu_order ID'.
+ * @type int $id If an explicit $ids array is not present, this parameter
+ * will determine which attachments are used for the playlist.
+ * Default is the current post ID.
+ * @type array $ids Create a playlist out of these explicit attachment IDs. If empty,
+ * a playlist will be created from all $type attachments of $id.
+ * Default empty.
+ * @type array $exclude List of specific attachment IDs to exclude from the playlist. Default empty.
+ * @type string $style Playlist style to use. Accepts 'light' or 'dark'. Default 'light'.
+ * @type bool $tracklist Whether to show or hide the playlist. Default true.
+ * @type bool $tracknumbers Whether to show or hide the numbers next to entries in the playlist. Default true.
+ * @type bool $images Show or hide the video or audio thumbnail (Featured Image/post
+ * thumbnail). Default true.
+ * @type bool $artists Whether to show or hide artist name in the playlist. Default true.
+ * }
+ *
+ * @return string Playlist output. Empty string if the passed type is unsupported.
*/
-function get_attachment_taxonomies($attachment) {
- if ( is_int( $attachment ) )
- $attachment = get_post($attachment);
- else if ( is_array($attachment) )
- $attachment = (object) $attachment;
+function wp_playlist_shortcode( $attr ) {
+ global $content_width;
+ $post = get_post();
- if ( ! is_object($attachment) )
- return array();
+ static $instance = 0;
+ $instance++;
- $filename = basename($attachment->guid);
+ if ( ! empty( $attr['ids'] ) ) {
+ // 'ids' is explicitly ordered, unless you specify otherwise.
+ if ( empty( $attr['orderby'] ) ) {
+ $attr['orderby'] = 'post__in';
+ }
+ $attr['include'] = $attr['ids'];
+ }
- $objects = array('attachment');
+ /**
+ * Filter the playlist output.
+ *
+ * Passing a non-empty value to the filter will short-circuit generation
+ * of the default playlist output, returning the passed value instead.
+ *
+ * @since 3.9.0
+ *
+ * @param string $output Playlist output. Default empty.
+ * @param array $attr An array of shortcode attributes.
+ */
+ $output = apply_filters( 'post_playlist', '', $attr );
+ if ( $output != '' ) {
+ return $output;
+ }
- 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";
+ $atts = shortcode_atts( array(
+ 'type' => 'audio',
+ 'order' => 'ASC',
+ 'orderby' => 'menu_order ID',
+ 'id' => $post ? $post->ID : 0,
+ 'include' => '',
+ 'exclude' => '',
+ 'style' => 'light',
+ 'tracklist' => true,
+ 'tracknumbers' => true,
+ 'images' => true,
+ 'artists' => true
+ ), $attr, 'playlist' );
+
+ $id = intval( $atts['id'] );
+
+ if ( $atts['type'] !== 'audio' ) {
+ $atts['type'] = 'video';
}
- $taxonomies = array();
- foreach ( $objects as $object )
- if ( $taxes = get_object_taxonomies($object) )
- $taxonomies = array_merge($taxonomies, $taxes);
+ $args = array(
+ 'post_status' => 'inherit',
+ 'post_type' => 'attachment',
+ 'post_mime_type' => $atts['type'],
+ 'order' => $atts['order'],
+ 'orderby' => $atts['orderby']
+ );
- return array_unique($taxonomies);
-}
+ if ( ! empty( $atts['include'] ) ) {
+ $args['include'] = $atts['include'];
+ $_attachments = get_posts( $args );
-/**
- * Check if the installed version of GD supports particular image type
- *
- * @since 2.9.0
- *
- * @param string $mime_type
- * @return bool
- */
-function gd_edit_image_support($mime_type) {
- if ( function_exists('imagetypes') ) {
- switch( $mime_type ) {
- case 'image/jpeg':
- return (imagetypes() & IMG_JPG) != 0;
- case 'image/png':
- return (imagetypes() & IMG_PNG) != 0;
- case 'image/gif':
- return (imagetypes() & IMG_GIF) != 0;
+ $attachments = array();
+ foreach ( $_attachments as $key => $val ) {
+ $attachments[$val->ID] = $_attachments[$key];
}
+ } elseif ( ! empty( $atts['exclude'] ) ) {
+ $args['post_parent'] = $id;
+ $args['exclude'] = $atts['exclude'];
+ $attachments = get_children( $args );
} else {
- switch( $mime_type ) {
- case 'image/jpeg':
- return function_exists('imagecreatefromjpeg');
- case 'image/png':
- return function_exists('imagecreatefrompng');
- case 'image/gif':
- return function_exists('imagecreatefromgif');
- }
+ $args['post_parent'] = $id;
+ $attachments = get_children( $args );
}
- return false;
+
+ if ( empty( $attachments ) ) {
+ return '';
+ }
+
+ if ( is_feed() ) {
+ $output = "\n";
+ foreach ( $attachments as $att_id => $attachment ) {
+ $output .= wp_get_attachment_link( $att_id ) . "\n";
+ }
+ return $output;
+ }
+
+ $outer = 22; // default padding and border of wrapper
+
+ $default_width = 640;
+ $default_height = 360;
+
+ $theme_width = empty( $content_width ) ? $default_width : ( $content_width - $outer );
+ $theme_height = empty( $content_width ) ? $default_height : round( ( $default_height * $theme_width ) / $default_width );
+
+ $data = array(
+ 'type' => $atts['type'],
+ // don't pass strings to JSON, will be truthy in JS
+ 'tracklist' => wp_validate_boolean( $atts['tracklist'] ),
+ 'tracknumbers' => wp_validate_boolean( $atts['tracknumbers'] ),
+ 'images' => wp_validate_boolean( $atts['images'] ),
+ 'artists' => wp_validate_boolean( $atts['artists'] ),
+ );
+
+ $tracks = array();
+ foreach ( $attachments as $attachment ) {
+ $url = wp_get_attachment_url( $attachment->ID );
+ $ftype = wp_check_filetype( $url, wp_get_mime_types() );
+ $track = array(
+ 'src' => $url,
+ 'type' => $ftype['type'],
+ 'title' => $attachment->post_title,
+ 'caption' => $attachment->post_excerpt,
+ 'description' => $attachment->post_content
+ );
+
+ $track['meta'] = array();
+ $meta = wp_get_attachment_metadata( $attachment->ID );
+ if ( ! empty( $meta ) ) {
+
+ foreach ( wp_get_attachment_id3_keys( $attachment ) as $key => $label ) {
+ if ( ! empty( $meta[ $key ] ) ) {
+ $track['meta'][ $key ] = $meta[ $key ];
+ }
+ }
+
+ if ( 'video' === $atts['type'] ) {
+ if ( ! empty( $meta['width'] ) && ! empty( $meta['height'] ) ) {
+ $width = $meta['width'];
+ $height = $meta['height'];
+ $theme_height = round( ( $height * $theme_width ) / $width );
+ } else {
+ $width = $default_width;
+ $height = $default_height;
+ }
+
+ $track['dimensions'] = array(
+ 'original' => compact( 'width', 'height' ),
+ 'resized' => array(
+ 'width' => $theme_width,
+ 'height' => $theme_height
+ )
+ );
+ }
+ }
+
+ if ( $atts['images'] ) {
+ $thumb_id = get_post_thumbnail_id( $attachment->ID );
+ if ( ! empty( $thumb_id ) ) {
+ list( $src, $width, $height ) = wp_get_attachment_image_src( $thumb_id, 'full' );
+ $track['image'] = compact( 'src', 'width', 'height' );
+ list( $src, $width, $height ) = wp_get_attachment_image_src( $thumb_id, 'thumbnail' );
+ $track['thumb'] = compact( 'src', 'width', 'height' );
+ } else {
+ $src = wp_mime_type_icon( $attachment->ID );
+ $width = 48;
+ $height = 64;
+ $track['image'] = compact( 'src', 'width', 'height' );
+ $track['thumb'] = compact( 'src', 'width', 'height' );
+ }
+ }
+
+ $tracks[] = $track;
+ }
+ $data['tracks'] = $tracks;
+
+ $safe_type = esc_attr( $atts['type'] );
+ $safe_style = esc_attr( $atts['style'] );
+
+ ob_start();
+
+ if ( 1 === $instance ) {
+ /**
+ * Print and enqueue playlist scripts, styles, and JavaScript templates.
+ *
+ * @since 3.9.0
+ *
+ * @param string $type Type of playlist. Possible values are 'audio' or 'video'.
+ * @param string $style The 'theme' for the playlist. Core provides 'light' and 'dark'.
+ */
+ do_action( 'wp_playlist_scripts', $atts['type'], $atts['style'] );
+ } ?>
+<div class="wp-playlist wp-<?php echo $safe_type ?>-playlist wp-playlist-<?php echo $safe_style ?>">
+ <?php if ( 'audio' === $atts['type'] ): ?>
+ <div class="wp-playlist-current-item"></div>
+ <?php endif ?>
+ <<?php echo $safe_type ?> controls="controls" preload="none" width="<?php
+ echo (int) $theme_width;
+ ?>"<?php if ( 'video' === $safe_type ):
+ echo ' height="', (int) $theme_height, '"';
+ else:
+ echo ' style="visibility: hidden"';
+ endif; ?>></<?php echo $safe_type ?>>
+ <div class="wp-playlist-next"></div>
+ <div class="wp-playlist-prev"></div>
+ <noscript>
+ <ol><?php
+ foreach ( $attachments as $att_id => $attachment ) {
+ printf( '<li>%s</li>', wp_get_attachment_link( $att_id ) );
+ }
+ ?></ol>
+ </noscript>
+ <script type="application/json" class="wp-playlist-script"><?php echo wp_json_encode( $data ) ?></script>
+</div>
+ <?php
+ return ob_get_clean();
+}
+add_shortcode( 'playlist', 'wp_playlist_shortcode' );
+
+/**
+ * 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 ) {
+ /**
+ * Filter the Mediaelement fallback output for no-JS.
+ *
+ * @since 3.6.0
+ *
+ * @param string $output Fallback output for no-JS.
+ * @param string $url Media file 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() {
+ /**
+ * Filter the list of supported audio formats.
+ *
+ * @since 3.6.0
+ *
+ * @param array $extensions An array of support audio formats. Defaults are
+ * 'mp3', 'ogg', 'wma', 'm4a', 'wav'.
+ */
+ return apply_filters( 'wp_audio_extensions', array( 'mp3', 'ogg', 'wma', 'm4a', 'wav' ) );
+}
+
+/**
+ * Return useful keys to use to lookup data from an attachment's stored metadata.
+ *
+ * @since 3.9.0
+ *
+ * @param WP_Post $attachment The current attachment, provided for context.
+ * @param string $context The context. Accepts 'edit', 'display'. Default 'display'.
+ * @return array Key/value pairs of field keys to labels.
+ */
+function wp_get_attachment_id3_keys( $attachment, $context = 'display' ) {
+ $fields = array(
+ 'artist' => __( 'Artist' ),
+ 'album' => __( 'Album' ),
+ );
+
+ if ( 'display' === $context ) {
+ $fields['genre'] = __( 'Genre' );
+ $fields['year'] = __( 'Year' );
+ $fields['length_formatted'] = _x( 'Length', 'video or audio' );
+ } elseif ( 'js' === $context ) {
+ $fields['bitrate'] = __( 'Bitrate' );
+ $fields['bitrate_mode'] = __( 'Bitrate Mode' );
+ }
+
+ /**
+ * Filter the editable list of keys to look up data from an attachment's metadata.
+ *
+ * @since 3.9.0
+ *
+ * @param array $fields Key/value pairs of field keys to labels.
+ * @param WP_Post $attachment Attachment object.
+ * @param string $context The context. Accepts 'edit', 'display'. Default 'display'.
+ */
+ return apply_filters( 'wp_get_attachment_id3_keys', $fields, $attachment, $context );
+}
+/**
+ * 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 audio shortcode.
+ *
+ * @type string $src URL to the source of the audio file. Default empty.
+ * @type string $loop The 'loop' attribute for the `<audio>` element. Default empty.
+ * @type string $autoplay The 'autoplay' attribute for the `<audio>` element. Default empty.
+ * @type string $preload The 'preload' attribute for the `<audio>` element. Default empty.
+ * @type string $class The 'class' attribute for the `<audio>` element. Default 'wp-audio-shortcode'.
+ * @type string $id The 'id' attribute for the `<audio>` element. Default 'audio-{$post_id}-{$instances}'.
+ * @type string $style The 'style' attribute for the `<audio>` element. Default 'width: 100%'.
+ * }
+ * @param string $content Optional. Shortcode content.
+ * @return string HTML content to display audio.
+ */
+function wp_audio_shortcode( $attr, $content = '' ) {
+ $post_id = get_post() ? get_the_ID() : 0;
+
+ static $instances = 0;
+ $instances++;
+
+ /**
+ * Filter the default audio shortcode output.
+ *
+ * If the filtered output isn't empty, it will be used instead of generating the default audio template.
+ *
+ * @since 3.6.0
+ *
+ * @param string $html Empty variable to be replaced with shortcode markup.
+ * @param array $attr Attributes of the shortcode. @see wp_audio_shortcode()
+ * @param string $content Shortcode content.
+ * @param int $instances Unique numeric ID of this audio shortcode instance.
+ */
+ $override = apply_filters( 'wp_audio_shortcode_override', '', $attr, $content, $instances );
+ if ( '' !== $override ) {
+ return $override;
+ }
+
+ $audio = null;
+
+ $default_types = wp_get_audio_extensions();
+ $defaults_atts = array(
+ 'src' => '',
+ 'loop' => '',
+ 'autoplay' => '',
+ 'preload' => 'none'
+ );
+ foreach ( $default_types as $type ) {
+ $defaults_atts[$type] = '';
+ }
+
+ $atts = shortcode_atts( $defaults_atts, $attr, 'audio' );
+
+ $primary = false;
+ if ( ! empty( $atts['src'] ) ) {
+ $type = wp_check_filetype( $atts['src'], wp_get_mime_types() );
+ if ( ! in_array( strtolower( $type['ext'] ), $default_types ) ) {
+ return sprintf( '<a class="wp-embedded-audio" href="%s">%s</a>', esc_url( $atts['src'] ), esc_html( $atts['src'] ) );
+ }
+ $primary = true;
+ array_unshift( $default_types, 'src' );
+ } else {
+ foreach ( $default_types as $ext ) {
+ if ( ! empty( $atts[ $ext ] ) ) {
+ $type = wp_check_filetype( $atts[ $ext ], wp_get_mime_types() );
+ if ( strtolower( $type['ext'] ) === $ext ) {
+ $primary = true;
+ }
+ }
+ }
+ }
+
+ if ( ! $primary ) {
+ $audios = get_attached_media( 'audio', $post_id );
+ if ( empty( $audios ) ) {
+ return;
+ }
+
+ $audio = reset( $audios );
+ $atts['src'] = wp_get_attachment_url( $audio->ID );
+ if ( empty( $atts['src'] ) ) {
+ return;
+ }
+
+ array_unshift( $default_types, 'src' );
+ }
+
+ /**
+ * Filter the media library used for the audio shortcode.
+ *
+ * @since 3.6.0
+ *
+ * @param string $library Media library used for the audio shortcode.
+ */
+ $library = apply_filters( 'wp_audio_shortcode_library', 'mediaelement' );
+ if ( 'mediaelement' === $library && did_action( 'init' ) ) {
+ wp_enqueue_style( 'wp-mediaelement' );
+ wp_enqueue_script( 'wp-mediaelement' );
+ }
+
+ /**
+ * Filter the class attribute for the audio shortcode output container.
+ *
+ * @since 3.6.0
+ *
+ * @param string $class CSS class or list of space-separated classes.
+ */
+ $html_atts = array(
+ 'class' => apply_filters( 'wp_audio_shortcode_class', 'wp-audio-shortcode' ),
+ 'id' => sprintf( 'audio-%d-%d', $post_id, $instances ),
+ 'loop' => wp_validate_boolean( $atts['loop'] ),
+ 'autoplay' => wp_validate_boolean( $atts['autoplay'] ),
+ 'preload' => $atts['preload'],
+ 'style' => 'width: 100%; visibility: hidden;',
+ );
+
+ // These ones should just be omitted altogether if they are blank
+ foreach ( array( 'loop', 'autoplay', 'preload' ) as $a ) {
+ if ( empty( $html_atts[$a] ) ) {
+ unset( $html_atts[$a] );
+ }
+ }
+
+ $attr_strings = array();
+ foreach ( $html_atts as $k => $v ) {
+ $attr_strings[] = $k . '="' . esc_attr( $v ) . '"';
+ }
+
+ $html = '';
+ if ( 'mediaelement' === $library && 1 === $instances ) {
+ $html .= "<!--[if lt IE 9]><script>document.createElement('audio');</script><![endif]-->\n";
+ }
+ $html .= sprintf( '<audio %s controls="controls">', join( ' ', $attr_strings ) );
+
+ $fileurl = '';
+ $source = '<source type="%s" src="%s" />';
+ foreach ( $default_types as $fallback ) {
+ if ( ! empty( $atts[ $fallback ] ) ) {
+ if ( empty( $fileurl ) ) {
+ $fileurl = $atts[ $fallback ];
+ }
+ $type = wp_check_filetype( $atts[ $fallback ], wp_get_mime_types() );
+ $url = add_query_arg( '_', $instances, $atts[ $fallback ] );
+ $html .= sprintf( $source, $type['type'], esc_url( $url ) );
+ }
+ }
+
+ if ( 'mediaelement' === $library ) {
+ $html .= wp_mediaelement_fallback( $fileurl );
+ }
+ $html .= '</audio>';
+
+ /**
+ * Filter the audio shortcode output.
+ *
+ * @since 3.6.0
+ *
+ * @param string $html Audio shortcode HTML output.
+ * @param array $atts Array of audio shortcode attributes.
+ * @param string $audio Audio file.
+ * @param int $post_id Post ID.
+ * @param string $library Media library used for the audio shortcode.
+ */
+ return apply_filters( 'wp_audio_shortcode', $html, $atts, $audio, $post_id, $library );
+}
+add_shortcode( 'audio', 'wp_audio_shortcode' );
+
+/**
+ * Return a filtered list of WP-supported video formats
+ *
+ * @since 3.6.0
+ * @return array
+ */
+function wp_get_video_extensions() {
+ /**
+ * Filter the list of supported video formats.
+ *
+ * @since 3.6.0
+ *
+ * @param array $extensions An array of support video formats. Defaults are
+ * 'mp4', 'm4v', 'webm', 'ogv', 'wmv', 'flv'.
+ */
+ 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.
+ *
+ * @type string $src URL to the source of the video file. Default empty.
+ * @type int $height Height of the video embed in pixels. Default 360.
+ * @type int $width Width of the video embed in pixels. Default $content_width or 640.
+ * @type string $poster The 'poster' attribute for the `<video>` element. Default empty.
+ * @type string $loop The 'loop' attribute for the `<video>` element. Default empty.
+ * @type string $autoplay The 'autoplay' attribute for the `<video>` element. Default empty.
+ * @type string $preload The 'preload' attribute for the `<video>` element.
+ * Default 'metadata'.
+ * @type string $class The 'class' attribute for the `<video>` element.
+ * Default 'wp-video-shortcode'.
+ * @type string $id The 'id' attribute for the `<video>` element.
+ * Default 'video-{$post_id}-{$instances}'.
+ * }
+ * @param string $content Optional. Shortcode content.
+ * @return string HTML content to display video.
+ */
+function wp_video_shortcode( $attr, $content = '' ) {
+ global $content_width;
+ $post_id = get_post() ? get_the_ID() : 0;
+
+ static $instances = 0;
+ $instances++;
+
+ /**
+ * Filter the default video shortcode output.
+ *
+ * If the filtered output isn't empty, it will be used instead of generating
+ * the default video template.
+ *
+ * @since 3.6.0
+ *
+ * @see wp_video_shortcode()
+ *
+ * @param string $html Empty variable to be replaced with shortcode markup.
+ * @param array $attr Attributes of the video shortcode.
+ * @param string $content Video shortcode content.
+ * @param int $instances Unique numeric ID of this video shortcode instance.
+ */
+ $override = apply_filters( 'wp_video_shortcode_override', '', $attr, $content, $instances );
+ if ( '' !== $override ) {
+ return $override;
+ }
+
+ $video = null;
+
+ $default_types = wp_get_video_extensions();
+ $defaults_atts = array(
+ 'src' => '',
+ 'poster' => '',
+ 'loop' => '',
+ 'autoplay' => '',
+ 'preload' => 'metadata',
+ 'width' => 640,
+ 'height' => 360,
+ );
+
+ foreach ( $default_types as $type ) {
+ $defaults_atts[$type] = '';
+ }
+
+ $atts = shortcode_atts( $defaults_atts, $attr, 'video' );
+
+ if ( is_admin() ) {
+ // shrink the video so it isn't huge in the admin
+ if ( $atts['width'] > $defaults_atts['width'] ) {
+ $atts['height'] = round( ( $atts['height'] * $defaults_atts['width'] ) / $atts['width'] );
+ $atts['width'] = $defaults_atts['width'];
+ }
+ } else {
+ // if the video is bigger than the theme
+ if ( ! empty( $content_width ) && $atts['width'] > $content_width ) {
+ $atts['height'] = round( ( $atts['height'] * $content_width ) / $atts['width'] );
+ $atts['width'] = $content_width;
+ }
+ }
+
+ $yt_pattern = '#^https?://(?:www\.)?(?:youtube\.com/watch|youtu\.be/)#';
+
+ $primary = false;
+ if ( ! empty( $atts['src'] ) ) {
+ if ( ! preg_match( $yt_pattern, $atts['src'] ) ) {
+ $type = wp_check_filetype( $atts['src'], wp_get_mime_types() );
+ if ( ! in_array( strtolower( $type['ext'] ), $default_types ) ) {
+ return sprintf( '<a class="wp-embedded-video" href="%s">%s</a>', esc_url( $atts['src'] ), esc_html( $atts['src'] ) );
+ }
+ }
+ $primary = true;
+ array_unshift( $default_types, 'src' );
+ } else {
+ foreach ( $default_types as $ext ) {
+ if ( ! empty( $atts[ $ext ] ) ) {
+ $type = wp_check_filetype( $atts[ $ext ], wp_get_mime_types() );
+ if ( strtolower( $type['ext'] ) === $ext ) {
+ $primary = true;
+ }
+ }
+ }
+ }
+
+ if ( ! $primary ) {
+ $videos = get_attached_media( 'video', $post_id );
+ if ( empty( $videos ) ) {
+ return;
+ }
+
+ $video = reset( $videos );
+ $atts['src'] = wp_get_attachment_url( $video->ID );
+ if ( empty( $atts['src'] ) ) {
+ return;
+ }
+
+ array_unshift( $default_types, 'src' );
+ }
+
+ /**
+ * Filter the media library used for the video shortcode.
+ *
+ * @since 3.6.0
+ *
+ * @param string $library Media library used for the video shortcode.
+ */
+ $library = apply_filters( 'wp_video_shortcode_library', 'mediaelement' );
+ if ( 'mediaelement' === $library && did_action( 'init' ) ) {
+ wp_enqueue_style( 'wp-mediaelement' );
+ wp_enqueue_script( 'wp-mediaelement' );
+ }
+
+ /**
+ * Filter the class attribute for the video shortcode output container.
+ *
+ * @since 3.6.0
+ *
+ * @param string $class CSS class or list of space-separated classes.
+ */
+ $html_atts = array(
+ 'class' => apply_filters( 'wp_video_shortcode_class', 'wp-video-shortcode' ),
+ 'id' => sprintf( 'video-%d-%d', $post_id, $instances ),
+ 'width' => absint( $atts['width'] ),
+ 'height' => absint( $atts['height'] ),
+ 'poster' => esc_url( $atts['poster'] ),
+ 'loop' => wp_validate_boolean( $atts['loop'] ),
+ 'autoplay' => wp_validate_boolean( $atts['autoplay'] ),
+ 'preload' => $atts['preload'],
+ );
+
+ // These ones should just be omitted altogether if they are blank
+ foreach ( array( 'poster', 'loop', 'autoplay', 'preload' ) as $a ) {
+ if ( empty( $html_atts[$a] ) ) {
+ unset( $html_atts[$a] );
+ }
+ }
+
+ $attr_strings = array();
+ foreach ( $html_atts as $k => $v ) {
+ $attr_strings[] = $k . '="' . esc_attr( $v ) . '"';
+ }
+
+ $html = '';
+ if ( 'mediaelement' === $library && 1 === $instances ) {
+ $html .= "<!--[if lt IE 9]><script>document.createElement('video');</script><![endif]-->\n";
+ }
+ $html .= sprintf( '<video %s controls="controls">', join( ' ', $attr_strings ) );
+
+ $fileurl = '';
+ $source = '<source type="%s" src="%s" />';
+ foreach ( $default_types as $fallback ) {
+ if ( ! empty( $atts[ $fallback ] ) ) {
+ if ( empty( $fileurl ) ) {
+ $fileurl = $atts[ $fallback ];
+ }
+ if ( 'src' === $fallback && preg_match( $yt_pattern, $atts['src'] ) ) {
+ $type = array( 'type' => 'video/youtube' );
+ } else {
+ $type = wp_check_filetype( $atts[ $fallback ], wp_get_mime_types() );
+ }
+ $url = add_query_arg( '_', $instances, $atts[ $fallback ] );
+ $html .= sprintf( $source, $type['type'], esc_url( $url ) );
+ }
+ }
+
+ if ( ! empty( $content ) ) {
+ if ( false !== strpos( $content, "\n" ) ) {
+ $content = str_replace( array( "\r\n", "\n", "\t" ), '', $content );
+ }
+ $html .= trim( $content );
+ }
+
+ if ( 'mediaelement' === $library ) {
+ $html .= wp_mediaelement_fallback( $fileurl );
+ }
+ $html .= '</video>';
+
+ $width_rule = '';
+ if ( ! empty( $atts['width'] ) ) {
+ $width_rule = sprintf( 'width: %dpx; ', $atts['width'] );
+ }
+ $output = sprintf( '<div style="%s" class="wp-video">%s</div>', $width_rule, $html );
+
+ /**
+ * Filter the output of the video shortcode.
+ *
+ * @since 3.6.0
+ *
+ * @param string $output Video shortcode HTML output.
+ * @param array $atts Array of video shortcode attributes.
+ * @param string $video Video file.
+ * @param int $post_id Post ID.
+ * @param string $library Media library used for the video shortcode.
+ */
+ return apply_filters( 'wp_video_shortcode', $output, $atts, $video, $post_id, $library );
+}
+add_shortcode( 'video', 'wp_video_shortcode' );
+
+/**
+ * Display previous image link that has the same post parent.
+ *
+ * @since 2.5.0
+ * @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.
+ */
+function previous_image_link($size = 'thumbnail', $text = false) {
+ adjacent_image_link(true, $size, $text);
+}
+
+/**
+ * Display next image link that has the same post parent.
+ *
+ * @since 2.5.0
+ * @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.
+ */
+function next_image_link($size = 'thumbnail', $text = false) {
+ adjacent_image_link(false, $size, $text);
+}
+
+/**
+ * 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
+ *
+ * @param bool $prev Optional. Default is true to display previous link, false for next.
+ */
+function adjacent_image_link($prev = true, $size = 'thumbnail', $text = false) {
+ $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' ) ) );
+
+ foreach ( $attachments as $k => $attachment ) {
+ if ( $attachment->ID == $post->ID ) {
+ break;
+ }
+ }
+
+ $output = '';
+ $attachment_id = 0;
+
+ if ( $attachments ) {
+ $k = $prev ? $k - 1 : $k + 1;
+
+ if ( isset( $attachments[ $k ] ) ) {
+ $attachment_id = $attachments[ $k ]->ID;
+ $output = wp_get_attachment_link( $attachment_id, $size, true, false, $text );
+ }
+ }
+
+ $adjacent = $prev ? 'previous' : 'next';
+
+ /**
+ * Filter the adjacent image link.
+ *
+ * The dynamic portion of the hook name, `$adjacent`, refers to the type of adjacency,
+ * either 'next', or 'previous'.
+ *
+ * @since 3.5.0
+ *
+ * @param string $output Adjacent image HTML markup.
+ * @param int $attachment_id Attachment ID
+ * @param string $size Image size.
+ * @param string $text Link text.
+ */
+ echo apply_filters( "{$adjacent}_image_link", $output, $attachment_id, $size, $text );
+}
+
+/**
+ * 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.
+ */
+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);
+}
+
+/**
+ * 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()
+ *
+ * @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;
+}
+
+/**
+ * Create new GD image resource with transparency support
+ * @TODO: Deprecate if possible.
+ *
+ * @since 2.9.0
+ *
+ * @param int $width Image width
+ * @param int $height Image height
+ * @return resource 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;
+}
+
+/**
+ * Register an embed handler. This function should probably only be used for sites that do not support oEmbed.
+ *
+ * @since 2.9.0
+ * @see WP_Embed::register_handler()
+ *
+ * @global WP_Embed $wp_embed
+ * @param string $id
+ * @param string $regex
+ * @param callable $callback
+ * @param int $priority
+ */
+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.
+ *
+ * @since 2.9.0
+ * @see WP_Embed::unregister_handler()
+ *
+ * @global WP_Embed $wp_embed
+ * @param string $id
+ * @param int $priority
+ */
+function wp_embed_unregister_handler( $id, $priority = 10 ) {
+ global $wp_embed;
+ $wp_embed->unregister_handler( $id, $priority );
+}
+
+/**
+ * Create default array of embed parameters.
+ *
+ * The width defaults to the content width as specified by the theme. If the
+ * theme does not specify a content width, then 500px is used.
+ *
+ * The default height is 1.5 times the width, or 1000px, whichever is smaller.
+ *
+ * The 'embed_defaults' filter can be used to adjust either of these values.
+ *
+ * @since 2.9.0
+ *
+ * @param string $url Optional. The URL that should be embedded. Default empty.
+ *
+ * @return array Default embed parameters.
+ */
+function wp_embed_defaults( $url = '' ) {
+ if ( ! empty( $GLOBALS['content_width'] ) )
+ $width = (int) $GLOBALS['content_width'];
+
+ if ( empty( $width ) )
+ $width = 500;
+
+ $height = min( ceil( $width * 1.5 ), 1000 );
+
+ /**
+ * Filter the default array of embed dimensions.
+ *
+ * @since 2.9.0
+ *
+ * @param int $width Width of the embed in pixels.
+ * @param int $height Height of the embed in pixels.
+ * @param string $url The URL that should be embedded.
+ */
+ return apply_filters( 'embed_defaults', compact( 'width', 'height' ), $url );
+}
+
+/**
+ * Based on a supplied width/height example, return the biggest possible dimensions based on the max width/height.
+ *
+ * @since 2.9.0
+ *
+ * @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.
+ *
+ * @since 2.9.0
+ * @see WP_oEmbed
+ *
+ * @param string $url The URL that should be embedded.
+ * @param array $args Additional arguments and parameters.
+ * @return false|string False on failure or the embed HTML on success.
+ */
+function wp_oembed_get( $url, $args = '' ) {
+ require_once( ABSPATH . WPINC . '/class-oembed.php' );
+ $oembed = _wp_oembed_get_object();
+ return $oembed->get_html( $url, $args );
+}
+
+/**
+ * Adds a URL format and oEmbed provider URL pair.
+ *
+ * @since 2.9.0
+ * @see WP_oEmbed
+ *
+ * @param string $format The format of URL that this provider can handle. You can use asterisks as wildcards.
+ * @param string $provider The URL to the oEmbed provider.
+ * @param boolean $regex Whether the $format parameter is in a regex format.
+ */
+function wp_oembed_add_provider( $format, $provider, $regex = false ) {
+ require_once( ABSPATH . WPINC . '/class-oembed.php' );
+
+ if ( did_action( 'plugins_loaded' ) ) {
+ $oembed = _wp_oembed_get_object();
+ $oembed->providers[$format] = array( $provider, $regex );
+ } else {
+ WP_oEmbed::_add_provider_early( $format, $provider, $regex );
+ }
+}
+
+/**
+ * Removes an oEmbed provider.
+ *
+ * @since 3.5.0
+ * @see WP_oEmbed
+ *
+ * @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' );
+
+ if ( did_action( 'plugins_loaded' ) ) {
+ $oembed = _wp_oembed_get_object();
+
+ if ( isset( $oembed->providers[ $format ] ) ) {
+ unset( $oembed->providers[ $format ] );
+ return true;
+ }
+ } else {
+ WP_oEmbed::_remove_provider_early( $format );
+ }
+
+ return false;
+}
+
+/**
+ * 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() {
+ /**
+ * Filter whether to load the default embed handlers.
+ *
+ * Returning a falsey value will prevent loading the default embed handlers.
+ *
+ * @since 2.9.0
+ *
+ * @param bool $maybe_load_embeds Whether to load the embeds library. Default true.
+ */
+ if ( ! apply_filters( 'load_default_embeds', true ) ) {
+ return;
+ }
+
+ wp_embed_register_handler( 'youtube_embed_url', '#https?://(www.)?youtube\.com/embed/([^/]+)#i', 'wp_embed_handler_youtube' );
+
+ wp_embed_register_handler( 'googlevideo', '#http://video\.google\.([A-Za-z.]{2,5})/videoplay\?docid=([\d-]+)(.*?)#i', 'wp_embed_handler_googlevideo' );
+
+ /**
+ * Filter the audio embed handler callback.
+ *
+ * @since 3.6.0
+ *
+ * @param callback $handler Audio embed handler callback function.
+ */
+ wp_embed_register_handler( 'audio', '#^https?://.+?\.(' . join( '|', wp_get_audio_extensions() ) . ')$#i', apply_filters( 'wp_audio_embed_handler', 'wp_embed_handler_audio' ), 9999 );
+
+ /**
+ * Filter the video embed handler callback.
+ *
+ * @since 3.6.0
+ *
+ * @param callback $handler Video embed handler callback function.
+ */
+ wp_embed_register_handler( 'video', '#^https?://.+?\.(' . join( '|', wp_get_video_extensions() ) . ')$#i', apply_filters( 'wp_video_embed_handler', 'wp_embed_handler_video' ), 9999 );
+}
+
+/**
+ * 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'] );
+ }
+
+ /**
+ * Filter the Google Video embed output.
+ *
+ * @since 2.9.0
+ *
+ * @param string $html Google Video HTML embed markup.
+ * @param array $matches The regex matches from the provided regex.
+ * @param array $attr An array of embed attributes.
+ * @param string $url The original URL that was matched by the regex.
+ * @param array $rawattr The original unmodified attributes.
+ */
+ 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 );
+}
+
+/**
+ * YouTube embed handler callback.
+ *
+ * Catches URLs that can be parsed but aren't supported by oEmbed.
+ *
+ * @since 4.0.0
+ *
+ * @param array $matches The regex matches from the provided regex when calling
+ * {@see 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_youtube( $matches, $attr, $url, $rawattr ) {
+ global $wp_embed;
+ $embed = $wp_embed->autoembed( "https://youtube.com/watch?v={$matches[2]}" );
+ /**
+ * Filter the YoutTube embed output.
+ *
+ * @since 4.0.0
+ *
+ * @see wp_embed_handler_youtube()
+ *
+ * @param string $embed YouTube embed output.
+ * @param array $attr An array of embed attributes.
+ * @param string $url The original URL that was matched by the regex.
+ * @param array $rawattr The original unmodified attributes.
+ */
+ return apply_filters( 'wp_embed_handler_youtube', $embed, $attr, $url, $rawattr );
+}
+
+/**
+ * Audio embed handler callback.
+ *
+ * @since 3.6.0
+ *
+ * @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_audio( $matches, $attr, $url, $rawattr ) {
+ $audio = sprintf( '[audio src="%s" /]', esc_url( $url ) );
+
+ /**
+ * Filter the audio embed output.
+ *
+ * @since 3.6.0
+ *
+ * @param string $audio Audio embed output.
+ * @param array $attr An array of embed attributes.
+ * @param string $url The original URL that was matched by the regex.
+ * @param array $rawattr The original unmodified attributes.
+ */
+ return apply_filters( 'wp_embed_handler_audio', $audio, $attr, $url, $rawattr );
}
/**
- * Create new GD image resource with transparency support
+ * Video embed handler callback.
*
- * @since 2.9.0
+ * @since 3.6.0
*
- * @param int $width Image width
- * @param int $height Image height
- * @return image resource
+ * @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_imagecreatetruecolor($width, $height) {
- $img = imagecreatetruecolor($width, $height);
- if ( is_resource($img) && function_exists('imagealphablending') && function_exists('imagesavealpha') ) {
- imagealphablending($img, false);
- imagesavealpha($img, true);
+function wp_embed_handler_video( $matches, $attr, $url, $rawattr ) {
+ $dimensions = '';
+ if ( ! empty( $rawattr['width'] ) && ! empty( $rawattr['height'] ) ) {
+ $dimensions .= sprintf( 'width="%d" ', (int) $rawattr['width'] );
+ $dimensions .= sprintf( 'height="%d" ', (int) $rawattr['height'] );
}
- return $img;
+ $video = sprintf( '[video %s src="%s" /]', $dimensions, esc_url( $url ) );
+
+ /**
+ * Filter the video embed output.
+ *
+ * @since 3.6.0
+ *
+ * @param string $video Video embed output.
+ * @param array $attr An array of embed attributes.
+ * @param string $url The original URL that was matched by the regex.
+ * @param array $rawattr The original unmodified attributes.
+ */
+ return apply_filters( 'wp_embed_handler_video', $video, $attr, $url, $rawattr );
}
/**
- * API for easily embedding rich media such as videos and images into content.
+ * Converts a shorthand byte value to an integer byte value.
*
- * @package WordPress
- * @subpackage Embed
- * @since 2.9.0
+ * @since 2.3.0
+ *
+ * @param string $size A shorthand byte value.
+ * @return int An integer byte value.
+ */
+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;
+}
+
+/**
+ * Determine the maximum upload size allowed in php.ini.
+ *
+ * @since 2.5.0
+ *
+ * @return int Allowed upload size.
*/
-class WP_Embed {
- var $handlers = array();
- var $post_ID;
- var $usecache = true;
- var $linkifunknown = true;
+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' ) );
/**
- * Constructor
+ * Filter the maximum upload size allowed in php.ini.
+ *
+ * @since 2.5.0
+ *
+ * @param int $size Max upload size limit in bytes.
+ * @param int $u_bytes Maximum upload filesize in bytes.
+ * @param int $p_bytes Maximum size of POST data in bytes.
*/
- function __construct() {
- // Hack to get the [embed] shortcode to run before wpautop()
- add_filter( 'the_content', array(&$this, 'run_shortcode'), 8 );
+ return apply_filters( 'upload_size_limit', min( $u_bytes, $p_bytes ), $u_bytes, $p_bytes );
+}
+
+/**
+ * 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'];
+ }
- // Shortcode placeholder for strip_shortcodes()
- add_shortcode( 'embed', '__return_false' );
+ $implementation = _wp_image_editor_choose( $args );
- // Attempts to embed all URLs in a post
- if ( get_option('embed_autourls') )
- add_filter( 'the_content', array(&$this, 'autoembed'), 8 );
+ if ( $implementation ) {
+ $editor = new $implementation( $path );
+ $loaded = $editor->load();
- // After a post is saved, invalidate the oEmbed cache
- add_action( 'save_post', array(&$this, 'delete_oembed_caches') );
+ if ( is_wp_error( $loaded ) )
+ return $loaded;
- // After a post is saved, cache oEmbed items via AJAX
- add_action( 'edit_form_advanced', array(&$this, 'maybe_run_ajax_cache') );
+ 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';
+
/**
- * Process the [embed] shortcode.
+ * Filter the list of image editing library classes.
*
- * Since the [embed] shortcode needs to be run earlier than other shortcodes,
- * this function removes all existing shortcodes, registers the [embed] shortcode,
- * calls {@link do_shortcode()}, and then re-registers the old shortcodes.
+ * @since 3.5.0
*
- * @uses $shortcode_tags
- * @uses remove_all_shortcodes()
- * @uses add_shortcode()
- * @uses do_shortcode()
- *
- * @param string $content Content to parse
- * @return string Content with shortcode parsed
+ * @param array $image_editors List of available image editors. Defaults are
+ * 'WP_Image_Editor_Imagick', 'WP_Image_Editor_GD'.
*/
- function run_shortcode( $content ) {
- global $shortcode_tags;
-
- // Back up current registered shortcodes and clear them all out
- $orig_shortcode_tags = $shortcode_tags;
- remove_all_shortcodes();
+ $implementations = apply_filters( 'wp_image_editors', array( 'WP_Image_Editor_Imagick', 'WP_Image_Editor_GD' ) );
- add_shortcode( 'embed', array(&$this, 'shortcode') );
+ foreach ( $implementations as $implementation ) {
+ if ( ! call_user_func( array( $implementation, 'test' ), $args ) )
+ continue;
- // Do the shortcode (only the [embed] one is registered)
- $content = do_shortcode( $content );
+ if ( isset( $args['mime_type'] ) &&
+ ! call_user_func(
+ array( $implementation, 'supports_mime_type' ),
+ $args['mime_type'] ) ) {
+ continue;
+ }
- // Put the original shortcodes back
- $shortcode_tags = $orig_shortcode_tags;
+ if ( isset( $args['methods'] ) &&
+ array_diff( $args['methods'], get_class_methods( $implementation ) ) ) {
+ continue;
+ }
- return $content;
+ return $implementation;
}
- /**
- * If a post/page was saved, then output Javascript to make
- * an AJAX request that will call WP_Embed::cache_oembed().
- */
- function maybe_run_ajax_cache() {
- global $post_ID;
+ return false;
+}
- if ( empty($post_ID) || empty($_GET['message']) || 1 != $_GET['message'] )
- return;
+/**
+ * Prints default plupload arguments.
+ *
+ * @since 3.4.0
+ */
+function wp_plupload_default_settings() {
+ global $wp_scripts;
-?>
-<script type="text/javascript">
-/* <![CDATA[ */
- jQuery(document).ready(function($){
- $.get("<?php echo admin_url( 'admin-ajax.php?action=oembed-cache&post=' . $post_ID ); ?>");
- });
-/* ]]> */
-</script>
-<?php
+ $data = $wp_scripts->get_data( 'wp-plupload', 'data' );
+ if ( $data && false !== strpos( $data, '_wpPluploadSettings' ) )
+ return;
+
+ $max_upload_size = wp_max_upload_size();
+
+ $defaults = array(
+ 'runtimes' => 'html5,flash,silverlight,html4',
+ 'file_data_name' => 'async-upload', // key passed to $_FILE.
+ 'url' => admin_url( 'async-upload.php', 'relative' ),
+ 'flash_swf_url' => includes_url( 'js/plupload/plupload.flash.swf' ),
+ 'silverlight_xap_url' => includes_url( 'js/plupload/plupload.silverlight.xap' ),
+ 'filters' => array(
+ 'max_file_size' => $max_upload_size . 'b',
+ ),
+ );
+
+ // Currently only iOS Safari supports multiple files uploading but iOS 7.x has a bug that prevents uploading of videos
+ // when enabled. See #29602.
+ if ( wp_is_mobile() && strpos( $_SERVER['HTTP_USER_AGENT'], 'OS 7_' ) !== false &&
+ strpos( $_SERVER['HTTP_USER_AGENT'], 'like Mac OS X' ) !== false ) {
+
+ $defaults['multi_selection'] = false;
}
/**
- * Register an embed handler. Do not use this function directly, use {@link wp_embed_register_handler()} instead.
- * This function should probably also only be used for sites that do not support oEmbed.
+ * Filter the Plupload default settings.
*
- * @param string $id An internal ID/name for the handler. Needs to be unique.
- * @param string $regex The regex that will be used to see if this handler should be used for a URL.
- * @param callback $callback The callback function that will be called if the regex is matched.
- * @param int $priority Optional. Used to specify the order in which the registered handlers will be tested (default: 10). Lower numbers correspond with earlier testing, and handlers with the same priority are tested in the order in which they were added to the action.
+ * @since 3.4.0
+ *
+ * @param array $defaults Default Plupload settings array.
*/
- function register_handler( $id, $regex, $callback, $priority = 10 ) {
- $this->handlers[$priority][$id] = array(
- 'regex' => $regex,
- 'callback' => $callback,
- );
- }
+ $defaults = apply_filters( 'plupload_default_settings', $defaults );
+
+ $params = array(
+ 'action' => 'upload-attachment',
+ );
/**
- * Unregister a previously registered embed handler. Do not use this function directly, use {@link wp_embed_unregister_handler()} instead.
+ * Filter the Plupload default parameters.
*
- * @param string $id The handler ID that should be removed.
- * @param int $priority Optional. The priority of the handler to be removed (default: 10).
+ * @since 3.4.0
+ *
+ * @param array $params Default Plupload parameters array.
*/
- function unregister_handler( $id, $priority = 10 ) {
- if ( isset($this->handlers[$priority][$id]) )
- unset($this->handlers[$priority][$id]);
+ $params = apply_filters( 'plupload_default_params', $params );
+ $params['_wpnonce'] = wp_create_nonce( 'media-form' );
+ $defaults['multipart_params'] = $params;
+
+ $settings = array(
+ 'defaults' => $defaults,
+ 'browser' => array(
+ 'mobile' => wp_is_mobile(),
+ 'supported' => _device_can_upload(),
+ ),
+ 'limitExceeded' => is_multisite() && ! is_upload_space_available()
+ );
+
+ $script = 'var _wpPluploadSettings = ' . wp_json_encode( $settings ) . ';';
+
+ if ( $data )
+ $script = "$data\n$script";
+
+ $wp_scripts->add_data( 'wp-plupload', 'data', $script );
+}
+add_action( 'customize_controls_enqueue_scripts', 'wp_plupload_default_settings' );
+
+/**
+ * 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 ) )
+ return;
+
+ if ( 'attachment' != $attachment->post_type )
+ return;
+
+ $meta = wp_get_attachment_metadata( $attachment->ID );
+ if ( false !== strpos( $attachment->post_mime_type, '/' ) )
+ list( $type, $subtype ) = explode( '/', $attachment->post_mime_type );
+ else
+ list( $type, $subtype ) = array( $attachment->post_mime_type, '' );
+
+ $attachment_url = wp_get_attachment_url( $attachment->ID );
+
+ $response = array(
+ 'id' => $attachment->ID,
+ 'title' => $attachment->post_title,
+ 'filename' => wp_basename( $attachment->guid ),
+ 'url' => $attachment_url,
+ 'link' => get_attachment_link( $attachment->ID ),
+ '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,
+ 'date' => strtotime( $attachment->post_date_gmt ) * 1000,
+ 'modified' => strtotime( $attachment->post_modified_gmt ) * 1000,
+ 'menuOrder' => $attachment->menu_order,
+ 'mime' => $attachment->post_mime_type,
+ 'type' => $type,
+ 'subtype' => $subtype,
+ 'icon' => wp_mime_type_icon( $attachment->ID ),
+ 'dateFormatted' => mysql2date( get_option('date_format'), $attachment->post_date ),
+ 'nonces' => array(
+ 'update' => false,
+ 'delete' => false,
+ 'edit' => false
+ ),
+ 'editLink' => false,
+ 'meta' => false,
+ );
+
+ $author = new WP_User( $attachment->post_author );
+ $response['authorName'] = $author->display_name;
+
+ if ( $attachment->post_parent ) {
+ $post_parent = get_post( $attachment->post_parent );
+ } else {
+ $post_parent = false;
}
- /**
- * The {@link do_shortcode()} callback function.
- *
- * Attempts to convert a URL into embed HTML. Starts by checking the URL against the regex of the registered embed handlers.
- * If none of the regex matches and it's enabled, then the URL will be given to the {@link WP_oEmbed} class.
- *
- * @uses wp_oembed_get()
- * @uses wp_parse_args()
- * @uses wp_embed_defaults()
- * @uses WP_Embed::maybe_make_link()
- * @uses get_option()
- * @uses current_user_can()
- * @uses wp_cache_get()
- * @uses wp_cache_set()
- * @uses get_post_meta()
- * @uses update_post_meta()
- *
- * @param array $attr Shortcode attributes.
- * @param string $url The URL attempting to be embeded.
- * @return string The embed HTML on success, otherwise the original URL.
- */
- function shortcode( $attr, $url = '' ) {
- global $post;
-
- if ( empty($url) )
- return '';
-
- $rawattr = $attr;
- $attr = wp_parse_args( $attr, wp_embed_defaults() );
-
- // kses converts & into & and we need to undo this
- // See http://core.trac.wordpress.org/ticket/11311
- $url = str_replace( '&', '&', $url );
-
- // Look for known internal handlers
- ksort( $this->handlers );
- foreach ( $this->handlers as $priority => $handlers ) {
- foreach ( $handlers as $id => $handler ) {
- if ( preg_match( $handler['regex'], $url, $matches ) && is_callable( $handler['callback'] ) ) {
- if ( false !== $return = call_user_func( $handler['callback'], $matches, $attr, $url, $rawattr ) )
- return apply_filters( 'embed_handler_html', $return, $url, $attr );
- }
- }
+ if ( $post_parent ) {
+ $parent_type = get_post_type_object( $post_parent->post_type );
+ if ( $parent_type && $parent_type->show_ui && current_user_can( 'edit_post', $attachment->post_parent ) ) {
+ $response['uploadedToLink'] = get_edit_post_link( $attachment->post_parent, 'raw' );
}
+ $response['uploadedToTitle'] = $post_parent->post_title ? $post_parent->post_title : __( '(no title)' );
+ }
- $post_ID = ( !empty($post->ID) ) ? $post->ID : null;
- if ( !empty($this->post_ID) ) // Potentially set by WP_Embed::cache_oembed()
- $post_ID = $this->post_ID;
+ $attached_file = get_attached_file( $attachment->ID );
+ if ( file_exists( $attached_file ) ) {
+ $bytes = filesize( $attached_file );
+ $response['filesizeInBytes'] = $bytes;
+ $response['filesizeHumanReadable'] = size_format( $bytes );
+ }
- // Unknown URL format. Let oEmbed have a go.
- if ( $post_ID ) {
+ if ( current_user_can( 'edit_post', $attachment->ID ) ) {
+ $response['nonces']['update'] = wp_create_nonce( 'update-post_' . $attachment->ID );
+ $response['nonces']['edit'] = wp_create_nonce( 'image_editor-' . $attachment->ID );
+ $response['editLink'] = get_edit_post_link( $attachment->ID, 'raw' );
+ }
- // Check for a cached result (stored in the post meta)
- $cachekey = '_oembed_' . md5( $url . serialize( $attr ) );
- if ( $this->usecache ) {
- $cache = get_post_meta( $post_ID, $cachekey, true );
+ if ( current_user_can( 'delete_post', $attachment->ID ) )
+ $response['nonces']['delete'] = wp_create_nonce( 'delete-post_' . $attachment->ID );
+
+ if ( $meta && 'image' === $type ) {
+ $sizes = array();
+
+ /** This filter is documented in wp-admin/includes/media.php */
+ $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 ) {
+
+ /** This filter is documented in wp-includes/media.php */
+ 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 ];
+
+ // We have the actual image size, but might need to further constrain it if content_width is narrower.
+ // 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' );
+
+ $sizes[ $size ] = array(
+ 'height' => $height,
+ 'width' => $width,
+ 'url' => $base_url . $size_meta['file'],
+ 'orientation' => $height > $width ? 'portrait' : 'landscape',
+ );
+ }
+ }
- // Failures are cached
- if ( '{{unknown}}' === $cache )
- return $this->maybe_make_link( $url );
+ $sizes['full'] = array( 'url' => $attachment_url );
- if ( !empty($cache) )
- return apply_filters( 'embed_oembed_html', $cache, $url, $attr, $post_ID );
- }
+ 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';
+ }
- // Use oEmbed to get the HTML
- $attr['discover'] = ( apply_filters('embed_oembed_discover', false) && author_can( $post_ID, 'unfiltered_html' ) );
- $html = wp_oembed_get( $url, $attr );
+ $response = array_merge( $response, array( 'sizes' => $sizes ), $sizes['full'] );
+ } elseif ( $meta && 'video' === $type ) {
+ if ( isset( $meta['width'] ) )
+ $response['width'] = (int) $meta['width'];
+ if ( isset( $meta['height'] ) )
+ $response['height'] = (int) $meta['height'];
+ }
+
+ if ( $meta && ( 'audio' === $type || 'video' === $type ) ) {
+ if ( isset( $meta['length_formatted'] ) )
+ $response['fileLength'] = $meta['length_formatted'];
- // Cache the result
- $cache = ( $html ) ? $html : '{{unknown}}';
- update_post_meta( $post_ID, $cachekey, $cache );
+ $response['meta'] = array();
+ foreach ( wp_get_attachment_id3_keys( $attachment, 'js' ) as $key => $label ) {
+ $response['meta'][ $key ] = false;
- // If there was a result, return it
- if ( $html )
- return apply_filters( 'embed_oembed_html', $html, $url, $attr, $post_ID );
+ if ( ! empty( $meta[ $key ] ) ) {
+ $response['meta'][ $key ] = $meta[ $key ];
+ }
}
- // Still unknown
- return $this->maybe_make_link( $url );
+ $id = get_post_thumbnail_id( $attachment->ID );
+ if ( ! empty( $id ) ) {
+ list( $src, $width, $height ) = wp_get_attachment_image_src( $id, 'full' );
+ $response['image'] = compact( 'src', 'width', 'height' );
+ list( $src, $width, $height ) = wp_get_attachment_image_src( $id, 'thumbnail' );
+ $response['thumb'] = compact( 'src', 'width', 'height' );
+ } else {
+ $src = wp_mime_type_icon( $attachment->ID );
+ $width = 48;
+ $height = 64;
+ $response['image'] = compact( 'src', 'width', 'height' );
+ $response['thumb'] = compact( 'src', 'width', 'height' );
+ }
}
+ if ( function_exists('get_compat_media_markup') )
+ $response['compat'] = get_compat_media_markup( $attachment->ID, array( 'in_modal' => true ) );
+
/**
- * Delete all oEmbed caches.
+ * Filter the attachment data prepared for JavaScript.
+ *
+ * @since 3.5.0
*
- * @param int $post_ID Post ID to delete the caches for.
+ * @param array $response Array of prepared attachment data.
+ * @param int|object $attachment Attachment ID or object.
+ * @param array $meta Array of attachment meta data.
*/
- function delete_oembed_caches( $post_ID ) {
- $post_metas = get_post_custom_keys( $post_ID );
- if ( empty($post_metas) )
- return;
+ return apply_filters( 'wp_prepare_attachment_for_js', $response, $attachment, $meta );
+}
- foreach( $post_metas as $post_meta_key ) {
- if ( '_oembed_' == substr( $post_meta_key, 0, 8 ) )
- delete_post_meta( $post_ID, $post_meta_key );
+/**
+ * Enqueues all scripts, styles, settings, and templates necessary to use
+ * all media JS APIs.
+ *
+ * @since 3.5.0
+ */
+function wp_enqueue_media( $args = array() ) {
+
+ // Enqueue me just once per page, please.
+ if ( did_action( 'wp_enqueue_media' ) )
+ return;
+
+ global $content_width, $wpdb, $wp_locale;
+
+ $defaults = array(
+ 'post' => null,
+ );
+ $args = wp_parse_args( $args, $defaults );
+
+ // 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(
+ // handler action suffix => tab label
+ 'type' => '',
+ 'type_url' => '',
+ 'gallery' => '',
+ 'library' => '',
+ );
+
+ /** This filter is documented in wp-admin/includes/media.php */
+ $tabs = apply_filters( 'media_upload_tabs', $tabs );
+ unset( $tabs['type'], $tabs['type_url'], $tabs['gallery'], $tabs['library'] );
+
+ $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
+ );
+
+ $exts = array_merge( wp_get_audio_extensions(), wp_get_video_extensions() );
+ $mimes = get_allowed_mime_types();
+ $ext_mimes = array();
+ foreach ( $exts as $ext ) {
+ foreach ( $mimes as $ext_preg => $mime_match ) {
+ if ( preg_match( '#' . $ext . '#i', $ext_preg ) ) {
+ $ext_mimes[ $ext ] = $mime_match;
+ break;
+ }
}
}
- /**
- * Triggers a caching of all oEmbed results.
- *
- * @param int $post_ID Post ID to do the caching for.
- */
- function cache_oembed( $post_ID ) {
- $post = get_post( $post_ID );
-
- if ( empty($post->ID) || !in_array( $post->post_type, apply_filters( 'embed_cache_oembed_types', array( 'post', 'page' ) ) ) )
- return;
+ $has_audio = $wpdb->get_var( "
+ SELECT ID
+ FROM $wpdb->posts
+ WHERE post_type = 'attachment'
+ AND post_mime_type LIKE 'audio%'
+ LIMIT 1
+ " );
+ $has_video = $wpdb->get_var( "
+ SELECT ID
+ FROM $wpdb->posts
+ WHERE post_type = 'attachment'
+ AND post_mime_type LIKE 'video%'
+ LIMIT 1
+ " );
+ $months = $wpdb->get_results( $wpdb->prepare( "
+ SELECT DISTINCT YEAR( post_date ) AS year, MONTH( post_date ) AS month
+ FROM $wpdb->posts
+ WHERE post_type = %s
+ ORDER BY post_date DESC
+ ", 'attachment' ) );
+ foreach ( $months as $month_year ) {
+ $month_year->text = sprintf( __( '%1$s %2$d' ), $wp_locale->get_month( $month_year->month ), $month_year->year );
+ }
- // Trigger a caching
- if ( !empty($post->post_content) ) {
- $this->post_ID = $post->ID;
- $this->usecache = false;
+ $settings = array(
+ 'tabs' => $tabs,
+ 'tabUrl' => add_query_arg( array( 'chromeless' => true ), admin_url('media-upload.php') ),
+ 'mimeTypes' => wp_list_pluck( get_post_mime_types(), 0 ),
+ /** This filter is documented in wp-admin/includes/media.php */
+ 'captions' => ! apply_filters( 'disable_captions', '' ),
+ 'nonce' => array(
+ 'sendToEditor' => wp_create_nonce( 'media-send-to-editor' ),
+ ),
+ 'post' => array(
+ 'id' => 0,
+ ),
+ 'defaultProps' => $props,
+ 'attachmentCounts' => array(
+ 'audio' => ( $has_audio ) ? 1 : 0,
+ 'video' => ( $has_video ) ? 1 : 0
+ ),
+ 'embedExts' => $exts,
+ 'embedMimes' => $ext_mimes,
+ 'contentWidth' => $content_width,
+ 'months' => $months,
+ 'mediaTrash' => MEDIA_TRASH ? 1 : 0
+ );
+
+ $post = null;
+ if ( isset( $args['post'] ) ) {
+ $post = get_post( $args['post'] );
+ $settings['post'] = array(
+ 'id' => $post->ID,
+ 'nonce' => wp_create_nonce( 'update-post_' . $post->ID ),
+ );
- $content = $this->run_shortcode( $post->post_content );
- if ( get_option('embed_autourls') )
- $this->autoembed( $content );
+ $thumbnail_support = current_theme_supports( 'post-thumbnails', $post->post_type ) && post_type_supports( $post->post_type, 'thumbnail' );
+ if ( ! $thumbnail_support && 'attachment' === $post->post_type && $post->post_mime_type ) {
+ if ( 0 === strpos( $post->post_mime_type, 'audio/' ) ) {
+ $thumbnail_support = post_type_supports( 'attachment:audio', 'thumbnail' ) || current_theme_supports( 'post-thumbnails', 'attachment:audio' );
+ } elseif ( 0 === strpos( $post->post_mime_type, 'video/' ) ) {
+ $thumbnail_support = post_type_supports( 'attachment:video', 'thumbnail' ) || current_theme_supports( 'post-thumbnails', 'attachment:video' );
+ }
+ }
- $this->usecache = true;
+ if ( $thumbnail_support ) {
+ $featured_image_id = get_post_meta( $post->ID, '_thumbnail_id', true );
+ $settings['post']['featuredImageId'] = $featured_image_id ? $featured_image_id : -1;
}
}
+ $hier = $post && is_post_type_hierarchical( $post->post_type );
+
+ $strings = array(
+ // Generic
+ 'url' => __( 'URL' ),
+ 'addMedia' => __( 'Add Media' ),
+ 'search' => __( 'Search' ),
+ 'select' => __( 'Select' ),
+ 'cancel' => __( 'Cancel' ),
+ 'update' => __( 'Update' ),
+ 'replace' => __( 'Replace' ),
+ 'remove' => __( 'Remove' ),
+ 'back' => __( 'Back' ),
+ /* 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' ),
+ 'dragInfo' => __( 'Drag and drop to reorder images.' ),
+
+ // Upload
+ 'uploadFilesTitle' => __( 'Upload Files' ),
+ 'uploadImagesTitle' => __( 'Upload Images' ),
+
+ // Library
+ 'mediaLibraryTitle' => __( 'Media Library' ),
+ 'insertMediaTitle' => __( 'Insert Media' ),
+ 'createNewGallery' => __( 'Create a new gallery' ),
+ 'createNewPlaylist' => __( 'Create a new playlist' ),
+ 'createNewVideoPlaylist' => __( 'Create a new video playlist' ),
+ 'returnToLibrary' => __( '← Return to library' ),
+ 'allMediaItems' => __( 'All media items' ),
+ 'allDates' => __( 'All dates' ),
+ 'noItemsFound' => __( 'No items found.' ),
+ 'insertIntoPost' => $hier ? __( 'Insert into page' ) : __( 'Insert into post' ),
+ 'unattached' => __( 'Unattached' ),
+ 'trash' => _x( 'Trash', 'noun' ),
+ 'uploadedToThisPost' => $hier ? __( 'Uploaded to this page' ) : __( 'Uploaded to this post' ),
+ 'warnDelete' => __( "You are about to permanently delete this item.\n 'Cancel' to stop, 'OK' to delete." ),
+ 'warnBulkDelete' => __( "You are about to permanently delete these items.\n 'Cancel' to stop, 'OK' to delete." ),
+ 'warnBulkTrash' => __( "You are about to trash these items.\n 'Cancel' to stop, 'OK' to delete." ),
+ 'bulkSelect' => __( 'Bulk Select' ),
+ 'cancelSelection' => __( 'Cancel Selection' ),
+ 'trashSelected' => __( 'Trash Selected' ),
+ 'untrashSelected' => __( 'Untrash Selected' ),
+ 'deleteSelected' => __( 'Delete Selected' ),
+ 'deletePermanently' => __( 'Delete Permanently' ),
+ 'apply' => __( 'Apply' ),
+ 'filterByDate' => __( 'Filter by date' ),
+ 'filterByType' => __( 'Filter by type' ),
+ 'searchMediaLabel' => __( 'Search Media' ),
+ 'noMedia' => __( 'No media attachments found.' ),
+
+ // Library Details
+ 'attachmentDetails' => __( 'Attachment Details' ),
+
+ // From URL
+ 'insertFromUrlTitle' => __( 'Insert from URL' ),
+
+ // Featured Images
+ 'setFeaturedImageTitle' => __( 'Set Featured Image' ),
+ 'setFeaturedImage' => __( 'Set featured image' ),
+
+ // Gallery
+ 'createGalleryTitle' => __( 'Create Gallery' ),
+ 'editGalleryTitle' => __( 'Edit Gallery' ),
+ 'cancelGalleryTitle' => __( '← Cancel Gallery' ),
+ 'insertGallery' => __( 'Insert gallery' ),
+ 'updateGallery' => __( 'Update gallery' ),
+ 'addToGallery' => __( 'Add to gallery' ),
+ 'addToGalleryTitle' => __( 'Add to Gallery' ),
+ 'reverseOrder' => __( 'Reverse order' ),
+
+ // Edit Image
+ 'imageDetailsTitle' => __( 'Image Details' ),
+ 'imageReplaceTitle' => __( 'Replace Image' ),
+ 'imageDetailsCancel' => __( 'Cancel Edit' ),
+ 'editImage' => __( 'Edit Image' ),
+
+ // Crop Image
+ 'chooseImage' => __( 'Choose Image' ),
+ 'selectAndCrop' => __( 'Select and Crop' ),
+ 'skipCropping' => __( 'Skip Cropping' ),
+ 'cropImage' => __( 'Crop Image' ),
+ 'cropYourImage' => __( 'Crop your image' ),
+ 'cropping' => __( 'Cropping…' ),
+ 'suggestedDimensions' => __( 'Suggested image dimensions:' ),
+ 'cropError' => __( 'There has been an error cropping your image.' ),
+
+ // Edit Audio
+ 'audioDetailsTitle' => __( 'Audio Details' ),
+ 'audioReplaceTitle' => __( 'Replace Audio' ),
+ 'audioAddSourceTitle' => __( 'Add Audio Source' ),
+ 'audioDetailsCancel' => __( 'Cancel Edit' ),
+
+ // Edit Video
+ 'videoDetailsTitle' => __( 'Video Details' ),
+ 'videoReplaceTitle' => __( 'Replace Video' ),
+ 'videoAddSourceTitle' => __( 'Add Video Source' ),
+ 'videoDetailsCancel' => __( 'Cancel Edit' ),
+ 'videoSelectPosterImageTitle' => __( 'Select Poster Image' ),
+ 'videoAddTrackTitle' => __( 'Add Subtitles' ),
+
+ // Playlist
+ 'playlistDragInfo' => __( 'Drag and drop to reorder tracks.' ),
+ 'createPlaylistTitle' => __( 'Create Audio Playlist' ),
+ 'editPlaylistTitle' => __( 'Edit Audio Playlist' ),
+ 'cancelPlaylistTitle' => __( '← Cancel Audio Playlist' ),
+ 'insertPlaylist' => __( 'Insert audio playlist' ),
+ 'updatePlaylist' => __( 'Update audio playlist' ),
+ 'addToPlaylist' => __( 'Add to audio playlist' ),
+ 'addToPlaylistTitle' => __( 'Add to Audio Playlist' ),
+
+ // Video Playlist
+ 'videoPlaylistDragInfo' => __( 'Drag and drop to reorder videos.' ),
+ 'createVideoPlaylistTitle' => __( 'Create Video Playlist' ),
+ 'editVideoPlaylistTitle' => __( 'Edit Video Playlist' ),
+ 'cancelVideoPlaylistTitle' => __( '← Cancel Video Playlist' ),
+ 'insertVideoPlaylist' => __( 'Insert video playlist' ),
+ 'updateVideoPlaylist' => __( 'Update video playlist' ),
+ 'addToVideoPlaylist' => __( 'Add to video playlist' ),
+ 'addToVideoPlaylistTitle' => __( 'Add to Video Playlist' ),
+ );
+
/**
- * Passes any unlinked URLs that are on their own line to {@link WP_Embed::shortcode()} for potential embedding.
+ * Filter the media view settings.
*
- * @uses WP_Embed::autoembed_callback()
+ * @since 3.5.0
*
- * @param string $content The content to be searched.
- * @return string Potentially modified $content.
+ * @param array $settings List of media view settings.
+ * @param WP_Post $post Post object.
*/
- function autoembed( $content ) {
- return preg_replace_callback( '|^\s*(https?://[^\s"]+)\s*$|im', array(&$this, 'autoembed_callback'), $content );
- }
+ $settings = apply_filters( 'media_view_settings', $settings, $post );
/**
- * Callback function for {@link WP_Embed::autoembed()}.
+ * Filter the media view strings.
*
- * @uses WP_Embed::shortcode()
+ * @since 3.5.0
*
- * @param array $match A regex match array.
- * @return string The embed HTML on success, otherwise the original URL.
+ * @param array $strings List of media view strings.
+ * @param WP_Post $post Post object.
*/
- function autoembed_callback( $match ) {
- $oldval = $this->linkifunknown;
- $this->linkifunknown = false;
- $return = $this->shortcode( array(), $match[1] );
- $this->linkifunknown = $oldval;
+ $strings = apply_filters( 'media_view_strings', $strings, $post );
+
+ $strings['settings'] = $settings;
+
+ // Ensure we enqueue media-editor first, that way media-views is
+ // registered internally before we try to localize it. see #24724.
+ wp_enqueue_script( 'media-editor' );
+ wp_localize_script( 'media-views', '_wpMediaViewsL10n', $strings );
- return "\n$return\n";
+ wp_enqueue_script( 'media-audiovideo' );
+ wp_enqueue_style( 'media-views' );
+ if ( is_admin() ) {
+ wp_enqueue_script( 'mce-view' );
+ wp_enqueue_script( 'image-edit' );
}
+ wp_enqueue_style( 'imgareaselect' );
+ wp_plupload_default_settings();
+
+ require_once ABSPATH . WPINC . '/media-template.php';
+ add_action( 'admin_footer', 'wp_print_media_templates' );
+ add_action( 'wp_footer', 'wp_print_media_templates' );
+ add_action( 'customize_controls_print_footer_scripts', 'wp_print_media_templates' );
/**
- * Conditionally makes a hyperlink based on an internal class variable.
+ * Fires at the conclusion of wp_enqueue_media().
*
- * @param string $url URL to potentially be linked.
- * @return string Linked URL or the original URL.
+ * @since 3.5.0
*/
- function maybe_make_link( $url ) {
- $output = ( $this->linkifunknown ) ? '<a href="' . esc_attr($url) . '">' . esc_html($url) . '</a>' : $url;
- return apply_filters( 'embed_maybe_make_link', $output, $url );
- }
+ do_action( 'wp_enqueue_media' );
}
-$wp_embed = new WP_Embed();
/**
- * Register an embed handler. This function should probably only be used for sites that do not support oEmbed.
+ * Retrieve media attached to the passed post.
*
- * @since 2.9.0
- * @see WP_Embed::register_handler()
+ * @since 3.6.0
+ *
+ * @param string $type Mime type.
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
+ * @return array Found attachments.
*/
-function wp_embed_register_handler( $id, $regex, $callback, $priority = 10 ) {
- global $wp_embed;
- $wp_embed->register_handler( $id, $regex, $callback, $priority );
+function get_attached_media( $type, $post = 0 ) {
+ if ( ! $post = get_post( $post ) )
+ return array();
+
+ $args = array(
+ 'post_parent' => $post->ID,
+ 'post_type' => 'attachment',
+ 'post_mime_type' => $type,
+ 'posts_per_page' => -1,
+ 'orderby' => 'menu_order',
+ 'order' => 'ASC',
+ );
+
+ /**
+ * Filter arguments used to retrieve media attached to the given post.
+ *
+ * @since 3.6.0
+ *
+ * @param array $args Post query arguments.
+ * @param string $type Mime type of the desired media.
+ * @param mixed $post Post ID or object.
+ */
+ $args = apply_filters( 'get_attached_media_args', $args, $type, $post );
+
+ $children = get_children( $args );
+
+ /**
+ * Filter the list of media attached to the given post.
+ *
+ * @since 3.6.0
+ *
+ * @param array $children Associative array of media attached to the given post.
+ * @param string $type Mime type of the media desired.
+ * @param mixed $post Post ID or object.
+ */
+ return (array) apply_filters( 'get_attached_media', $children, $type, $post );
}
/**
- * Unregister a previously registered embed handler.
+ * Check the content blob for an audio, video, object, embed, or iframe tags.
*
- * @since 2.9.0
- * @see WP_Embed::unregister_handler()
+ * @since 3.6.0
+ *
+ * @param string $content A string which might contain media data.
+ * @param array $types array of media types: 'audio', 'video', 'object', 'embed', or 'iframe'
+ * @return array A list of found HTML media embeds
*/
-function wp_embed_unregister_handler( $id, $priority = 10 ) {
- global $wp_embed;
- $wp_embed->unregister_handler( $id, $priority );
+function get_media_embedded_in_content( $content, $types = null ) {
+ $html = array();
+ $allowed_media_types = array( 'audio', 'video', 'object', 'embed', 'iframe' );
+ if ( ! empty( $types ) ) {
+ if ( ! is_array( $types ) )
+ $types = array( $types );
+ $allowed_media_types = array_intersect( $allowed_media_types, $types );
+ }
+
+ foreach ( $allowed_media_types as $tag ) {
+ if ( preg_match( '#' . get_tag_regex( $tag ) . '#', $content, $matches ) ) {
+ $html[] = $matches[0];
+ }
+ }
+
+ return $html;
}
/**
- * Create default array of embed parameters.
+ * Retrieve galleries from the passed post's content.
*
- * @since 2.9.0
+ * @since 3.6.0
*
- * @return array Default embed parameters.
+ * @param int|WP_Post $post Optional. Post ID or object.
+ * @param bool $html Whether to return HTML or data in the array.
+ * @return array A list of arrays, each containing gallery data and srcs parsed
+ * from the expanded shortcode.
*/
-function wp_embed_defaults() {
- if ( !empty($GLOBALS['content_width']) )
- $theme_width = (int) $GLOBALS['content_width'];
-
- $width = get_option('embed_size_w');
-
- if ( empty($width) && !empty($theme_width) )
- $width = $theme_width;
-
- if ( empty($width) )
- $width = 500;
+function get_post_galleries( $post, $html = true ) {
+ if ( ! $post = get_post( $post ) )
+ return array();
- $height = get_option('embed_size_h');
+ if ( ! has_shortcode( $post->post_content, 'gallery' ) )
+ return array();
- if ( empty($height) )
- $height = 700;
+ $galleries = array();
+ if ( preg_match_all( '/' . get_shortcode_regex() . '/s', $post->post_content, $matches, PREG_SET_ORDER ) ) {
+ foreach ( $matches as $shortcode ) {
+ if ( 'gallery' === $shortcode[2] ) {
+ $srcs = array();
+
+ $gallery = do_shortcode_tag( $shortcode );
+ if ( $html ) {
+ $galleries[] = $gallery;
+ } else {
+ preg_match_all( '#src=([\'"])(.+?)\1#is', $gallery, $src, PREG_SET_ORDER );
+ if ( ! empty( $src ) ) {
+ foreach ( $src as $s )
+ $srcs[] = $s[2];
+ }
+
+ $data = shortcode_parse_atts( $shortcode[3] );
+ $data['src'] = array_values( array_unique( $srcs ) );
+ $galleries[] = $data;
+ }
+ }
+ }
+ }
- return apply_filters( 'embed_defaults', array(
- 'width' => $width,
- 'height' => $height,
- ) );
+ /**
+ * Filter the list of all found galleries in the given post.
+ *
+ * @since 3.6.0
+ *
+ * @param array $galleries Associative array of all found post galleries.
+ * @param WP_Post $post Post object.
+ */
+ return apply_filters( 'get_post_galleries', $galleries, $post );
}
/**
- * Based on a supplied width/height example, return the biggest possible dimensions based on the max width/height.
+ * Check a specified post's content for gallery and, if present, return the first
*
- * @since 2.9.0
- * @uses wp_constrain_dimensions() This function passes the widths and the heights.
+ * @since 3.6.0
*
- * @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.
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
+ * @param bool $html Whether to return HTML or data.
+ * @return string|array Gallery data and srcs parsed from the expanded shortcode.
*/
-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;
+function get_post_gallery( $post = 0, $html = true ) {
+ $galleries = get_post_galleries( $post, $html );
+ $gallery = reset( $galleries );
- return wp_constrain_dimensions( $example_width * 1000000, $example_height * 1000000, $max_width, $max_height );
+ /**
+ * Filter the first-found post gallery.
+ *
+ * @since 3.6.0
+ *
+ * @param array $gallery The first-found post gallery.
+ * @param int|WP_Post $post Post ID or object.
+ * @param array $galleries Associative array of all found post galleries.
+ */
+ return apply_filters( 'get_post_gallery', $gallery, $post, $galleries );
}
/**
- * Attempts to fetch the embed HTML for a provided URL using oEmbed.
- *
- * @since 2.9.0
- * @see WP_oEmbed
+ * Retrieve the image srcs from galleries from a post's content, if present
*
- * @uses _wp_oembed_get_object()
- * @uses WP_oEmbed::get_html()
+ * @since 3.6.0
*
- * @param string $url The URL that should be embeded.
- * @param array $args Addtional arguments and parameters.
- * @return string The original URL on failure or the embed HTML on success.
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
+ * @return array A list of lists, each containing image srcs parsed.
+ * from an expanded shortcode
*/
-function wp_oembed_get( $url, $args = '' ) {
- require_once( ABSPATH . WPINC . '/class-oembed.php' );
- $oembed = _wp_oembed_get_object();
- return $oembed->get_html( $url, $args );
+function get_post_galleries_images( $post = 0 ) {
+ $galleries = get_post_galleries( $post, false );
+ return wp_list_pluck( $galleries, 'src' );
}
/**
- * Adds a URL format and oEmbed provider URL pair.
- *
- * @since 2.9.0
- * @see WP_oEmbed
+ * Check a post's content for galleries and return the image srcs for the first found gallery
*
- * @uses _wp_oembed_get_object()
+ * @since 3.6.0
*
- * @param string $format The format of URL that this provider can handle. You can use asterisks as wildcards.
- * @param string $provider The URL to the oEmbed provider.
- * @param boolean $regex Whether the $format parameter is in a regex format.
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
+ * @return array A list of a gallery's image srcs in order.
*/
-function wp_oembed_add_provider( $format, $provider, $regex = false ) {
- require_once( ABSPATH . WPINC . '/class-oembed.php' );
- $oembed = _wp_oembed_get_object();
- $oembed->providers[$format] = array( $provider, $regex );
+function get_post_gallery_images( $post = 0 ) {
+ $gallery = get_post_gallery( $post, false );
+ return empty( $gallery['src'] ) ? array() : $gallery['src'];
}
/**
- * Determines if default embed handlers should be loaded.
+ * Maybe attempt to generate attachment metadata, if missing.
*
- * 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 3.9.0
*
- * @since 2.9.0
+ * @param WP_Post $attachment Attachment object.
*/
-function wp_maybe_load_embeds() {
- if ( ! apply_filters( 'load_default_embeds', true ) )
+function wp_maybe_generate_attachment_metadata( $attachment ) {
+ if ( empty( $attachment ) || ( empty( $attachment->ID ) || ! $attachment_id = (int) $attachment->ID ) ) {
return;
- wp_embed_register_handler( 'googlevideo', '#http://video\.google\.([A-Za-z.]{2,5})/videoplay\?docid=([\d-]+)(.*?)#i', 'wp_embed_handler_googlevideo' );
+ }
+
+ $file = get_attached_file( $attachment_id );
+ $meta = wp_get_attachment_metadata( $attachment_id );
+ if ( empty( $meta ) && file_exists( $file ) ) {
+ $_meta = get_post_meta( $attachment_id );
+ $regeneration_lock = 'wp_generating_att_' . $attachment_id;
+ if ( ! array_key_exists( '_wp_attachment_metadata', $_meta ) && ! get_transient( $regeneration_lock ) ) {
+ set_transient( $regeneration_lock, $file );
+ wp_update_attachment_metadata( $attachment_id, wp_generate_attachment_metadata( $attachment_id, $file ) );
+ delete_transient( $regeneration_lock );
+ }
+ }
}
/**
- * The Google Video embed handler callback. Google Video does not support oEmbed.
+ * Try to convert an attachment URL into a post ID.
*
- * @see WP_Embed::register_handler()
- * @see WP_Embed::shortcode()
+ * @since 4.0.0
*
- * @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.
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param string $url The URL to resolve.
+ * @return int The found post ID.
*/
-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'] );
+function attachment_url_to_postid( $url ) {
+ global $wpdb;
+
+ $dir = wp_upload_dir();
+ $path = $url;
+
+ if ( 0 === strpos( $path, $dir['baseurl'] . '/' ) ) {
+ $path = substr( $path, strlen( $dir['baseurl'] . '/' ) );
}
- 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 );
+ $sql = $wpdb->prepare(
+ "SELECT post_id FROM $wpdb->postmeta WHERE meta_key = '_wp_attached_file' AND meta_value = %s",
+ $path
+ );
+ $post_id = $wpdb->get_var( $sql );
+ if ( ! empty( $post_id ) ) {
+ return (int) $post_id;
+ }
}
-?>
\ No newline at end of file
+/**
+ * Return the URLs for CSS files used in an iframe-sandbox'd TinyMCE media view.
+ *
+ * @since 4.0.0
+ *
+ * @global $wp_version
+ *
+ * @return array The relevant CSS file URLs.
+ */
+function wpview_media_sandbox_styles() {
+ $version = 'ver=' . $GLOBALS['wp_version'];
+ $mediaelement = includes_url( "js/mediaelement/mediaelementplayer.min.css?$version" );
+ $wpmediaelement = includes_url( "js/mediaelement/wp-mediaelement.css?$version" );
+
+ return array( $mediaelement, $wpmediaelement );
+}