Changeset 10573

Timestamp:

01/13/2021 01:24:14 AM (4 years ago)

Author:

dd32

Message:

Plugin Directory: When generating FAQ anchors, don't include trailing whitespace as part of the ID.

This also updates the format of pre-defined ID's to match the format used today, as the ID's were previously being stripped out by kses, there's no real change here.

The Decode/Encode and trimming works around the various different anchor formats used.

Fixes #5572.

Location:

sites/trunk/wordpress.org/public_html/wp-content

Files:

• plugins/plugin-directory/readme/class-parser.php (modified) (2 diffs)
• themes/pub/wporg-plugins/js/section-faq.js (modified) (2 diffs)

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

@@ -428 +428 @@
                 $this->sections['faq'] .= "\n<dl>\n";
                 foreach ( $this->faq as $question => $answer ) {
-                    $question_slug          = sanitize_title_with_dashes( $question );
+                    $question_slug          = rawurlencode( trim( strtolower( $question ) ) );
                     $this->sections['faq'] .= "<dt id='{$question_slug}'><h3>{$question}</h3></dt>\n<dd>{$answer}</dd>\n";
                 }
@@ -524 +524 @@
             'ol'         => array(),
             'dl'         => array(),
-            'dt'         => array(),
+            'dt'         => array(
+                'id' => true,
+            ),
             'dd'         => array(),
             'li'         => array(),

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-plugins/js/section-faq.js

@@ -11 +11 @@
             // If there is no ID, create our own.
             if ( ! id ) {
-                id = '#' + encodeURIComponent( $question.text().toLowerCase() );
+                id = '#' + encodeURIComponent( $question.text().toLowerCase().trim() );
                 $question.attr( 'id', id );
             }
@@ -43 +43 @@
 
     if ( window.location.hash ) {
-        questions.find( '[formaction="' + window.location.hash + '"]' ).trigger( 'click' );
+        jQuery(
+            // Decode/Encode here is to work with any existing links that are not fully-encoded, the trim handles whitespace/newlines.
+            document.getElementById( encodeURIComponent( decodeURIComponent( window.location.hash.substr(1) ).trim() ) )
+        ).trigger( 'click' );
     }
 } )( jQuery );