Changeset 4560

Timestamp:

12/19/2016 07:17:41 AM (8 years ago)

Author:

dd32

Message:

Plugin Directory: Expose Screenshots in the sections section of the API response so WordPress can display them.

See #2112

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory

Files:

• api/routes/class-plugin.php (modified) (3 diffs)
• standalone/class-plugins-info-api-request.php (modified) (2 diffs)
• standalone/class-plugins-info-api.php (modified) (2 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/api/routes/class-plugin.php

@@ -111 +111 @@
             $result['sections'][ $_pages[ $i ] ] = apply_filters( 'the_content', $_pages[ $i + 1 ], $_pages[ $i ] );
         }
+        $result['sections']['screenshots'] = ''; // placeholder to put screenshots prior to reviews at the end.
         $result['sections']['reviews'] = $this->get_plugin_reviews_markup( $post->post_name );
+
         if ( !empty( $result['sections']['faq'] ) ) {
-            $result['sections']['enhanced_faq'] = $result['sections']['faq'];
-            $result['sections']['faq'] = $this->get_simplified_faq_markup( $result['sections']['enhanced_faq'] );
+            $result['sections']['faq'] = $this->get_simplified_faq_markup( $result['sections']['faq'] );
         } 
         
@@ -135 +136 @@
                 'caption' => array_key_exists( $image['resolution'], $descriptions ) ? $descriptions[ $image['resolution'] ] : ''
             );
+        }
+
+        if ( $result['screenshots'] ) {
+            $result['sections']['screenshots'] = $this->get_screenshot_markup( $result['screenshots'] );
+        } else {
+            unset( $result['sections']['screenshots'] );
         }
 
@@ -294 +301 @@
     }
 
+    protected function get_screenshot_markup( $screenshots ) {
+        $markup = '<ol>';
+
+        foreach ( $screenshots as $shot ) {
+            if ( $shot['caption'] ) {
+                $markup .= sprintf(
+                    '<li><a href="%1$s"><img src="%1$s" alt="%2$s"></a><p>%3$s</p></li>',
+                    esc_attr( $shot['src'] ),
+                    esc_attr( $shot['caption'] ),
+                    $shot['caption']
+                );
+            } else {
+                $markup .= sprintf(
+                    '<li><a href="%1$s"><img src="%1$s" alt=""></a></li>',
+                    esc_attr( $shot['src'] )
+                );
+            }
+        }
+
+        $markup .= '</ol>';
+        return $markup;
+    }
+
 }
 

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/standalone/class-plugins-info-api-request.php

@@ -48 +48 @@
         'tags'              => true,
         'tested'            => true,
-        'enhanced_faq'      => false,
     );
 
@@ -67 +66 @@
         'tags'              => true,
         'tested'            => true,
-        'enhanced_faq'      => false,
     );
 

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/standalone/class-plugins-info-api.php

@@ -112 +112 @@
             if ( 'reviews' === $field && ! $include ) {
                 unset( $response['sections']['reviews'] );
-            }
-            if ( 'enhanced_faq' === $field ) {
-                if ( $include ) {
-                     $response['sections']['faq'] = $response['sections']['enhanced_faq'];
-                }
-                unset( $response['sections']['enhanced_faq'] );
             }
         }
@@ -213 +207 @@
      */
     protected function popular_tags_cache_key( $request ) {
-        return 'hot_tags:' . $request->locale;;
+        return 'hot_tags:' . $request->locale;
     }