Changeset 1700552

Timestamp:

07/21/2017 06:24:20 PM (9 years ago)

Author:

Melissa Cabral

Message:

version 3.0 complete

Location:

theme-inspector/trunk

Files:

• readme.txt (modified) (4 diffs)
• theme-inspector.css (modified) (6 diffs)
• theme-inspector.php (modified) (9 diffs)

theme-inspector/trunk/readme.txt

@@ -3 +3 @@
 Donate link: http://wordpress.melissacabral.com/donate
 Tags: template, theme, utility, developer, Inspector, tool, wordpress
-Requires at least: 3.0.1
-Tested up to: 4.6.1
-Stable tag: 2.2.3
-License: GPLv3 or later
-License URI: http://www.gnu.org/licenses/gpl-3.0.html
+Requires at least: 4.0
+Tested up to: 4.8.0
+Stable tag: 3.0.1
+License: GPLv2 or later
+License URI: http://www.gnu.org/licenses/gpl-2.0.html
 
 A developer's inspector to illuminate the WordPress Template Hierarchy and help with building WordPress themes.
@@ -15 +15 @@
 A simple, lightweight plugin that displays useful technical information on pages and posts to aid in developing Wordpress themes. Provides quick access to things that are sometimes hidden, like post/page ID, slug, taxonomy terms, and post type slug. Theme Inspector tells you exactly what conditional tags are true on each view, and what template file loaded on each page view. 
 
-* Use In Conjunction with the [WP Template Hierarchy Document](https://docs.google.com/drawings/d/1hJ0MpHO3HKBT5KsTpGtc_gDYZ5pi-HyxNcRtmPBBULE).
+* Use In Conjunction with the [WP Template Hierarchy Document](https://docs.google.com/drawings/d/1hJ0MpHO3HKBT5KsTpGtc_gDYZ5pi-HyxNcRtmPBBULE/edit).
 * Theme Inspector is only visible to logged in Administrators.
 * Appears on the right-side of the Toolbar (admin bar). 
@@ -41 +41 @@
 == Changelog ==
 
+= 3.0 =
+* Added the complete template hierarchy chain for the currently displayed page
+* minor CSS improvements
+
 = 2.0 =
 * Moved the display to the admin bar (toolbar) for consistency
@@ -53 +57 @@
 == Upgrade Notice ==
 
+= 3.0 = 
+Upgrade because this version will save you the step of opening and reading the entire Hiearchy diagram
+
 = 2.0 =
 Upgrade because this version is way better than the last one and addresses a handful of minor bugs. 
+
+

theme-inspector/trunk/theme-inspector.css

@@ -9 +9 @@
     background-color: rgba(41,200,235,.2);
  }
- #wpadminbar #theme-helper-toolbar{
+ #theme-helper-toolbar{
     display:none;
     font-family:"Trebuchet MS"!important;
-    background:#fff;
+    background:#fff !important;
+    color:black !important;
     font-size:16px;
     position:absolute;
@@ -24 +25 @@
     box-shadow: 0 4px 4px rgba(0,0,0,0.2);
  }
- #wpadminbar .theme-helper:hover #theme-helper-toolbar,
- #wpadminbar .theme-helper:focus #theme-helper-toolbar{
+ .theme-helper:hover #theme-helper-toolbar,
+ .theme-helper:focus #theme-helper-toolbar{
     display:block;
  }
- #wpadminbar #theme-helper-toolbar table{
+ #theme-helper-toolbar table{
     width: 100%;
     border-collapse: collapse;
  }
- #wpadminbar #theme-helper-toolbar th{
+ #theme-helper-toolbar th{
     font-weight: bold;
     background-color:rgba(0,0,0,.06);
@@ -41 +42 @@
     text-shadow:none;
  }
- #wpadminbar #theme-helper-toolbar .file-loaded{
+ #theme-helper-toolbar .file-loaded{
     background-color: #FCFFD2;
  }
- #wpadminbar #theme-helper-toolbar td{
+ #theme-helper-toolbar td{
     color:black;
     padding:.5em;
@@ -50 +51 @@
     text-shadow:none;
  }
- #wpadminbar #theme-helper-toolbar .condition{
+ #theme-helper-toolbar .condition{
     color:#999;
     text-shadow:none;
+        font-family: monospace !important;
  }
- #wpadminbar #theme-helper-toolbar .first{
+ #theme-helper-toolbar .first{
     font-weight: bold;
     color:#000;
  }
- #wpadminbar #theme-helper-toolbar .credits td{
+ #theme-helper-toolbar .credits td{
     text-align: center;
     font: normal 11px/13px sans-serif;
