$max_height = $height;
}
+ /**
+ * 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
+ *
+ * @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.
+ * @return bool|array False, if no image was created. Metadata array on success.
*/
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,
+ );
}
/**
- * Registers an image size for the post thumbnail
+ * 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.
*
* @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.
+ * @return bool|array False, if no image was created. Metadata array on success.
*/
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.
$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);
+
+ /**
+ * 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;
// 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, intval( $current_width * $ratio ) );
+ $h = max ( 1, intval( $current_height * $ratio ) );
// Sometimes, due to rounding, we'll end up with a result like this: 465x700 in a 177x177 box is 117x176... a pixel short
// 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.
}
/**
- * Retrieve calculated resized dimensions for use in WP_Image_Editor.
+ * Retrieve calculated resize dimensions for use in WP_Image_Editor.
*
- * 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.
+ * Calculates dimensions and coordinates for a resized image that fits
+ * within a specified width and height.
+ *
+ * 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
- * @uses apply_filters() Calls 'image_resize_dimensions' on $orig_w, $orig_h, $dest_w, $dest_h and
- * $crop to provide custom resize dimensions.
- *
- * @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;
- // plugins can use this to provide custom resize dimensions
+ /**
+ * 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;
$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 ( 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.
*
+ * @since 2.5.0
+ *
* @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.
+ * @param mixed $attr Optional, attributes for the image markup.
* @return string HTML img element or empty string on failure.
*/
function wp_get_attachment_image($attachment_id, $size = 'thumbnail', $icon = false, $attr = '') {
$default_attr['alt'] = trim(strip_tags( $attachment->post_title )); // Finally, use the title
$attr = wp_parse_args($attr, $default_attr);
+
+ /**
+ * Filter the list of attachment image attributes.
+ *
+ * @since 2.8.0
+ *
+ * @param mixed $attr Attributes for the image markup.
+ * @param int $attachment_id Image attachment ID.
+ */
$attr = apply_filters( 'wp_get_attachment_image_attributes', $attr, $attachment );
$attr = array_map( 'esc_attr', $attr );
$html = rtrim("<img $hwstring");
*
* @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 ) ) {
}
}
- // 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'] ) . '" ';
- 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>';
+ $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 ' . $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 of 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) {
+function gallery_shortcode( $attr ) {
$post = get_post();
static $instance = 0;
$attr['include'] = $attr['ids'];
}
- // Allow plugins/themes to override the default gallery template.
- $output = apply_filters('post_gallery', '', $attr);
+ /**
+ * 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;
unset( $attr['orderby'] );
}
+ $html5 = current_theme_supports( 'html5', 'gallery' );
extract(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 )
$itemtag = tag_escape($itemtag);
$captiontag = tag_escape($captiontag);
+ $icontag = tag_escape($icontag);
+ $valid_tags = wp_kses_allowed_html( 'post' );
+ if ( ! isset( $valid_tags[ $itemtag ] ) )
+ $itemtag = 'dl';
+ if ( ! isset( $valid_tags[ $captiontag ] ) )
+ $captiontag = 'dd';
+ if ( ! isset( $valid_tags[ $icontag ] ) )
+ $icontag = 'dt';
+
$columns = intval($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 ) )
+
+ /**
+ * 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 -->";
+ /* see gallery_shortcode() in wp-includes/media.php */
+ </style>\n\t\t";
+ }
+
$size_class = sanitize_html_class( $size );
$gallery_div = "<div id='$selector' class='gallery galleryid-{$id} gallery-columns-{$columns} gallery-size-{$size_class}'>";
- $output = apply_filters( 'gallery_style', $gallery_style . "\n\t\t" . $gallery_div );
+
+ /**
+ * Filter the default gallery shortcode CSS styles.
+ *
+ * @since 2.5.0
+ *
+ * @param string $gallery_style Default gallery shortcode CSS styles.
+ * @param string $gallery_div 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);
+ if ( ! empty( $link ) && 'file' === $link )
+ $image_output = wp_get_attachment_link( $id, $size, false, false );
+ elseif ( ! empty( $link ) && 'none' === $link )
+ $image_output = wp_get_attachment_image( $id, $size, false );
+ else
+ $image_output = wp_get_attachment_link( $id, $size, true, false );
+
+ $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}>";
}
$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;
}
+/**
+ * Output the templates used by playlists.
+ *
+ * @since 3.9.0
+ */
+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
+}
+
+/**
+ * Output and enqueue default scripts and styles for playlists.
+ *
+ * @since 3.9.0
+ *
+ * @param string $type Type of playlist. Accepts 'audio' or 'video'.
+ */
+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' );
+
+/**
+ * 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 Playlist shortcode attributes.
+ * @return string Playlist output. Empty string if the passed type is unsupported.
+ */
+function wp_playlist_shortcode( $attr ) {
+ global $content_width;
+ $post = get_post();
+
+ static $instance = 0;
+ $instance++;
+
+ if ( ! empty( $attr['ids'] ) ) {
+ // 'ids' is explicitly ordered, unless you specify otherwise.
+ if ( empty( $attr['orderby'] ) ) {
+ $attr['orderby'] = 'post__in';
+ }
+ $attr['include'] = $attr['ids'];
+ }
+
+ /**
+ * 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;
+ }
+
+ /*
+ * 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'] );
+ }
+
+ extract( 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( $id );
+ if ( 'RAND' == $order ) {
+ $orderby = 'none';
+ }
+
+ $args = array(
+ 'post_status' => 'inherit',
+ 'post_type' => 'attachment',
+ 'post_mime_type' => $type,
+ 'order' => $order,
+ 'orderby' => $orderby
+ );
+
+ if ( ! empty( $include ) ) {
+ $args['include'] = $include;
+ $_attachments = get_posts( $args );
+
+ $attachments = array();
+ foreach ( $_attachments as $key => $val ) {
+ $attachments[$val->ID] = $_attachments[$key];
+ }
+ } elseif ( ! empty( $exclude ) ) {
+ $args['post_parent'] = $id;
+ $args['exclude'] = $exclude;
+ $attachments = get_children( $args );
+ } else {
+ $args['post_parent'] = $id;
+ $attachments = get_children( $args );
+ }
+
+ 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 = compact( 'type' );
+
+ // don't pass strings to JSON, will be truthy in JS
+ foreach ( array( 'tracklist', 'tracknumbers', 'images', 'artists' ) as $key ) {
+ $data[$key] = filter_var( $$key, FILTER_VALIDATE_BOOLEAN );
+ }
+
+ $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' === $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 ( $images ) {
+ $id = get_post_thumbnail_id( $attachment->ID );
+ if ( ! empty( $id ) ) {
+ list( $src, $width, $height ) = wp_get_attachment_image_src( $id, 'full' );
+ $track['image'] = compact( 'src', 'width', 'height' );
+ list( $src, $width, $height ) = wp_get_attachment_image_src( $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( $type );
+ $safe_style = esc_attr( $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', $type, $style );
+ } ?>
+<div class="wp-playlist wp-<?php echo $safe_type ?>-playlist wp-playlist-<?php echo $safe_style ?>">
+ <?php if ( 'audio' === $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"><?php echo 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' );
+ }
+
+ /**
+ * 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.
+ */
+ $html = apply_filters( 'wp_audio_shortcode_override', '', $attr, $content, $instances );
+ if ( '' !== $html )
+ return $html;
+
+ $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' );
+ extract( $atts );
+
+ $primary = false;
+ if ( ! empty( $src ) ) {
+ $type = wp_check_filetype( $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( $src ), esc_html( $src ) );
+ $primary = true;
+ array_unshift( $default_types, 'src' );
+ } else {
+ foreach ( $default_types as $ext ) {
+ if ( ! empty( $$ext ) ) {
+ $type = wp_check_filetype( $$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 );
+ $src = wp_get_attachment_url( $audio->ID );
+ if ( empty( $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.
+ */
+ $atts = array(
+ 'class' => apply_filters( 'wp_audio_shortcode_class', 'wp-audio-shortcode' ),
+ 'id' => sprintf( 'audio-%d-%d', $post_id, $instances ),
+ 'loop' => $loop,
+ 'autoplay' => $autoplay,
+ 'preload' => $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( $atts[$a] ) )
+ unset( $atts[$a] );
+ }
+
+ $attr_strings = array();
+ foreach ( $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( $$fallback ) ) {
+ if ( empty( $fileurl ) )
+ $fileurl = $$fallback;
+ $type = wp_check_filetype( $$fallback, wp_get_mime_types() );
+ $url = add_query_arg( '_', $instances, $$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.
+ */
+ $html = apply_filters( 'wp_video_shortcode_override', '', $attr, $content, $instances );
+ if ( '' !== $html )
+ return $html;
+
+ $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' );
+ extract( $atts );
+
+ if ( is_admin() ) {
+ // shrink the video so it isn't huge in the admin
+ if ( $width > $defaults_atts['width'] ) {
+ $height = round( ( $height * $defaults_atts['width'] ) / $width );
+ $width = $defaults_atts['width'];
+ }
+ } else {
+ // if the video is bigger than the theme
+ if ( ! empty( $content_width ) && $width > $content_width ) {
+ $height = round( ( $height * $content_width ) / $width );
+ $width = $content_width;
+ }
+ }
+
+ $yt_pattern = '#^https?://(:?www\.)?(:?youtube\.com/watch|youtu\.be/)#';
+
+ $primary = false;
+ if ( ! empty( $src ) ) {
+ if ( ! preg_match( $yt_pattern, $src ) ) {
+ $type = wp_check_filetype( $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( $src ), esc_html( $src ) );
+ }
+ }
+ $primary = true;
+ array_unshift( $default_types, 'src' );
+ } else {
+ foreach ( $default_types as $ext ) {
+ if ( ! empty( $$ext ) ) {
+ $type = wp_check_filetype( $$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 );
+ $src = wp_get_attachment_url( $video->ID );
+ if ( empty( $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.
+ */
+ $atts = array(
+ 'class' => apply_filters( 'wp_video_shortcode_class', 'wp-video-shortcode' ),
+ 'id' => sprintf( 'video-%d-%d', $post_id, $instances ),
+ 'width' => absint( $width ),
+ 'height' => absint( $height ),
+ 'poster' => esc_url( $poster ),
+ 'loop' => $loop,
+ 'autoplay' => $autoplay,
+ 'preload' => $preload,
+ );
+
+ // These ones should just be omitted altogether if they are blank
+ foreach ( array( 'poster', 'loop', 'autoplay', 'preload' ) as $a ) {
+ if ( empty( $atts[$a] ) )
+ unset( $atts[$a] );
+ }
+
+ $attr_strings = array();
+ foreach ( $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( $$fallback ) ) {
+ if ( empty( $fileurl ) )
+ $fileurl = $$fallback;
+
+ if ( 'src' === $fallback && preg_match( $yt_pattern, $src ) ) {
+ $type = array( 'type' => 'video/youtube' );
+ } else {
+ $type = wp_check_filetype( $$fallback, wp_get_mime_types() );
+ }
+ $url = add_query_arg( '_', $instances, $$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>';
+
+ $html = sprintf( '<div style="width: %dpx; max-width: 100%%;" class="wp-video">%s</div>', $width, $html );
+
+ /**
+ * Filter the output of the video shortcode.
+ *
+ * @since 3.6.0
+ *
+ * @param string $html 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', $html, $atts, $video, $post_id, $library );
+}
+add_shortcode( 'video', 'wp_video_shortcode' );
+
/**
* Display previous image link that has the same post parent.
*
}
$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 );
}
$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.
+ */
return apply_filters( 'embed_defaults', compact( 'width', 'height' ) );
}
/**
* Removes an oEmbed provider.
*
- * @since 3.5
+ * @since 3.5.0
* @see WP_oEmbed
*
* @uses _wp_oembed_get_object()
* @since 2.9.0
*/
function wp_maybe_load_embeds() {
- if ( ! apply_filters( 'load_default_embeds', true ) )
+ /**
+ * 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( '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 );
}
/**
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 );
}
/**
- * {@internal Missing Short Description}}
+ * 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 );
+}
+
+/**
+ * Video 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_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'] );
+ }
+ $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 );
+}
+
+/**
+ * Converts a shorthand byte value to an integer byte value.
*
* @since 2.3.0
*
- * @param unknown_type $size
- * @return unknown
+ * @param string $size A shorthand byte value.
+ * @return int An integer byte value.
*/
function wp_convert_hr_to_bytes( $size ) {
$size = strtolower( $size );
}
/**
- * {@internal Missing Short Description}}
- *
- * @since 2.3.0
- *
- * @param unknown_type $bytes
- * @return unknown
- */
-function wp_convert_bytes_to_hr( $bytes ) {
- $units = array( 0 => 'B', 1 => 'kB', 2 => 'MB', 3 => 'GB' );
- $log = log( $bytes, 1024 );
- $power = (int) $log;
- $size = pow( 1024, $log - $power );
- return $size . $units[$power];
-}
-
-/**
- * {@internal Missing Short Description}}
+ * Determine the maximum upload size allowed in php.ini.
*
* @since 2.5.0
*
- * @return unknown
+ * @return int Allowed upload size.
*/
function wp_max_upload_size() {
$u_bytes = wp_convert_hr_to_bytes( ini_get( 'upload_max_filesize' ) );
$p_bytes = wp_convert_hr_to_bytes( ini_get( 'post_max_size' ) );
- $bytes = apply_filters( 'upload_size_limit', min( $u_bytes, $p_bytes ), $u_bytes, $p_bytes );
- return $bytes;
+
+ /**
+ * 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.
+ */
+ return apply_filters( 'upload_size_limit', min( $u_bytes, $p_bytes ), $u_bytes, $p_bytes );
}
/**
$args['path'] = $path;
if ( ! isset( $args['mime_type'] ) ) {
- $file_info = wp_check_filetype( $args['path'] );
+ $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.
* @since 3.5.0
* @access public
*
- * @param string|array $args Array of requirements. Accepts { 'mime_type'=>string, 'methods'=>{string, string, ...} }
+ * @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() ) {
require_once ABSPATH . WPINC . '/class-wp-image-editor-gd.php';
require_once ABSPATH . WPINC . '/class-wp-image-editor-imagick.php';
- $implementations = apply_filters( 'wp_image_editors',
- array( 'WP_Image_Editor_Imagick', 'WP_Image_Editor_GD' ) );
+ /**
+ * Filter the list of image editing library classes.
+ *
+ * @since 3.5.0
+ *
+ * @param array $image_editors List of available image editors. Defaults are
+ * 'WP_Image_Editor_Imagick', 'WP_Image_Editor_GD'.
+ */
+ $implementations = apply_filters( 'wp_image_editors', array( 'WP_Image_Editor_Imagick', 'WP_Image_Editor_GD' ) );
foreach ( $implementations as $implementation ) {
if ( ! call_user_func( array( $implementation, 'test' ), $args ) )
$max_upload_size = wp_max_upload_size();
$defaults = array(
- 'runtimes' => 'html5,silverlight,flash,html4',
+ 'runtimes' => 'html5,flash,silverlight,html4',
'file_data_name' => 'async-upload', // key passed to $_FILE.
- 'multiple_queues' => true,
- 'max_file_size' => $max_upload_size . 'b',
'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( array( 'title' => __( 'Allowed Files' ), 'extensions' => '*') ),
- 'multipart' => true,
- 'urlstream_upload' => true,
+ 'filters' => array(
+ 'max_file_size' => $max_upload_size . 'b',
+ ),
);
// Multi-file uploading doesn't currently work in iOS Safari,
if ( wp_is_mobile() )
$defaults['multi_selection'] = false;
+ /**
+ * Filter the Plupload default settings.
+ *
+ * @since 3.4.0
+ *
+ * @param array $defaults Default Plupload settings array.
+ */
$defaults = apply_filters( 'plupload_default_settings', $defaults );
$params = array(
'action' => 'upload-attachment',
);
+ /**
+ * Filter the Plupload default parameters.
+ *
+ * @since 3.4.0
+ *
+ * @param array $params Default Plupload parameters array.
+ */
$params = apply_filters( 'plupload_default_params', $params );
$params['_wpnonce'] = wp_create_nonce( 'media-form' );
$defaults['multipart_params'] = $params;
$response = array(
'id' => $attachment->ID,
'title' => $attachment->post_title,
- 'filename' => basename( $attachment->guid ),
+ '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 ),
'nonces' => array(
'update' => false,
'delete' => false,
+ 'edit' => false
),
'editLink' => false,
);
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' );
}
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'),
// 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;
$size_meta = $meta['sizes'][ $size ];
// We have the actual image size, but might need to further constrain it if content_width is narrower.
- // This is not necessary for thumbnails and medium size.
- if ( 'thumbnail' == $size || 'medium' == $size ) {
- $width = $size_meta['width'];
- $height = $size_meta['height'];
- } else {
- list( $width, $height ) = image_constrain_size_for_editor( $size_meta['width'], $size_meta['height'], $size, 'edit' );
- }
+ // 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,
}
}
- $sizes['full'] = array(
- 'height' => $meta['height'],
- 'width' => $meta['width'],
- 'url' => $attachment_url,
- 'orientation' => $meta['height'] > $meta['width'] ? 'portrait' : 'landscape',
- );
+ $sizes['full'] = array( 'url' => $attachment_url );
+
+ if ( isset( $meta['height'], $meta['width'] ) ) {
+ $sizes['full']['height'] = $meta['height'];
+ $sizes['full']['width'] = $meta['width'];
+ $sizes['full']['orientation'] = $meta['height'] > $meta['width'] ? 'portrait' : 'landscape';
+ }
$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'];
+
+ $response['meta'] = array();
+ foreach ( wp_get_attachment_id3_keys( $attachment ) as $key => $label ) {
+ if ( ! empty( $meta[ $key ] ) ) {
+ $response['meta'][ $key ] = $meta[ $key ];
+ }
+ }
+
+ $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 ) );
+ /**
+ * Filter the attachment data prepared for JavaScript.
+ *
+ * @since 3.5.0
+ *
+ * @param array $response Array of prepared attachment data.
+ * @param int|object $attachment Attachment ID or object.
+ * @param array $meta Array of attachment meta data.
+ */
return apply_filters( 'wp_prepare_attachment_for_js', $response, $attachment, $meta );
}
* @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;
+
$defaults = array(
'post' => null,
);
'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;
+ }
+ }
+ }
+
+ $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
+ " );
+
$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' => (int) $has_audio,
+ 'video' => (int) $has_video,
+ ),
+ 'embedExts' => $exts,
+ 'embedMimes' => $ext_mimes,
+ 'contentWidth' => $content_width,
);
$post = null;
'nonce' => wp_create_nonce( 'update-post_' . $post->ID ),
);
- if ( current_theme_supports( 'post-thumbnails', $post->post_type ) && post_type_supports( $post->post_type, 'thumbnail' ) ) {
+ $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' );
+ }
+ }
+
+ if ( $thumbnail_support ) {
$featured_image_id = get_post_meta( $post->ID, '_thumbnail_id', true );
$settings['post']['featuredImageId'] = $featured_image_id ? $featured_image_id : -1;
}
'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.
'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' ),
'noItemsFound' => __( 'No items found.' ),
'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' ),
);
+ /**
+ * Filter the media view settings.
+ *
+ * @since 3.5.0
+ *
+ * @param array $settings List of media view settings.
+ * @param WP_Post $post Post object.
+ */
$settings = apply_filters( 'media_view_settings', $settings, $post );
- $strings = apply_filters( 'media_view_strings', $strings, $post );
+
+ /**
+ * Filter the media view strings.
+ *
+ * @since 3.5.0
+ *
+ * @param array $strings List of media view strings.
+ * @param WP_Post $post Post object.
+ */
+ $strings = apply_filters( 'media_view_strings', $strings, $post );
$strings['settings'] = $settings;
wp_localize_script( 'media-views', '_wpMediaViewsL10n', $strings );
wp_enqueue_script( 'media-editor' );
+ 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' );
+ /**
+ * Fires at the conclusion of wp_enqueue_media().
+ *
+ * @since 3.5.0
+ */
do_action( 'wp_enqueue_media' );
}
+
+/**
+ * Retrieve media attached to the passed post.
+ *
+ * @since 3.6.0
+ *
+ * @param string $type (Mime) type of media desired
+ * @param mixed $post Post ID or object
+ * @return array Found attachments
+ */
+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
+ *
+ * @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 );
+}
+
+/**
+ * Check the content blob for an <audio>, <video> <object>, <embed>, or <iframe>
+ *
+ * @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 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;
+}
+
+/**
+ * Retrieve galleries from the passed post's content.
+ *
+ * @since 3.6.0
+ *
+ * @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 get_post_galleries( $post, $html = true ) {
+ if ( ! $post = get_post( $post ) )
+ return array();
+
+ if ( ! has_shortcode( $post->post_content, 'gallery' ) )
+ return array();
+
+ $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();
+ $count = 1;
+
+ $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;
+ }
+ }
+ }
+ }
+
+ /**
+ * 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 );
+}
+
+/**
+ * Check a specified post's content for gallery and, if present, return the first
+ *
+ * @since 3.6.0
+ *
+ * @param int|WP_Post $post Optional. Post ID or object.
+ * @param bool $html Whether to return HTML or data.
+ * @return string|array Gallery data and srcs parsed from the expanded shortcode.
+ */
+function get_post_gallery( $post = 0, $html = true ) {
+ $galleries = get_post_galleries( $post, $html );
+ $gallery = reset( $galleries );
+
+ /**
+ * 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 );
+}
+
+/**
+ * Retrieve the image srcs from galleries from a post's content, if present
+ *
+ * @since 3.6.0
+ *
+ * @param mixed $post Optional. Post ID or object.
+ * @return array A list of lists, each containing image srcs parsed
+ * from an expanded shortcode
+ */
+function get_post_galleries_images( $post = 0 ) {
+ $galleries = get_post_galleries( $post, false );
+ return wp_list_pluck( $galleries, 'src' );
+}
+
+/**
+ * Check a post's content for galleries and return the image srcs for the first found gallery
+ *
+ * @since 3.6.0
+ *
+ * @param mixed $post Optional. Post ID or object.
+ * @return array A list of a gallery's image srcs in order
+ */
+function get_post_gallery_images( $post = 0 ) {
+ $gallery = get_post_gallery( $post, false );
+ return empty( $gallery['src'] ) ? array() : $gallery['src'];
+}
+
+/**
+ * Maybe attempt to generate attachment metadata, if missing.
+ *
+ * @since 3.9.0
+ *
+ * @param WP_Post $attachment Attachment object.
+ */
+function wp_maybe_generate_attachment_metadata( $attachment ) {
+ if ( empty( $attachment ) || ( empty( $attachment->ID ) || ! $attachment_id = (int) $attachment->ID ) ) {
+ return;
+ }
+
+ $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 );
+ }
+ }
+}