WordPress 4.4
[autoinstalls/wordpress.git] / wp-admin / includes / media.php
index fc8ce0fe97a654d81f8495a92a68a4d6c845e989..9990b9fd1b7325608772c70487ac42ed6165bc21 100644 (file)
@@ -36,7 +36,7 @@ function media_upload_tabs() {
  *
  * @since 2.5.0
  *
  *
  * @since 2.5.0
  *
- * @global wpdb $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param array $tabs
  * @return array $tabs with gallery if post has image attachment
  *
  * @param array $tabs
  * @return array $tabs with gallery if post has image attachment
@@ -65,7 +65,7 @@ function update_gallery_tab($tabs) {
 }
 
 /**
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Outputs the legacy media upload tabs UI.
  *
  * @since 2.5.0
  *
  *
  * @since 2.5.0
  *
@@ -102,25 +102,30 @@ function the_media_upload_tabs() {
 }
 
 /**
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Retrieves the image HTML to send to the editor.
  *
  * @since 2.5.0
  *
  *
  * @since 2.5.0
  *
- * @param integer $id image attachment id
- * @param string $caption image caption
- * @param string $alt image alt attribute
- * @param string $title image title attribute
- * @param string $align image css alignment property
- * @param string $url image src url
- * @param string|bool $rel image rel attribute
- * @param string $size image size (thumbnail, medium, large, full or added  with add_image_size() )
- * @return string the html to insert into editor
+ * @param int          $id      Image attachment id.
+ * @param string       $caption Image caption.
+ * @param string       $title   Image title attribute.
+ * @param string       $align   Image CSS alignment property.
+ * @param string       $url     Optional. Image src URL. Default empty.
+ * @param string       $rel     Optional. Image rel attribute. Default empty.
+ * @param string|array $size    Optional. Image size. Accepts any valid image size, or an array of width
+ *                              and height values in pixels (in that order). Default 'medium'.
+ * @param string       $alt     Optional. Image alt attribute. Default empty.
+ * @return string The HTML output to insert into the editor.
  */
  */
-function get_image_send_to_editor($id, $caption, $title, $align, $url='', $rel = false, $size='medium', $alt = '') {
+function get_image_send_to_editor( $id, $caption, $title, $align, $url = '', $rel = '', $size = 'medium', $alt = '' ) {
 
        $html = get_image_tag($id, $alt, '', $align, $size);
 
 
        $html = get_image_tag($id, $alt, '', $align, $size);
 
-       $rel = $rel ? ' rel="attachment wp-att-' . esc_attr($id).'"' : '';
+       if ( ! $rel ) {
+               $rel = ' rel="attachment wp-att-' . esc_attr( $id ) . '"';
+       } else {
+               $rel = ' rel="' . esc_attr( $rel ) . '"';
+       }
 
        if ( $url )
                $html = '<a href="' . esc_attr($url) . "\"$rel>$html</a>";
 
        if ( $url )
                $html = '<a href="' . esc_attr($url) . "\"$rel>$html</a>";
@@ -130,14 +135,15 @@ function get_image_send_to_editor($id, $caption, $title, $align, $url='', $rel =
         *
         * @since 2.5.0
         *
         *
         * @since 2.5.0
         *
-        * @param string $html    The image HTML markup to send.
-        * @param int    $id      The attachment id.
-        * @param string $caption The image caption.
-        * @param string $title   The image title.
-        * @param string $align   The image alignment.
-        * @param string $url     The image source URL.
-        * @param string $size    The image size.
-        * @param string $alt     The image alternative, or alt, text.
+        * @param string       $html    The image HTML markup to send.
+        * @param int          $id      The attachment id.
+        * @param string       $caption The image caption.
+        * @param string       $title   The image title.
+        * @param string       $align   The image alignment.
+        * @param string       $url     The image source URL.
+        * @param string|array $size    Size of image. Image size or array of width and height values
+        *                              (in that order). Default 'medium'.
+        * @param string       $alt     The image alternative, or alt, text.
         */
        $html = apply_filters( 'image_send_to_editor', $html, $id, $caption, $title, $align, $url, $size, $alt );
 
         */
        $html = apply_filters( 'image_send_to_editor', $html, $id, $caption, $title, $align, $url, $size, $alt );
 
@@ -242,7 +248,7 @@ function media_send_to_editor($html) {
 ?>
 <script type="text/javascript">
 var win = window.dialogArguments || opener || parent || top;
 ?>
 <script type="text/javascript">
 var win = window.dialogArguments || opener || parent || top;
-win.send_to_editor('<?php echo addslashes($html); ?>');
+win.send_to_editor( <?php echo wp_json_encode( $html ); ?> );
 </script>
 <?php
        exit;
 </script>
 <?php
        exit;
@@ -613,7 +619,7 @@ function get_upload_iframe_src( $type = null, $post_id = null, $tab = null ) {
 }
 
 /**
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Handles form submissions for the legacy media uploader.
  *
  * @since 2.5.0
  *
  *
  * @since 2.5.0
  *
@@ -656,8 +662,8 @@ function media_upload_form_handler() {
                 *
                 * @see wp_get_attachment_metadata()
                 *
                 *
                 * @see wp_get_attachment_metadata()
                 *
-                * @param WP_Post $post       The WP_Post object.
-                * @param array   $attachment An array of attachment metadata.
+                * @param array $post       An array of post data.
+                * @param array $attachment An array of attachment metadata.
                 */
                $post = apply_filters( 'attachment_fields_to_save', $post, $attachment );
 
                 */
                $post = apply_filters( 'attachment_fields_to_save', $post, $attachment );
 
@@ -724,7 +730,7 @@ function media_upload_form_handler() {
 }
 
 /**
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Handles the process of uploading media.
  *
  * @since 2.5.0
  *
  *
  * @since 2.5.0
  *
@@ -805,7 +811,9 @@ function wp_media_upload_handler() {
 
        if ( isset( $_POST['save'] ) ) {
                $errors['upload_notice'] = __('Saved.');
 
        if ( isset( $_POST['save'] ) ) {
                $errors['upload_notice'] = __('Saved.');
-               return media_upload_gallery();
+               wp_enqueue_script( 'admin-gallery' );
+               return wp_iframe( 'media_upload_gallery_form', $errors );
+
        } elseif ( ! empty( $_POST ) ) {
                $return = media_upload_form_handler();
 
        } elseif ( ! empty( $_POST ) ) {
                $return = media_upload_form_handler();
 
@@ -842,6 +850,10 @@ function media_sideload_image( $file, $post_id, $desc = null, $return = 'html' )
 
                // Set variables for storage, fix file filename for query strings.
                preg_match( '/[^\?]+\.(jpe?g|jpe|gif|png)\b/i', $file, $matches );
 
                // Set variables for storage, fix file filename for query strings.
                preg_match( '/[^\?]+\.(jpe?g|jpe|gif|png)\b/i', $file, $matches );
+               if ( ! $matches ) {
+                       return new WP_Error( 'image_sideload_failed', __( 'Invalid image URL' ) );
+               }
+
                $file_array = array();
                $file_array['name'] = basename( $matches[0] );
 
                $file_array = array();
                $file_array['name'] = basename( $matches[0] );
 
@@ -880,7 +892,7 @@ function media_sideload_image( $file, $post_id, $desc = null, $return = 'html' )
 }
 
 /**
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Retrieves the legacy media uploader form in an iframe.
  *
  * @since 2.5.0
  *
  *
  * @since 2.5.0
  *
@@ -903,7 +915,7 @@ function media_upload_gallery() {
 }
 
 /**
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Retrieves the legacy media library form in an iframe.
  *
  * @since 2.5.0
  *
  *
  * @since 2.5.0
  *
@@ -1072,7 +1084,7 @@ function wp_caption_input_textarea($edit_post) {
 }
 
 /**
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Retrieves the image attachment fields to edit form fields.
  *
  * @since 2.5.0
  *
  *
  * @since 2.5.0
  *
@@ -1085,7 +1097,7 @@ function image_attachment_fields_to_edit($form_fields, $post) {
 }
 
 /**
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Retrieves the single non-image attachment fields to edit form fields.
  *
  * @since 2.5.0
  *
  *
  * @since 2.5.0
  *
@@ -1099,7 +1111,7 @@ function media_single_attachment_fields_to_edit( $form_fields, $post ) {
 }
 
 /**
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Retrieves the post non-image attachment fields to edito form fields.
  *
  * @since 2.8.0
  *
  *
  * @since 2.8.0
  *
@@ -1138,7 +1150,7 @@ function image_attachment_fields_to_save( $post, $attachment ) {
 }
 
 /**
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Retrieves the media element HTML to send to the editor.
  *
  * @since 2.5.0
  *
  *
  * @since 2.5.0
  *
@@ -1163,7 +1175,7 @@ function image_media_send_to_editor($html, $attachment_id, $attachment) {
 }
 
 /**
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Retrieves the attachment fields to edit form fields.
  *
  * @since 2.5.0
  *
  *
  * @since 2.5.0
  *
@@ -1239,7 +1251,7 @@ function get_attachment_fields_to_edit($post, $errors = null) {
        }
 
        // Merge default fields with their errors, so any key passed with the error (e.g. 'error', 'helps', 'value') will replace the default
        }
 
        // Merge default fields with their errors, so any key passed with the error (e.g. 'error', 'helps', 'value') will replace the default
-       // The recursive merge is easily traversed with array casting: foreach( (array) $things as $thing )
+       // The recursive merge is easily traversed with array casting: foreach ( (array) $things as $thing )
        $form_fields = array_merge_recursive($form_fields, (array) $errors);
 
        // This was formerly in image_attachment_fields_to_edit().
        $form_fields = array_merge_recursive($form_fields, (array) $errors);
 
        // This was formerly in image_attachment_fields_to_edit().
@@ -1366,7 +1378,8 @@ function get_media_item( $attachment_id, $args = null ) {
        $toggle_on  = __( 'Show' );
        $toggle_off = __( 'Hide' );
 
        $toggle_on  = __( 'Show' );
        $toggle_off = __( 'Hide' );
 
-       $filename = esc_html( wp_basename( $post->guid ) );
+       $file = get_attached_file( $post->ID );
+       $filename = esc_html( wp_basename( $file ) );
        $title = esc_attr( $post->post_title );
 
        $post_mime_types = get_post_mime_types();
        $title = esc_attr( $post->post_title );
 
        $post_mime_types = get_post_mime_types();
@@ -1471,7 +1484,9 @@ function get_media_item( $attachment_id, $args = null ) {
                        $delete = "<a href='" . wp_nonce_url( "post.php?action=delete&amp;post=$attachment_id", 'delete-post_' . $attachment_id ) . "' id='del[$attachment_id]' class='delete-permanently'>" . __( 'Delete Permanently' ) . '</a>';
                } elseif ( !MEDIA_TRASH ) {
                        $delete = "<a href='#' class='del-link' onclick=\"document.getElementById('del_attachment_$attachment_id').style.display='block';return false;\">" . __( 'Delete' ) . "</a>
                        $delete = "<a href='" . wp_nonce_url( "post.php?action=delete&amp;post=$attachment_id", 'delete-post_' . $attachment_id ) . "' id='del[$attachment_id]' class='delete-permanently'>" . __( 'Delete Permanently' ) . '</a>';
                } elseif ( !MEDIA_TRASH ) {
                        $delete = "<a href='#' class='del-link' onclick=\"document.getElementById('del_attachment_$attachment_id').style.display='block';return false;\">" . __( 'Delete' ) . "</a>
-                        <div id='del_attachment_$attachment_id' class='del-attachment' style='display:none;'><p>" . sprintf( __( 'You are about to delete <strong>%s</strong>.' ), $filename ) . "</p>
+                        <div id='del_attachment_$attachment_id' class='del-attachment' style='display:none;'>" .
+                        /* translators: %s: file name */
+                       '<p>' . sprintf( __( 'You are about to delete %s.' ), '<strong>' . $filename . '</strong>' ) . "</p>
                         <a href='" . wp_nonce_url( "post.php?action=delete&amp;post=$attachment_id", 'delete-post_' . $attachment_id ) . "' id='del[$attachment_id]' class='button'>" . __( 'Continue' ) . "</a>
                         <a href='#' class='button' onclick=\"this.parentNode.style.display='none';return false;\">" . __( 'Cancel' ) . "</a>
                         </div>";
                         <a href='" . wp_nonce_url( "post.php?action=delete&amp;post=$attachment_id", 'delete-post_' . $attachment_id ) . "' id='del[$attachment_id]' class='button'>" . __( 'Continue' ) . "</a>
                         <a href='#' class='button' onclick=\"this.parentNode.style.display='none';return false;\">" . __( 'Cancel' ) . "</a>
                         </div>";
@@ -1627,7 +1642,7 @@ function get_compat_media_markup( $attachment_id, $args = null ) {
        }
 
        // Merge default fields with their errors, so any key passed with the error (e.g. 'error', 'helps', 'value') will replace the default
        }
 
        // Merge default fields with their errors, so any key passed with the error (e.g. 'error', 'helps', 'value') will replace the default
-       // The recursive merge is easily traversed with array casting: foreach( (array) $things as $thing )
+       // The recursive merge is easily traversed with array casting: foreach ( (array) $things as $thing )
        $form_fields = array_merge_recursive($form_fields, (array) $args['errors'] );
 
        /** This filter is documented in wp-admin/includes/media.php */
        $form_fields = array_merge_recursive($form_fields, (array) $args['errors'] );
 
        /** This filter is documented in wp-admin/includes/media.php */
@@ -1734,7 +1749,7 @@ function get_compat_media_markup( $attachment_id, $args = null ) {
 }
 
 /**
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Outputs the legacy media upload header.
  *
  * @since 2.5.0
  */
  *
  * @since 2.5.0
  */
@@ -1750,7 +1765,7 @@ function media_upload_header() {
 }
 
 /**
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Outputs the legacy media upload form.
  *
  * @since 2.5.0
  *
  *
  * @since 2.5.0
  *
@@ -1914,7 +1929,7 @@ do_action( 'post-plupload-upload-ui' ); ?>
        <p id="async-upload-wrap">
                <label class="screen-reader-text" for="async-upload"><?php _e('Upload'); ?></label>
                <input type="file" name="async-upload" id="async-upload" />
        <p id="async-upload-wrap">
                <label class="screen-reader-text" for="async-upload"><?php _e('Upload'); ?></label>
                <input type="file" name="async-upload" id="async-upload" />
-               <?php submit_button( __( 'Upload' ), 'button', 'html-upload', false ); ?>
+               <?php submit_button( __( 'Upload' ), 'primary', 'html-upload', false ); ?>
                <a href="#" onclick="try{top.tb_remove();}catch(e){}; return false;"><?php _e('Cancel'); ?></a>
        </p>
        <div class="clear"></div>
                <a href="#" onclick="try{top.tb_remove();}catch(e){}; return false;"><?php _e('Cancel'); ?></a>
        </p>
        <div class="clear"></div>
@@ -1942,7 +1957,7 @@ do_action( 'post-html-upload-ui' );
 }
 
 /**
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Outputs the legacy media upload form for a given media type.
  *
  * @since 2.5.0
  *
  *
  * @since 2.5.0
  *
@@ -2012,7 +2027,7 @@ if ( $id ) {
 }
 
 /**
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Outputs the legacy media upload form for external media.
  *
  * @since 2.7.0
  *
  *
  * @since 2.7.0
  *
@@ -2303,7 +2318,7 @@ jQuery(function($){
 }
 
 /**
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Outputs the legacy media upload form for the media library.
  *
  * @since 2.5.0
  *
  *
  * @since 2.5.0
  *
@@ -2763,7 +2778,7 @@ function edit_form_image_editor( $post ) {
                );
        ?>
 
                );
        ?>
 
-       <label for="content"><strong><?php _e( 'Description' ); ?></strong><?php
+       <label for="attachment_content"><strong><?php _e( 'Description' ); ?></strong><?php
        if ( preg_match( '#^(audio|video)/#', $post->post_mime_type ) ) {
                echo ': ' . __( 'Displayed on attachment pages.' );
        } ?></label>
        if ( preg_match( '#^(audio|video)/#', $post->post_mime_type ) ) {
                echo ': ' . __( 'Displayed on attachment pages.' );
        } ?></label>
@@ -2784,7 +2799,8 @@ function edit_form_image_editor( $post ) {
 function attachment_submitbox_metadata() {
        $post = get_post();
 
 function attachment_submitbox_metadata() {
        $post = get_post();
 
-       $filename = esc_html( wp_basename( $post->guid ) );
+       $file = get_attached_file( $post->ID );
+       $filename = esc_html( wp_basename( $file ) );
 
        $media_dims = '';
        $meta = wp_get_attachment_metadata( $post->ID );
 
        $media_dims = '';
        $meta = wp_get_attachment_metadata( $post->ID );
@@ -2796,8 +2812,8 @@ function attachment_submitbox_metadata() {
        $att_url = wp_get_attachment_url( $post->ID );
 ?>
        <div class="misc-pub-section misc-pub-attachment">
        $att_url = wp_get_attachment_url( $post->ID );
 ?>
        <div class="misc-pub-section misc-pub-attachment">
-                       <label for="attachment_url"><?php _e( 'File URL:' ); ?></label>
-                       <input type="text" class="widefat urlfield" readonly="readonly" name="attachment_url" value="<?php echo esc_attr($att_url); ?>" />
+               <label for="attachment_url"><?php _e( 'File URL:' ); ?></label>
+               <input type="text" class="widefat urlfield" readonly="readonly" name="attachment_url" id="attachment_url" value="<?php echo esc_attr( $att_url ); ?>" />
        </div>
        <div class="misc-pub-section misc-pub-filename">
                <?php _e( 'File name:' ); ?> <strong><?php echo $filename; ?></strong>
        </div>
        <div class="misc-pub-section misc-pub-filename">
                <?php _e( 'File name:' ); ?> <strong><?php echo $filename; ?></strong>
@@ -2819,7 +2835,6 @@ function attachment_submitbox_metadata() {
        </div>
 
        <?php
        </div>
 
        <?php
-               $file  = get_attached_file( $post->ID );
                $file_size = false;
 
                if ( isset( $meta['filesize'] ) )
                $file_size = false;
 
                if ( isset( $meta['filesize'] ) )
@@ -2963,13 +2978,19 @@ function wp_add_id3_tag_data( &$metadata, $data ) {
  * @return array|bool Returns array of metadata, if found.
  */
 function wp_read_video_metadata( $file ) {
  * @return array|bool Returns array of metadata, if found.
  */
 function wp_read_video_metadata( $file ) {
-       if ( ! file_exists( $file ) )
+       if ( ! file_exists( $file ) ) {
                return false;
                return false;
+       }
 
        $metadata = array();
 
 
        $metadata = array();
 
-       if ( ! class_exists( 'getID3' ) )
+       if ( ! defined( 'GETID3_TEMP_DIR' ) ) {
+               define( 'GETID3_TEMP_DIR', get_temp_dir() );
+       }
+
+       if ( ! class_exists( 'getID3', false ) ) {
                require( ABSPATH . WPINC . '/ID3/getid3.php' );
                require( ABSPATH . WPINC . '/ID3/getid3.php' );
+       }
        $id3 = new getID3();
        $data = $id3->analyze( $file );
 
        $id3 = new getID3();
        $data = $id3->analyze( $file );
 
@@ -3019,12 +3040,18 @@ function wp_read_video_metadata( $file ) {
  * @return array|bool Returns array of metadata, if found.
  */
 function wp_read_audio_metadata( $file ) {
  * @return array|bool Returns array of metadata, if found.
  */
 function wp_read_audio_metadata( $file ) {
-       if ( ! file_exists( $file ) )
+       if ( ! file_exists( $file ) ) {
                return false;
                return false;
+       }
        $metadata = array();
 
        $metadata = array();
 
-       if ( ! class_exists( 'getID3' ) )
+       if ( ! defined( 'GETID3_TEMP_DIR' ) ) {
+               define( 'GETID3_TEMP_DIR', get_temp_dir() );
+       }
+
+       if ( ! class_exists( 'getID3', false ) ) {
                require( ABSPATH . WPINC . '/ID3/getid3.php' );
                require( ABSPATH . WPINC . '/ID3/getid3.php' );
+       }
        $id3 = new getID3();
        $data = $id3->analyze( $file );
 
        $id3 = new getID3();
        $data = $id3->analyze( $file );