@@ -64 +66 @@
     line-height:normal;
     background-color:#EDF5FA;
+
  }
- #wpadminbar #theme-helper-toolbar .credits a{
+ #theme-helper-toolbar .credits a{
     display:inline;
     font-size:inherit;
@@ -76 +79 @@
     line-height:14px;
  } 
- #wpadminbar #theme-helper-toolbar .usewith td{
-border-top:none;
-}
-
+ #theme-helper-toolbar .usewith td{
+    border-top:none;
+    border-bottom:solid 1px #ddd;
+ }
+ #theme-helper-toolbar .hierarchy {
+    font-family: monospace !important;
+    color:#999 !important;
+ }
+ #theme-helper-toolbar .template{
+    font-family: inherit;
+    color:black;
+    background-color:rgba(0,0,0,.04);
+    padding:.15em .4em;
+    white-space:nowrap;
+    border:solid 1px rgba(0,0,0,.1);
+ }
+ #theme-helper-toolbar .current-template{
+    background-color: #FCFFD2;
+    font-weight: bold;
+ }
 /*Theme Helper CSS end*/

theme-inspector/trunk/theme-inspector.php

@@ -5 +5 @@
 Description:  displays useful technical information on pages and posts to aid in developing Wordpress themes. Only visible to administrators.  Use In Conjunction with the WP Template Hierarchy Document
 Author: Melissa Cabral
-Version: 2.2.3
+Version: 3.0.1
 Author URI: http://melissacabral.com/
 */
