Changeset 49223

Timestamp:

10/20/2020 03:12:07 AM (4 years ago)

Author:

helen

Message:

Media: Indicate if item is or was used as a site option in the details modal.

Props Mista-Flo, melchoyce.
Fixes #42063.

Location:

trunk/src

Files:

• wp-admin/includes/template.php (modified) (2 diffs)
• wp-includes/media-template.php (modified) (2 diffs)
• wp-includes/media.php (modified) (1 diff)

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

@@ -2238 +2238 @@
  *
  * @since 3.2.0
+ * @since 5.6.0 Added the `$echo` parameter.
  *
  * @param WP_Post $post The attachment post to retrieve states for.
- */
-function _media_states( $post ) {
+ * @param bool    $echo Optional. Whether to echo the post states as an HTML string. Default true.
+ * @return string Media states string.
+ */
+function _media_states( $post, $echo = true ) {
+    $media_states = get_media_states( $post );
+    $media_states_string = '';
+
+    if ( ! empty( $media_states ) ) {
+        $state_count = count( $media_states );
+        $i           = 0;
+
+        $media_states_string .= ' — ';
+
+        foreach ( $media_states as $state ) {
+            $sep = ( ++$i === $state_count ) ? '' : ', ';
+
+            $media_states_string .= "<span class='post-state'>$state$sep</span>";
+        }
+    }
+
+    if ( $echo ) {
+        echo $media_states_string;
+    }
+
+    return $media_states_string;
+}
+
+/**
+ * Retrieves an array of media states from an attachment.
+ *
+ * @since 5.6.0
+ *
+ * @param WP_Post $post The attachment to retrieve states for.
+ * @return string[] Array of media state labels keyed by their state.
+ */
+function get_media_states( $post ) {
     static $header_images;
 
@@ -2311 +2346 @@
      * @param WP_Post  $post         The current attachment object.
      */
-    $media_states = apply_filters( 'display_media_states', $media_states, $post );
-
-    if ( ! empty( $media_states ) ) {
-        $state_count = count( $media_states );
-        $i           = 0;
-
-        echo ' &mdash; ';
-
-        foreach ( $media_states as $state ) {
-            $sep = ( ++$i === $state_count ) ? '' : ', ';
-
-            echo "<span class='post-state'>$state$sep</span>";
-        }
-    }
+     return apply_filters( 'display_media_states', $media_states, $post );
 }
 

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

@@ -460 +460 @@
                 <# } #>
 
+                <# if ( data.mediaStates ) { #>
+                    <div class="media-states"><strong><?php _e( 'Used as:' ); ?></strong> {{ data.mediaStates }}</div>
+                <# } #>
+
                 <div class="compat-meta">
                     <# if ( data.compat && data.compat.meta ) { #>
@@ -672 +676 @@
                         <span class="screen-reader-text">{{ data.fileLengthHumanReadable }}</span>
                     </div>
+                <# } #>
+
+                <# if ( data.mediaStates ) { #>
+                    <div class="media-states"><strong><?php _e( 'Used as:' ); ?></strong> {{ data.mediaStates }}</div>
                 <# } #>
 

trunk/src/wp-includes/media.php

@@ -3977 +3977 @@
     }
 
+    $media_states = get_media_states( $attachment );
+    if ( ! empty( $media_states ) ) {
+        $response['mediaStates'] = implode( ', ', $media_states );
+    }
+
     /**
      * Filters the attachment data prepared for JavaScript.