Changeset 27862

Timestamp:

03/30/2014 07:27:31 PM (11 years ago)

Author:

wonderboymusic

Message:

Metadata for audio and video files:

• Make attachment metadata for audio files editable by providing a metabox on the Edit Media page
• Standardize on using the attachment title everywhere
• Label the Caption and Description fields for audio and video appropriately
• Make the playlist Underscore templates more straightforward

See #27574.

Location:

trunk/src

Files:

• wp-admin/edit-form-advanced.php (modified) (1 diff)
• wp-admin/includes/media.php (modified) (3 diffs)
• wp-admin/includes/meta-boxes.php (modified) (1 diff)
• wp-admin/includes/post.php (modified) (1 diff)
• wp-includes/media.php (modified) (4 diffs)

trunk/src/wp-admin/edit-form-advanced.php

@@ -140 +140 @@
     add_meta_box( 'submitdiv', __('Save'), 'attachment_submit_meta_box', null, 'side', 'core' );
     add_action( 'edit_form_after_title', 'edit_form_image_editor' );
+
+    if ( preg_match( '#^audio#', $post->post_mime_type ) ) {
+        add_meta_box( 'attachment-id3', __( 'Metadata' ), 'attachment_id3_data_meta_box', null, 'normal', 'core' );
+    }
 } else {
     add_meta_box( 'submitdiv', __( 'Publish' ), 'post_submit_meta_box', null, 'side', 'core', $publish_callback_args );

trunk/src/wp-admin/includes/media.php

@@ -2662 +2662 @@
     <div class="wp_attachment_details edit-form-section">
         <p>
-            <label for="attachment_caption"><strong><?php _e( 'Caption' ); ?></strong></label><br />
+            <label for="attachment_caption"><strong><?php _e( 'Caption' ); ?></strong><?php
+            if ( preg_match( '#^audio|video#', $post->post_mime_type ) ): ?>: <?php
+                _e( "Custom label for item in a playlist. If empty, the file's available data is used." );
+            endif ?></label><br />
             <textarea class="widefat" name="excerpt" id="attachment_caption"><?php echo $post->post_excerpt; ?></textarea>
         </p>
+
 
     <?php if ( 'image' === substr( $post->post_mime_type, 0, 5 ) ) : ?>
@@ -2684 +2688 @@
     ?>
 
-    <label for="content"><strong><?php _e( 'Description' ); ?></strong></label>
+    <label for="content"><strong><?php _e( 'Description' ); ?></strong><?php
+    if ( preg_match( '#^audio|video#', $post->post_mime_type ) ): ?>: <?php
+        _e( 'Displayed on attachment pages.' );
+    endif ?></label>
     <?php wp_editor( $post->post_content, 'attachment_content', $editor_args ); ?>
 
@@ -2766 +2773 @@
         $fields = apply_filters( 'media_submitbox_misc_sections', array(
             'mime_type'        => __( 'Mime-type:' ),
-            'year'             => __( 'Year:' ),
-            'genre'            => __( 'Genre:' ),
             'length_formatted' => __( 'Length:' ),
         ) );

trunk/src/wp-admin/includes/meta-boxes.php

@@ -1058 +1058 @@
     echo _wp_post_thumbnail_html( $thumbnail_id, $post->ID );
 }
+
+/**
+ * Display fields for ID3 data
+ *
+ * @since 3.9.0
+ *
+ * @param WP_Post $post
+ */
+function attachment_id3_data_meta_box( $post ) {
+    $meta = array();
+    if ( ! empty( $post->ID ) ) {
+        $meta = wp_get_attachment_metadata( $post->ID );
+    }
+
+    foreach ( wp_get_relevant_id3_keys() as $key => $label ): ?>
+    <p>
+        <label for="title"><?php echo $label ?></label>
+        <input type="text" name="id3_<?php echo esc_attr( $key ) ?>" id="id3_<?php echo esc_attr( $key ) ?>" class="widefat" value="<?php
+            if ( ! empty( $meta[ $key ] ) ) {
+                echo esc_attr( $meta[ $key ] );
+            }
+        ?>" />
+    </p>
+    <?php endforeach;
+}

trunk/src/wp-admin/includes/post.php

@@ -236 +236 @@
                 update_post_meta( $post_ID, $keyed, wp_filter_post_kses( $post_data[ $keyed ] ) );
         }
+    }
+
+    if ( 'attachment' === $post_data['post_type'] && preg_match( '#^audio|video#', $post_data['post_mime_type'] ) ) {
+        $id3data = wp_get_attachment_metadata( $post_ID );
+        if ( ! is_array( $id3data ) ) {
+            $id3data = array();
+        }
+
+        foreach ( wp_get_relevant_id3_keys() as $key => $label ) {
+            if ( isset( $post_data[ 'id3_' . $key ] ) ) {
+                if ( current_user_can( 'unfiltered_html' ) ) {
+                    $id3data[ $key ] = wp_unslash( $post_data[ 'id3_' . $key ] );
+                } else {
+                    $id3data[ $key ] = wp_unslash( wp_kses_post( $post_data[ 'id3_' . $key ] ) );
+                }
+            }
+        }
+        wp_update_attachment_metadata( $post_ID, $id3data );
     }
 

