Context Navigation

Changeset 781

Timestamp:

08/12/2014 06:26:08 AM (10 years ago)

Author:

coffee2code

Message:

Code Reference: streamline UI for archive/search listings

Add content-reference-archive.php template and use it for archive and search listings
Add wporg_filter_archive_excerpt() and use it to prefix post type label to excerpts in archive listings
Add wporg_filter_archive_title() and use it to append '()' to titles for function-like post types in archive listings
Add get_line_number() to get either start or end line number
Display simplified archive listing (no full method signature, no parts highlighting)
Add post type label, source file relative path, and start line number to archive listed items

fixes #450
props nicolealleyinteractivecom

Location:

Files:

-                      r591
+                      r781
                 <?php while ( have_posts() ) : the_post(); ?>
+                    <?php
+                        /* Include the Post-Format-specific template for the content.
+                         * If you want to override this in a child theme, then include a file
+                         * called content-___.php (where ___ is the Post Format name) and that will be used instead.
+                         */
+                        get_template_part( 'content', 'reference' );
+                    ?>
+                    <?php get_template_part( 'content', 'reference-archive' ); ?>
                 <?php endwhile; ?>

r554	r781
10	10	?>
11	11
12		<div id="page" ~~class="hfeed site devhub-wrap"~~>
	12	<div id="page" <?php body_class( 'hfeed site devhub-wrap' ); ?>>
13	13	<?php do_action( 'before' ); ?>
14	14	<header id="masthead" class="site-header" role="banner">

-                      r554
+                      r781
+}
 add_filter( 'wp_title', 'wporg_developer_wp_title', 10, 2 );
+/**
+ * Prefixes excerpts for archive view with content type label.
+ *
+ * @param  string $excerpt The excerpt.
+ * @return string
+ */
+function wporg_filter_archive_excerpt( $excerpt ) {
+    if ( ! is_single() ) {
+        $excerpt = '<b>' . get_post_type_labels( get_post_type_object( get_post_type( get_the_ID() ) ) )->singular_name . ': </b>' . $excerpt;
+    }
+    return $excerpt;
+}
+add_filter( 'get_the_excerpt', 'wporg_filter_archive_excerpt' );
+/**
+ * Appends parentheses to titles in archive view for functions and methods.
+ *
+ * @param  string $title The title.
+ * @return string
+ */
+function wporg_filter_archive_title( $title ) {
+    if ( ! is_single() && in_array( get_post_type(), array( 'wp-parser-function', 'wp-parser-method' ) ) ) {
+        $title .= '()';
+    }
+    return $title;
+}
+add_filter( 'the_title', 'wporg_filter_archive_title' );

-                      r773
+                      r781
     /**
+     * Retrieve either the starting or ending line number.
+     *
+     * @param  int    $post_id Optional. The post ID.
+     * @param  string $type    Optional. Either 'start' for starting line number, or 'end' for ending line number.
+     *
+     * @return int
+     */
+    function get_line_number( $post_id = null, $type = 'start' ) {
+        $post_id  = empty( $post_id ) ? get_the_ID() : $post_id;
+        $meta_key = ( 'end' == $type ) ? '_wp-parser_end_line_num' : '_wp-parser_line_num';
+        return (int) get_post_meta( $post_id, $meta_key, true );
+    }
+    /**
      * Retrieve the URL to the actual source file and line.
+     *

-                      r780
+                      r781
+    }
+    &.archive, &.search {
+        .wp-parser-class, .wp-parser-function, .wp-parser-hook, .wp-parser-method {
+            h1 {
+                a {
+                    font-family: $body-font;
+                    color: #21759b;
+                    font-weight: normal;
+                }
+            }
+            div {
+                &.sourcefile {
+                    color: #999999;
+                    font-style: italic;
+                }
+            }
+        }
+    }
     .single {
         .wp-parser-class, .wp-parser-function, .wp-parser-hook, .wp-parser-method {

r742	r781
24	24	<?php while ( have_posts() ) : the_post(); ?>
25	25
26		<?php get_template_part( 'content', 'reference' ); ?>
	26	<?php get_template_part( 'content', 'reference-archive' ); ?>
27	27
28	28	<?php endwhile; ?>

-                      r780
+                      r781
   padding: 20px;
+}
+.devhub-wrap.archive .wp-parser-class h1 a, .devhub-wrap.archive .wp-parser-function h1 a, .devhub-wrap.archive .wp-parser-hook h1 a, .devhub-wrap.archive .wp-parser-method h1 a, .devhub-wrap.search .wp-parser-class h1 a, .devhub-wrap.search .wp-parser-function h1 a, .devhub-wrap.search .wp-parser-hook h1 a, .devhub-wrap.search .wp-parser-method h1 a {
+  font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
+  color: #21759b;
+  font-weight: normal;
+}
+.devhub-wrap.archive .wp-parser-class div.sourcefile, .devhub-wrap.archive .wp-parser-function div.sourcefile, .devhub-wrap.archive .wp-parser-hook div.sourcefile, .devhub-wrap.archive .wp-parser-method div.sourcefile, .devhub-wrap.search .wp-parser-class div.sourcefile, .devhub-wrap.search .wp-parser-function div.sourcefile, .devhub-wrap.search .wp-parser-hook div.sourcefile, .devhub-wrap.search .wp-parser-method div.sourcefile {
+  color: #999999;
+  font-style: italic;
+}
 .devhub-wrap .single .wp-parser-class, .devhub-wrap .single .wp-parser-function, .devhub-wrap .single .wp-parser-hook, .devhub-wrap .single .wp-parser-method {
   border-bottom-style: none;

Note: See TracChangeset for help on using the changeset viewer.