X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/f9001779751f83dc8a10e478bfecb4d8dd5f964c..baca9ce86a38dc54c4574890ee2d352fd81f78b2:/wp-includes/media.php diff --git a/wp-includes/media.php b/wp-includes/media.php index 041c4e56..d664e073 100644 --- a/wp-includes/media.php +++ b/wp-includes/media.php @@ -3,6 +3,7 @@ * WordPress API for media display. * * @package WordPress + * @subpackage Media */ /** @@ -17,7 +18,7 @@ * 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 + * 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 * 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 @@ -29,11 +30,15 @@ * @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 context Could be 'display' (like in a theme) or 'edit' (like inserting into an editor) * @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]; @@ -53,9 +58,9 @@ function image_constrain_size_for_editor($width, $height, $size = 'medium') { // 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')); @@ -64,7 +69,7 @@ function image_constrain_size_for_editor($width, $height, $size = 'medium') { } 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 @@ -73,7 +78,7 @@ function image_constrain_size_for_editor($width, $height, $size = 'medium') { $max_height = $height; } - list( $max_width, $max_height ) = apply_filters( 'editor_max_image_size', array( $max_width, $max_height ), $size ); + 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 ); } @@ -125,7 +130,7 @@ function image_hwstring($width, $height) { * resize services. * * @param int $id Attachment ID for image. - * @param string $size Optional, default is 'medium'. Size of image, can be 'thumbnail'. + * @param array|string $size Optional, default is 'medium'. Size of image, either array or string. * @return bool|array False on failure, array on success. */ function image_downsize($id, $size = 'medium') { @@ -177,6 +182,8 @@ function image_downsize($id, $size = 'medium') { /** * Registers a new image size + * + * @since 2.9.0 */ function add_image_size( $name, $width = 0, $height = 0, $crop = false ) { global $_wp_additional_image_sizes; @@ -185,6 +192,8 @@ function add_image_size( $name, $width = 0, $height = 0, $crop = false ) { /** * Registers an image size for the post thumbnail + * + * @since 2.9.0 */ function set_post_thumbnail_size( $width = 0, $height = 0, $crop = false ) { add_image_size( 'post-thumbnail', $width, $height, $crop ); @@ -221,10 +230,12 @@ function get_image_tag($id, $alt, $title, $align, $size='medium') { 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 = '' . esc_attr($alt) . ''; + $html = '' . esc_attr($alt) . ''; $html = apply_filters( 'get_image_tag', $html, $id, $alt, $title, $align, $size ); @@ -232,35 +243,7 @@ function get_image_tag($id, $alt, $title, $align, $size='medium') { } /** - * 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', '256M'); - $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. @@ -305,7 +288,7 @@ function wp_constrain_dimensions( $current_width, $current_height, $max_width=0, $h = intval( $current_height * $ratio ); // Sometimes, due to rounding, we'll end up with a result like this: 465x700 in a 177x177 box is 117x176... a pixel short - // 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 ) $w = $max_width; // Round it up @@ -316,20 +299,22 @@ function wp_constrain_dimensions( $current_width, $current_height, $max_width=0, } /** - * Retrieve calculated resized dimensions for use in imagecopyresampled(). + * Retrieve calculated resized 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. * * @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. + * @return bool|array False on failure. Returned array matches parameters for imagecopyresampled() PHP function. */ function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop = false) { @@ -339,6 +324,11 @@ function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop = fal if ($dest_w <= 0 && $dest_h <= 0) return false; + // plugins can use this to provide custom resize dimensions + $output = apply_filters( 'image_resize_dimensions', null, $orig_w, $orig_h, $dest_w, $dest_h, $crop ); + if ( null !== $output ) + return $output; + 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; @@ -381,91 +371,6 @@ function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop = fal } -/** - * 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. * @@ -481,16 +386,18 @@ function image_resize( $file, $max_w, $max_h, $crop = false, $suffix = null, $de * @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; @@ -643,12 +550,11 @@ function wp_get_attachment_image($attachment_id, $size = 'thumbnail', $icon = fa $hwstring = image_hwstring($width, $height); if ( is_array($size) ) $size = join('x', $size); - $attachment =& get_post($attachment_id); + $attachment = get_post($attachment_id); $default_attr = array( 'src' => $src, 'class' => "attachment-$size", '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 @@ -669,9 +575,9 @@ function wp_get_attachment_image($attachment_id, $size = 'thumbnail', $icon = fa } /** - * 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 @@ -720,6 +626,13 @@ add_shortcode('caption', 'img_caption_shortcode'); * @return string */ 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( '#((?:]+>\s*)?]+>(?:\s*)?)(.*)#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); @@ -752,15 +665,22 @@ add_shortcode('gallery', 'gallery_shortcode'); * * @since 2.5.0 * - * @param array $attr Attributes attributed to the shortcode. + * @param array $attr Attributes of the shortcode. * @return string HTML content to display gallery. */ function gallery_shortcode($attr) { - global $post, $wp_locale; + $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']; + } + // Allow plugins/themes to override the default gallery template. $output = apply_filters('post_gallery', '', $attr); if ( $output != '' ) @@ -791,7 +711,6 @@ function gallery_shortcode($attr) { $orderby = 'none'; 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) ); $attachments = array(); @@ -799,7 +718,6 @@ function gallery_shortcode($attr) { $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) ); } else { $attachments = get_children( array('post_parent' => $id, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $order, 'orderby' => $orderby) ); @@ -817,6 +735,15 @@ function gallery_shortcode($attr) { $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'; @@ -906,12 +833,11 @@ function next_image_link($size = 'thumbnail', $text = false) { * * @since 2.5.0 * - * @param bool $prev Optional. Default is true to display previous link, true for next. + * @param bool $prev Optional. Default is true to display previous link, false for next. */ 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') )); + $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 ) @@ -919,8 +845,14 @@ function adjacent_image_link($prev = true, $size = 'thumbnail', $text = false) { $k = $prev ? $k - 1 : $k + 1; - if ( isset($attachments[$k]) ) - echo wp_get_attachment_link($attachments[$k]->ID, $size, true, false, $text); + $output = $attachment_id = null; + if ( isset( $attachments[ $k ] ) ) { + $attachment_id = $attachments[ $k ]->ID; + $output = wp_get_attachment_link( $attachment_id, $size, true, false, $text ); + } + + $adjacent = $prev ? 'previous' : 'next'; + echo apply_filters( "{$adjacent}_image_link", $output, $attachment_id, $size, $text ); } /** @@ -963,38 +895,37 @@ function get_attachment_taxonomies($attachment) { } /** - * Check if the installed version of GD supports particular image type + * Return all of the taxonomy names that are registered for attachments. * - * @since 2.9.0 + * Handles mime-type-specific taxonomies such as attachment:image and attachment:video. + * + * @since 3.5.0 + * @see get_attachment_taxonomies() + * @uses get_taxonomies() * - * @param string $mime_type - * @return bool + * @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 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; - } - } 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'); +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 false; + + return $taxonomies; } /** * Create new GD image resource with transparency support + * @TODO: Deprecate if possible. * * @since 2.9.0 * @@ -1011,292 +942,6 @@ function wp_imagecreatetruecolor($width, $height) { return $img; } -/** - * API for easily embedding rich media such as videos and images into content. - * - * @package WordPress - * @subpackage Embed - * @since 2.9.0 - */ -class WP_Embed { - var $handlers = array(); - var $post_ID; - var $usecache = true; - var $linkifunknown = true; - - /** - * PHP4 constructor - */ - function WP_Embed() { - return $this->__construct(); - } - - /** - * PHP5 constructor - */ - function __construct() { - // Hack to get the [embed] shortcode to run before wpautop() - add_filter( 'the_content', array(&$this, 'run_shortcode'), 8 ); - - // Shortcode placeholder for strip_shortcodes() - add_shortcode( 'embed', '__return_false' ); - - // Attempts to embed all URLs in a post - if ( get_option('embed_autourls') ) - add_filter( 'the_content', array(&$this, 'autoembed'), 8 ); - - // After a post is saved, invalidate the oEmbed cache - add_action( 'save_post', array(&$this, 'delete_oembed_caches') ); - - // After a post is saved, cache oEmbed items via AJAX - add_action( 'edit_form_advanced', array(&$this, 'maybe_run_ajax_cache') ); - } - - /** - * Process the [embed] shortcode. - * - * 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. - * - * @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 - */ - 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(); - - add_shortcode( 'embed', array(&$this, 'shortcode') ); - - // Do the shortcode (only the [embed] one is registered) - $content = do_shortcode( $content ); - - // Put the original shortcodes back - $shortcode_tags = $orig_shortcode_tags; - - return $content; - } - - /** - * 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; - - if ( empty($post_ID) || empty($_GET['message']) || 1 != $_GET['message'] ) - return; - -?> - -handlers[$priority][$id] = array( - 'regex' => $regex, - 'callback' => $callback, - ); - } - - /** - * Unregister a previously registered embed handler. Do not use this function directly, use {@link wp_embed_unregister_handler()} instead. - * - * @param string $id The handler ID that should be removed. - * @param int $priority Optional. The priority of the handler to be removed (default: 10). - */ - function unregister_handler( $id, $priority = 10 ) { - if ( isset($this->handlers[$priority][$id]) ) - unset($this->handlers[$priority][$id]); - } - - /** - * 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 ); - } - } - } - - $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; - - // Unknown URL format. Let oEmbed have a go. - if ( $post_ID ) { - - // 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 ); - - // Failures are cached - if ( '{{unknown}}' === $cache ) - return $this->maybe_make_link( $url ); - - if ( !empty($cache) ) - return apply_filters( 'embed_oembed_html', $cache, $url, $attr, $post_ID ); - } - - // 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 ); - - // Cache the result - $cache = ( $html ) ? $html : '{{unknown}}'; - update_post_meta( $post_ID, $cachekey, $cache ); - - // If there was a result, return it - if ( $html ) - return apply_filters( 'embed_oembed_html', $html, $url, $attr, $post_ID ); - } - - // Still unknown - return $this->maybe_make_link( $url ); - } - - /** - * Delete all oEmbed caches. - * - * @param int $post_ID Post ID to delete the caches for. - */ - function delete_oembed_caches( $post_ID ) { - $post_metas = get_post_custom_keys( $post_ID ); - if ( empty($post_metas) ) - return; - - foreach( $post_metas as $post_meta_key ) { - if ( '_oembed_' == substr( $post_meta_key, 0, 8 ) ) - delete_post_meta( $post_ID, $post_meta_key ); - } - } - - /** - * 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; - - // Trigger a caching - if ( !empty($post->post_content) ) { - $this->post_ID = $post->ID; - $this->usecache = false; - - $content = $this->run_shortcode( $post->post_content ); - if ( get_option('embed_autourls') ) - $this->autoembed( $content ); - - $this->usecache = true; - } - } - - /** - * Passes any unlinked URLs that are on their own line to {@link WP_Embed::shortcode()} for potential embedding. - * - * @uses WP_Embed::autoembed_callback() - * - * @param string $content The content to be searched. - * @return string Potentially modified $content. - */ - function autoembed( $content ) { - return preg_replace_callback( '|^\s*(https?://[^\s"]+)\s*$|im', array(&$this, 'autoembed_callback'), $content ); - } - - /** - * Callback function for {@link WP_Embed::autoembed()}. - * - * @uses WP_Embed::shortcode() - * - * @param array $match A regex match array. - * @return string The embed HTML on success, otherwise the original URL. - */ - function autoembed_callback( $match ) { - $oldval = $this->linkifunknown; - $this->linkifunknown = false; - $return = $this->shortcode( array(), $match[1] ); - $this->linkifunknown = $oldval; - - return "\n$return\n"; - } - - /** - * Conditionally makes a hyperlink based on an internal class variable. - * - * @param string $url URL to potentially be linked. - * @return string Linked URL or the original URL. - */ - function maybe_make_link( $url ) { - $output = ( $this->linkifunknown ) ? '' . esc_html($url) . '' : $url; - return apply_filters( 'embed_maybe_make_link', $output, $url ); - } -} -$wp_embed = new WP_Embed(); - /** * Register an embed handler. This function should probably only be used for sites that do not support oEmbed. * @@ -1322,31 +967,27 @@ function wp_embed_unregister_handler( $id, $priority = 10 ) { /** * 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 * * @return array Default embed parameters. */ function wp_embed_defaults() { - if ( !empty($GLOBALS['content_width']) ) - $theme_width = (int) $GLOBALS['content_width']; + if ( ! empty( $GLOBALS['content_width'] ) ) + $width = (int) $GLOBALS['content_width']; - $width = get_option('embed_size_w'); - - if ( empty($width) && !empty($theme_width) ) - $width = $theme_width; - - if ( empty($width) ) + if ( empty( $width ) ) $width = 500; - $height = get_option('embed_size_h'); + $height = min( ceil( $width * 1.5 ), 1000 ); - if ( empty($height) ) - $height = 700; - - return apply_filters( 'embed_defaults', array( - 'width' => $width, - 'height' => $height, - ) ); + return apply_filters( 'embed_defaults', compact( 'width', 'height' ) ); } /** @@ -1379,9 +1020,9 @@ function wp_expand_dimensions( $example_width, $example_height, $max_width, $max * @uses _wp_oembed_get_object() * @uses WP_oEmbed::get_html() * - * @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 string $url The URL that should be embedded. + * @param array $args Additional arguments and parameters. + * @return bool|string False on failure or the embed HTML on success. */ function wp_oembed_get( $url, $args = '' ) { require_once( ABSPATH . WPINC . '/class-oembed.php' ); @@ -1405,4 +1046,515 @@ 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 ); -} \ No newline at end of file +} + +/** + * Removes an oEmbed provider. + * + * @since 3.5 + * @see WP_oEmbed + * + * @uses _wp_oembed_get_object() + * + * @param string $format The URL format for the oEmbed provider to remove. + */ +function wp_oembed_remove_provider( $format ) { + require_once( ABSPATH . WPINC . '/class-oembed.php' ); + + $oembed = _wp_oembed_get_object(); + + if ( isset( $oembed->providers[ $format ] ) ) { + unset( $oembed->providers[ $format ] ); + return true; + } + + return false; +} + +/** + * Determines if default embed handlers should be loaded. + * + * Checks to make sure that the embeds library hasn't already been loaded. If + * it hasn't, then it will load the embeds library. + * + * @since 2.9.0 + */ +function wp_maybe_load_embeds() { + if ( ! apply_filters( 'load_default_embeds', true ) ) + return; + wp_embed_register_handler( 'googlevideo', '#http://video\.google\.([A-Za-z.]{2,5})/videoplay\?docid=([\d-]+)(.*?)#i', 'wp_embed_handler_googlevideo' ); +} + +/** + * The Google Video embed handler callback. Google Video does not support oEmbed. + * + * @see WP_Embed::register_handler() + * @see WP_Embed::shortcode() + * + * @param array $matches The regex matches from the provided regex when calling {@link wp_embed_register_handler()}. + * @param array $attr Embed attributes. + * @param string $url The original URL that was matched by the regex. + * @param array $rawattr The original unmodified attributes. + * @return string The embed HTML. + */ +function wp_embed_handler_googlevideo( $matches, $attr, $url, $rawattr ) { + // If the user supplied a fixed width AND height, use it + if ( !empty($rawattr['width']) && !empty($rawattr['height']) ) { + $width = (int) $rawattr['width']; + $height = (int) $rawattr['height']; + } else { + list( $width, $height ) = wp_expand_dimensions( 425, 344, $attr['width'], $attr['height'] ); + } + + return apply_filters( 'embed_googlevideo', '', $matches, $attr, $url, $rawattr ); +} + +/** + * {@internal Missing Short Description}} + * + * @since 2.3.0 + * + * @param unknown_type $size + * @return unknown + */ +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; +} + +/** + * {@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}} + * + * @since 2.5.0 + * + * @return unknown + */ +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; +} + +/** + * 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']; + } + + $implementation = _wp_image_editor_choose( $args ); + + if ( $implementation ) { + $editor = new $implementation( $path ); + $loaded = $editor->load(); + + if ( is_wp_error( $loaded ) ) + return $loaded; + + return $editor; + } + + return new WP_Error( 'image_no_editor', __('No editor could be selected.') ); +} + +/** + * Tests whether there is an editor that supports a given mime type or methods. + * + * @since 3.5.0 + * @access public + * + * @param string|array $args Array of requirements. Accepts { 'mime_type'=>string, 'methods'=>{string, string, ...} } + * @return boolean true if an eligible editor is found; false otherwise + */ +function wp_image_editor_supports( $args = array() ) { + return (bool) _wp_image_editor_choose( $args ); +} + +/** + * Tests which editors are capable of supporting the request. + * + * @since 3.5.0 + * @access private + * + * @param array $args Additional data. Accepts { 'mime_type'=>string, 'methods'=>{string, string, ...} } + * @return string|bool Class name for the first editor that claims to support the request. False if no editor claims to support the request. + */ +function _wp_image_editor_choose( $args = array() ) { + require_once ABSPATH . WPINC . '/class-wp-image-editor.php'; + require_once ABSPATH . WPINC . '/class-wp-image-editor-gd.php'; + require_once ABSPATH . WPINC . '/class-wp-image-editor-imagick.php'; + + $implementations = apply_filters( 'wp_image_editors', + array( 'WP_Image_Editor_Imagick', 'WP_Image_Editor_GD' ) ); + + foreach ( $implementations as $implementation ) { + if ( ! call_user_func( array( $implementation, 'test' ), $args ) ) + continue; + + if ( isset( $args['mime_type'] ) && + ! call_user_func( + array( $implementation, 'supports_mime_type' ), + $args['mime_type'] ) ) { + continue; + } + + if ( isset( $args['methods'] ) && + array_diff( $args['methods'], get_class_methods( $implementation ) ) ) { + continue; + } + + return $implementation; + } + + return false; +} + +/** + * Prints default plupload arguments. + * + * @since 3.4.0 + */ +function wp_plupload_default_settings() { + global $wp_scripts; + + $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,silverlight,flash,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, + ); + + // Multi-file uploading doesn't currently work in iOS Safari, + // single-file allows the built-in camera to be used as source for images + if ( wp_is_mobile() ) + $defaults['multi_selection'] = false; + + $defaults = apply_filters( 'plupload_default_settings', $defaults ); + + $params = array( + 'action' => 'upload-attachment', + ); + + $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 = ' . 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' => 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, + ), + 'editLink' => false, + ); + + if ( current_user_can( 'edit_post', $attachment->ID ) ) { + $response['nonces']['update'] = wp_create_nonce( 'update-post_' . $attachment->ID ); + $response['editLink'] = get_edit_post_link( $attachment->ID, 'raw' ); + } + + if ( current_user_can( 'delete_post', $attachment->ID ) ) + $response['nonces']['delete'] = wp_create_nonce( 'delete-post_' . $attachment->ID ); + + if ( $meta && 'image' === $type ) { + $sizes = array(); + $possible_sizes = apply_filters( 'image_size_names_choose', array( + 'thumbnail' => __('Thumbnail'), + 'medium' => __('Medium'), + 'large' => __('Large'), + 'full' => __('Full Size'), + ) ); + unset( $possible_sizes['full'] ); + + // Loop through all potential sizes that may be chosen. Try to do this with some efficiency. + // First: run the image_downsize filter. If it returns something, we can use its data. + // If the filter does not return something, then image_downsize() is just an expensive + // way to check the image metadata, which we do second. + foreach ( $possible_sizes as $size => $label ) { + if ( $downsize = apply_filters( 'image_downsize', false, $attachment->ID, $size ) ) { + if ( ! $downsize[3] ) + continue; + $sizes[ $size ] = array( + 'height' => $downsize[2], + 'width' => $downsize[1], + 'url' => $downsize[0], + 'orientation' => $downsize[2] > $downsize[1] ? 'portrait' : 'landscape', + ); + } elseif ( isset( $meta['sizes'][ $size ] ) ) { + if ( ! isset( $base_url ) ) + $base_url = str_replace( wp_basename( $attachment_url ), '', $attachment_url ); + + // Nothing from the filter, so consult image metadata if we have it. + $size_meta = $meta['sizes'][ $size ]; + + // 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', + ); + } + } + + $sizes['full'] = array( + 'height' => $meta['height'], + 'width' => $meta['width'], + 'url' => $attachment_url, + 'orientation' => $meta['height'] > $meta['width'] ? 'portrait' : 'landscape', + ); + + $response = array_merge( $response, array( 'sizes' => $sizes ), $sizes['full'] ); + } + + if ( function_exists('get_compat_media_markup') ) + $response['compat'] = get_compat_media_markup( $attachment->ID, array( 'in_modal' => true ) ); + + return apply_filters( 'wp_prepare_attachment_for_js', $response, $attachment, $meta ); +} + +/** + * 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; + + $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' => '', + ); + + $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 + ); + + $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 ), + 'captions' => ! apply_filters( 'disable_captions', '' ), + 'nonce' => array( + 'sendToEditor' => wp_create_nonce( 'media-send-to-editor' ), + ), + 'post' => array( + 'id' => 0, + ), + 'defaultProps' => $props, + ); + + $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 ), + ); + + if ( current_theme_supports( 'post-thumbnails', $post->post_type ) && post_type_supports( $post->post_type, 'thumbnail' ) ) { + $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' ), + /* 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' ), + 'returnToLibrary' => __( '← Return to library' ), + 'allMediaItems' => __( 'All media items' ), + 'noItemsFound' => __( 'No items found.' ), + 'insertIntoPost' => $hier ? __( 'Insert into page' ) : __( 'Insert into post' ), + '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." ), + + // 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' ), + ); + + $settings = apply_filters( 'media_view_settings', $settings, $post ); + $strings = apply_filters( 'media_view_strings', $strings, $post ); + + $strings['settings'] = $settings; + + wp_localize_script( 'media-views', '_wpMediaViewsL10n', $strings ); + + wp_enqueue_script( 'media-editor' ); + wp_enqueue_style( 'media-views' ); + 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' ); + + do_action( 'wp_enqueue_media' ); +}