Changeset 5253

Timestamp:

04/05/2017 06:30:53 AM (9 years ago)

Author:

dd32

Message:

Plugin Directory: Prefix Installation Instructions as a FAQ entry when they exist in the readme.

See #2645

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-parser.php (modified) (2 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-parser.php

@@ -341 +341 @@
                         $this->faq = $this->parse_section( $this->sections['faq'] );
                         $this->sections['faq'] = '';
+                }
+
+                // Prefix Installation Instructions as a FAQ entry
+                if ( $this->has_unique_installation_instructions() ) {
+                        $this->faq = array_merge(
+                                array(
+                                        __( 'Installation Instructions', 'wporg-plugins' ) => $this->sections['installation']
+                                ),
+                                $this->faq
+                        );
+                        unset( $this->sections['installation'] );
+                        $this->sections['faq'] = ''; // Ensure it's set as per faq section above.
                 }
 
@@ -632 +644 @@
                 return $markdown->transform( $text );
         }
+
+        /**
+         * Determine if the readme contains unique installation instructions.
+         *
+         * When phrases are added here, the affected plugins will need to be reparsed to pick it up.
+         *
+         * @return bool Whether the instructions differ from default instructions.
+         */
+        protected function has_unique_installation_instructions() {
+                if ( ! isset( $this->sections['installation'] ) ) {
+                        return false;
+                }
+
+                // If the plugin installation section contains any of these phrases, skip it as it's not useful.
+                $common_phrases = array(
+                        'This section describes how to install the plugin and get it working.', // Default readme.txt content
+                );
+                foreach ( $common_phrases as $phrase ) {
+                        if ( false !== stripos( $this->sections['installation'], $phrase ) ) {
+                                return false;
+                        }
+                }
+
+                return true;
+        }
 }