trunk/src/wp-includes/media.php

@@ -1019 +1019 @@
     <img src="{{{ data.thumb.src }}}"/>
     <# } #>
-    <# if ( data.meta.title ) { #>
     <div class="wp-playlist-caption">
-        <span class="wp-caption-meta wp-caption-title">&#8220;{{{ data.meta.title }}}&#8221;</span>
-        <span class="wp-caption-meta wp-caption-album">{{{ data.meta.album }}}</span>
-        <span class="wp-caption-meta wp-caption-artist">{{{ data.meta.artist }}}</span>
+        <span class="wp-caption-meta wp-caption-title">&#8220;{{{ data.title }}}&#8221;</span>
+        <# if ( data.meta.album ) { #><span class="wp-caption-meta wp-caption-album">{{{ data.meta.album }}}</span><# } #>
+        <# if ( data.meta.artist ) { #><span class="wp-caption-meta wp-caption-artist">{{{ data.meta.artist }}}</span><# } #>
     </div>
-    <# } else { #>
-    <div class="wp-playlist-caption">{{{ data.caption ? data.caption : data.title }}}</div>
-    <# } #>
 </script>
 <script type="text/html" id="tmpl-wp-playlist-item">
     <div class="wp-playlist-item">
-        <# if ( ( data.title || data.meta.title ) && ( ! data.artists || data.meta.artist ) ) { #>
         <div class="wp-playlist-caption">
             {{{ data.index ? ( data.index + '.&nbsp;' ) : '' }}}
-            <span class="wp-caption-title">&#8220;{{{ data.title ? data.title : data.meta.title }}}&#8221;</span>
-            <# if ( data.artists ) { #>
-            <span class="wp-caption-by"><?php _e( 'by' ) ?></span>
-            <span class="wp-caption-artist">{{{ data.meta.artist }}}</span>
+            <# if ( data.caption ) { #>
+                {{{ data.caption }}}
+            <# } else { #>
+                <span class="wp-caption-title">&#8220;{{{ data.title }}}&#8221;</span>
+                <# if ( data.artists && data.meta.artist ) { #>
+                <span class="wp-caption-by"><?php _e( 'by' ) ?></span>
+                <span class="wp-caption-artist">{{{ data.meta.artist }}}</span>
+                <# } #>
             <# } #>
         </div>
-        <# } else { #>
-        <div class="wp-playlist-caption">{{{ data.index ? ( data.index + '.' ) : '' }}} {{{ data.caption ? data.caption : data.title }}}</div>
-        <# } #>
         <# if ( data.meta.length_formatted ) { #>
         <div class="wp-playlist-item-length">{{{ data.meta.length_formatted }}}</div>
@@ -1208 +1204 @@
         if ( ! empty( $meta ) ) {
 
-            $keys = array( 'title', 'artist', 'band', 'album', 'genre', 'year', 'length', 'length_formatted' );
-            foreach ( $keys as $key ) {
+            foreach ( wp_get_relevant_id3_keys() as $key => $label ) {
                 if ( ! empty( $meta[ $key ] ) ) {
                     $track['meta'][ $key ] = $meta[ $key ];
@@ -1318 +1313 @@
 }
 
+/**
+ * Return useful keys to use to lookup data from an attachment's stored metadata
+ *
+ * @since 3.9.0
+ *
+ * @return array
+ */
+function wp_get_relevant_id3_keys() {
+    $fields = array(
+        'artist' => __( 'Artist' ),
+        'album' => __( 'Album' ),
+        'genre' => __( 'Genre' ),
+        'year' => __( 'Year' ),
+        'length_formatted' => __( 'Formatted Length' )
+    );
+    /**
+     * Filter the editable list of keys to lookup data from an attachment's metadata
+     *
+     * @since 3.9.0
+     *
+     * @param array $fields
+     */
+    return apply_filters( 'wp_get_relevant_id3_keys', $fields );
+}
 /**
  * The Audio shortcode.
@@ -2313 +2332 @@
 
         $response['meta'] = array();
-        $keys = array( 'title', 'artist', 'band', 'album', 'genre', 'year', 'length', 'length_formatted' );
-        foreach ( $keys as $key ) {
+        foreach ( wp_get_relevant_id3_keys() as $key => $label ) {
             if ( ! empty( $meta[ $key ] ) ) {
                 $response['meta'][ $key ] = $meta[ $key ];