Changeset 4559

Timestamp:

12/19/2016 07:00:06 AM (8 years ago)

Author:

dd32

Message:

Plugin Directory: Allow us to return the FAQ section with <h4> instead of <dl> for existing WordPress versions.
Also fixes the hot_tags endpoint to work correctly.

See #2112.

Location:

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

Files:

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

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

@@ -112 +112 @@
         }
         $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['description'] = $result['sections']['description'];
 
@@ -271 +276 @@
     }
 
+    /**
+     * Return a 'simplified' markup for the FAQ screen.
+     * WordPress only supports a whitelisted selection of tags, `<dl>` is not one of them.
+     *
+     * @see https://core.trac.wordpress.org/browser/tags/4.7/src/wp-admin/includes/plugin-install.php#L478
+     * @param string $markup The existing Markup.
+     * @return string Them markup with `<dt>` replaced with `<h4>` and `<dd>` with `<p>`.
+     */
+    protected function get_simplified_faq_markup( $markup ) {
+        $markup = str_replace(
+            array( '<dl>', '</dl>', '<dt>', '</dt>', '<dd>', '</dd>' ),
+            array( '',      '',     '<h4>', '</h4>', '<p>',  '</p>'  ),
+            $markup
+        );
+
+        return $markup;
+    }
+
 }
 

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

@@ -25 +25 @@
      */
     function popular_tags( $request ) {
-        $terms = get_terms( 'plugin_tags', array( 'hide_empty' => false, 'orderby' => 'count', 'order' => 'DESC' ) );
+        $terms = get_terms( 'plugin_tags', array(
+            'hide_empty' => true,
+            'orderby' => 'count',
+            'order' => 'DESC',
+            'number' => 1000
+        ) );
 
         $response = array();

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

@@ -47 +47 @@
         'sections'          => true,
         'tags'              => true,
-        'tested'            => true,        
+        'tested'            => true,
+        'enhanced_faq'      => false,
     );
 
@@ -65 +66 @@
         'short_description' => true,
         'tags'              => true,
-        'tested'            => 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'] );
             }
         }
@@ -180 +186 @@
      */
     public function popular_tags( $request ) {
-        if ( false === ( $response = false&& wp_cache_get( $cache_key = $this->popular_tags_cache_key( $request ), self::CACHE_GROUP ) ) ) {
-            $response = $this->internal_rest_api_call( 'plugins/v1/popular-categories', array( 'locale' => $request->locale ) );
+        if ( false === ( $response = wp_cache_get( $cache_key = $this->popular_tags_cache_key( $request ), self::CACHE_GROUP ) ) ) {
+            $response = $this->internal_rest_api_call( 'plugins/v1/popular-tags', array( 'locale' => $request->locale ) );
 
             if ( 200 != $response->status ) {
@@ -191 +197 @@
         }
 
-        if ( $request->number && count( $response ) > $request->number ) {
-            $response = array_slice( $response, 0, $request->number, true );
+        $number_items_requested = 100;
+        if ( !empty( $request->number ) ) {
+            $number_items_requested = $request->number;
+        }
+
+        if ( count( $response ) > $number_items_requested ) {
+            $response = array_slice( $response, 0, $number_items_requested, true );
         }
 
         $this->output( (object) $response );
     }
-    /**
-     * Generates a cache key for a 'hot_categories' API request.
+
+    /**
+     * Generates a cache key for a 'hot_tags' API request.
      */
     protected function popular_tags_cache_key( $request ) {
-        return 'hot_categories:' . $request->locale;
+        return 'hot_tags:' . $request->locale;;
     }