Changeset 11311

Timestamp:

11/04/2021 03:25:50 AM (5 years ago)

Author:

dd32

Message:

Code Reference: Include a link to view the source on GitHub.

Props stuartshields, netweb, dd32.
Fixes #5942.

Location:

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer

Files:

• inc/template-tags.php (modified) (2 diffs)
• reference/template-source.php (modified) (1 diff)

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/template-tags.php

@@ -1159 +1159 @@
          *
          * @param null $post_id     Post ID.
-         * @param bool $line_number Whether to append the line number to the URL.
-         *                          Default true.
          * @return string Source file URL with or without line number.
          */
-        function get_source_file_link( $post_id = null, $line_number = true ) {
+        function get_source_file_link( $post_id = null ) {
 
                 $post_id = empty( $post_id ) ? get_the_ID() : $post_id;
@@ -1175 +1173 @@
                         if ( $line_number = get_post_meta( get_the_ID(), '_wp-parser_line_num', true ) ) {
                                 $url .= "#L{$line_number}";
+                        }
+                }
+
+                return esc_url( $url );
+        }
+
+        /**
+         * Retrieve the URL to the GitHub source file and line.
+         *
+         * @param null $post_id     Post ID.
+         * @return string Source file URL with or without line number.
+         */
+        function get_github_source_file_link( $post_id = null ) {
+
+                $post_id = empty( $post_id ) ? get_the_ID() : $post_id;
+                $url     = '';
+
+                // Source file.
+                $source_file = get_source_file( $post_id );
+                if ( ! empty( $source_file ) ) {
+                        $url = 'https://github.com/WordPress/wordpress-develop/blob/' . get_current_version() . '/src/' . $source_file;
+                        // Line number.
+                        if ( $line_number = get_post_meta( get_the_ID(), '_wp-parser_line_num', true ) ) {
+                                $url .= "#L{$line_number}";
+                                if ( $end_line_number = get_post_meta( get_the_ID(), '_wp-parser_end_line_num', true ) ) {
+                                        $url .= "-L{$end_line_number}";
+                                }
                         }
                 }

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/reference/template-source.php

@@ -31 +31 @@
                                 </span>
                                 <span><a href="<?php echo get_source_file_link(); ?>"><?php _e( 'View on Trac', 'wporg' ); ?></a></span>
+                                <span><a href="<?php echo get_github_source_file_link(); ?>"><?php _e( 'View on GitHub', 'wporg' ); ?></a></span>
                         </p>
                 <?php else : ?>