Changeset 6411

Timestamp:

01/22/2018 06:32:54 PM (9 years ago)

Author:

obenland

Message:

Plugins: Move example readme file to plugin.

Gives the file a version history and makes it available from the Plugin Directory root.
It also removes the need to update the URL every time a new version gets uploaded.

Props xkon.
Fixes #3123.

Location:

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

Files:

• plugins/plugin-directory/class-plugin-directory.php (modified) (2 diffs)
• plugins/plugin-directory/readme/readme.txt (added)
• themes/pub/wporg-plugins/page-developers.php (modified) (1 diff)

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

@@ -1133 +1133 @@
                         }
 
-                        // Browse 404's
+                        // Browse 404s.
                         if ( 'browse' === $path[2] ) {
                                 wp_safe_redirect( home_url( '/' ) );
+                                die();
+                        }
+
+                        // The readme.txt page.
+                        if ( 'readme.txt' === $path[2] ) {
+                                header( 'Content-type: text/plain' );
+                                echo file_get_contents( __DIR__ . '/readme/readme.txt' );
                                 die();
                         }
@@ -1148 +1155 @@
                         }
 
-                        // Otherwise, let's redirect to the search page
+                        // Otherwise, let's redirect to the search page.
                         if ( isset( $path[2] ) && ! empty( $path[2] ) ) {
                                 wp_safe_redirect( home_url( '/search/' . urlencode( $path[2] ) . '/' ) );

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-plugins/page-developers.php

@@ -104 +104 @@
                                         <?php
                                         /* translators: 1: URL to readme file; 2: URL to readme validator; */
-                                        printf( wp_kses_post( __( 'To make your entry in the plugin browser most useful, each plugin should have a readme file named <code>readme.txt</code> that adheres to the <a href="%1$s">WordPress plugin readme file standard</a>. You can put your readme file through the <a href="%2$s">readme validator</a> to check it.', 'wporg-plugins' ) ), esc_url( home_url( 'files/2018/01/readme.txt' ) ), esc_url( home_url( '/developers/readme-validator/' ) ) );
+                                        printf( wp_kses_post( __( 'To make your entry in the plugin browser most useful, each plugin should have a readme file named <code>readme.txt</code> that adheres to the <a href="%1$s">WordPress plugin readme file standard</a>. You can put your readme file through the <a href="%2$s">readme validator</a> to check it.', 'wporg-plugins' ) ), esc_url( home_url( 'readme.txt' ) ), esc_url( home_url( '/developers/readme-validator/' ) ) );
                                         ?>
                                 </p>