@@ -14 +14 @@
 add_action( 'admin_bar_menu', 'mmc_toolbar_link', 999 );
 function mmc_toolbar_link( $wp_admin_bar ) {    
-    if (current_user_can('install_themes')) {
+    if (current_user_can('install_themes') && !is_admin()) {
         $html = mmc_generate_output();
         $args = array(
@@ -40 +40 @@
         ?>
         <!-- WordPress Theme Inspector by Melissa Cabral-->
-            <div id="theme-helper-toolbar">
+        <div id="theme-helper-toolbar">
             <table>
                 <?php if(is_admin()){ ?>
@@ -61 +61 @@
                     <td><?php echo adminhelper_true_conditions()?></td>
                 </tr>
+                
                 <?php if( !is_404() && ! is_search() &&  get_post_type() ) { ?>
                 <tr>
@@ -72 +73 @@
                     <th>Taxonomy:</th>
                     <td><?php 
-                    echo adminhelper_taxonomy()?>
+                        echo adminhelper_taxonomy()?>
                     </td>
                 </tr>
@@ -87 +88 @@
                 </tr>       
                 <?php 
-                }   ?>
-                <tr class="file-loaded">
-                    <th>File Loaded:</th>
-                    <td><?php echo adminhelper_get_current_template() ?></td>
-                </tr>
-                <?php } //end not admin ?>
-                <tr class="credits">
-                    <td colspan="2">Theme Inspector by <a href="https://wordpress.org/plugins/theme-inspector">Melissa Cabral</a>.</td>
-                </tr>
-                <tr class="credits usewith">
-                    <td colspan="2">Use with <a target="_blank" href="https://docs.google.com/drawings/d/1hJ0MpHO3HKBT5KsTpGtc_gDYZ5pi-HyxNcRtmPBBULE">Hierarchy Diagram</a></td>
-                </tr>
-            </table>
-        </div><!-- End Theme Inspector -->
+            }   ?>
+            <tr class="file-loaded">
+                <th>Template File Loaded:</th>
+                <td><?php echo adminhelper_get_current_template() ?></td>
+            </tr>
+            <tr>
+                <td colspan="2" class="hierarchy">
+                <i>Template Hierarchy for this screen:</i><br>
+                <?php echo adminhelper_hierarchy()?>
+                </td>
+            </tr>
+            <?php } //end not admin ?>
+            <tr class="credits">
+                <td colspan="2">Theme Inspector Plugin by <a href="https://wordpress.org/plugins/theme-inspector">Melissa Cabral</a>.</td>
+            </tr>
+            <tr class="credits usewith">
+                <td colspan="2">Use with the WordPress <a target="_blank" href="https://docs.google.com/drawings/d/1hJ0MpHO3HKBT5KsTpGtc_gDYZ5pi-HyxNcRtmPBBULE">Hierarchy Diagram</a></td>
+            </tr>
+        </table>
+    </div><!-- End Theme Inspector -->
     <?php   
     return ob_get_clean();          
@@ -163 +170 @@
     $count = 0;
     if (is_admin()) { $conditions[] = "is_admin()"; }
-    if (is_home()) { $conditions[] = "is_home()"; }
     if (is_front_page()) { $conditions[] = "is_front_page()"; } 
+    if (is_home()) { $conditions[] = "is_home()"; } 
     if (is_attachment() ){ $conditions[] = "is_attachment()"; }
     if (is_single()) { $conditions[] = "is_single()"; }
@@ -192 +199 @@
     return $output;
 }
+/**
+ * Display the current hierarchy chain for this page
+ * @return mixed HTML output
+ * @since  3.0 Added this functionality
+ */
+function adminhelper_hierarchy(){
+    global $post;
+    $output = '';
+    $hierarchy = array();
+
+    //current post info
+    $slug = $post->post_name;
+    $id = $post->ID;
+    $type = get_post_type();    
+
+    if( is_404() ){
+        $hierarchy[] = '404.php';
+    }elseif( is_search() ){
+        $hierarchy[] = 'search.php';
+    }elseif( is_front_page() ){ 
+        if( is_page() ){
+            $hierarchy = array('front-page.php', '<i>custom template</i>', "page-$slug.php",  "page-$id.php", 'page.php', 'singular.php') ;
+        }else{
+            $hierarchy = array('front-page.php', 'home.php') ;
+        }
+    }elseif( is_home() ){
+        $hierarchy[] = 'home.php';
+    }elseif( is_archive() ){
+        if( is_author() ){          
+            $author_id = $post->post_author;
+            $nicename = get_the_author_meta('nicename');
+            $hierarchy = array( "author-$nicename.php", "author-$author_id.php", 'author.php' );
+        }elseif( is_category() ){
+            $cat = get_category( get_query_var( 'cat' ) );
+            $cat_slug = $cat->slug;
+            $cat_id = $cat->cat_ID;
+            $hierarchy = array( "category-$cat_slug.php", "category-$cat_id.php", 'category.php' );
+        }elseif(is_tag()){
+            $tag = get_queried_object();
+            $tag_slug =  $tag->slug;        
+            $tag_id = $tag->term_id;
+            $hierarchy = array( "tag-$tag_slug.php", "tag-$tag_id.php", 'tag.php' );
+        }elseif(is_tax()){
+            $tax = get_queried_object();
+            $tax_name = $tax->taxonomy;
+            $term =  $tax->slug;    
+        
+            $hierarchy = array( "taxonomy-$tax_name-$term.php", "taxonomy-$tax_name.php", 'taxonomy.php' );
+        }elseif( is_post_type_archive()  ){         
+            $hierarchy = array( "archive-$type.php" );
+        }elseif( is_date() ){
+            $hierarchy = array( "date.php" );
+        }
+        $hierarchy[] = 'archive.php';
+    }elseif(is_singular()){
+        if(is_page()){          
+            $hierarchy = array( '<i>custom template</i>', "page-$slug.php",  "page-$id.php", 'page.php' );
+        }elseif(is_attachment()){
+            $mime = get_post_mime_type();
+            $type = explode( '/', $mime );
+            $hierarchy = array( "$type[0]-$type[1].php", "$type[1].php",  "$type[0].php", 'attachment', 'single.php' );
+        }elseif( is_singular('post') ){
+            $hierarchy = array('<i>custom template</i>', 'single-post.php', 'single.php');
+        }else{
+            //single custom post            
+            $hierarchy = array('<i>custom template</i>', "single-$type-$slug.php", "single-$type.php", 'single.php');
+        }
+        
+        $hierarchy[] = 'singular.php';
+    }
+    
+    //default template:
+    $hierarchy[] = 'index.php';
+
+    $sep = '';
+    foreach($hierarchy as $value){
+        $class = 'template';
+        if($GLOBALS['current_theme_template'] == $value){
+            $class .= ' current-template';
+        }
+        $output.=  $sep .  '<span class="' . $class . '">' . $value . '</span>';
+        $sep = ' &rarr; ';
+    }
+    
+    return $output;
+}
 function adminhelper_get_current_template(  ) {
     if( !isset( $GLOBALS['current_theme_template'] ) ){
@@ -213 +306 @@
 function adminhelper_enqueue_stylesheet(){
     if(is_user_logged_in() && is_admin_bar_showing()){
-    $src = plugins_url( 'theme-inspector.css', __FILE__ );
-    wp_register_style( 'themehelper-style', $src, '', '', 'screen' );
-    wp_enqueue_style( 'themehelper-style' );
-    }
-}
+        $src = plugins_url( 'theme-inspector.css', __FILE__ );
+        wp_register_style( 'themehelper-style', $src, '', '', 'screen' );
+        wp_enqueue_style( 'themehelper-style' );
+    }
+}