Changeset 10607

Timestamp:

02/20/2009 08:00:09 PM (16 years ago)

Author:

ryan

Message:

Add documentation lookup shortcuts to Theme and Plugin Editors. Props beaulebens. fixes #9184

Location:

trunk/wp-admin

Files:

• css/theme-editor.css (modified) (1 diff)
• includes/misc.php (modified) (1 diff)
• plugin-editor.php (modified) (3 diffs)
• theme-editor.php (modified) (2 diffs)

trunk/wp-admin/css/theme-editor.css

@@ -65 +65 @@
     margin-right: 210px;
 }
+
+#documentation {
+    margin-top: 10px;
+}
+#documentation label {
+    line-height: 22px;
+    vertical-align: top;
+    font-weight: bold;
+}

trunk/wp-admin/includes/misc.php

@@ -239 +239 @@
 }
 
+function wp_doc_link_parse( $content ) {
+    if ( !is_string( $content ) || empty( $content ) )
+        return array();
+        
+    $tokens = token_get_all( $content );
+    $functions = array();
+    $ignore_functions = array();
+    for ( $t = 0, $count = count( $tokens ); $t < $count; $t++ ) {
+        if ( !is_array( $tokens[$t] ) ) continue;
+        if ( T_STRING == $tokens[$t][0] && ( '(' == $tokens[ $t + 1 ] || '(' == $tokens[ $t + 2 ] ) ) {
+            // If it's a function or class defined locally, there's not going to be any docs available
+            if ( 'class' == $tokens[ $t - 2 ][1] || 'function' == $tokens[ $t - 2 ][1] || T_OBJECT_OPERATOR == $tokens[ $t - 1 ][0] ) {
+                $ignore_functions[] = $tokens[$t][1];
+            }
+            // Add this to our stack of unique references
+            $functions[] = $tokens[$t][1];
+        }
+    }
+    
+    $functions = array_unique( $functions );
+    sort( $functions );
+    $ignore_functions = apply_filters( 'documentation_ignore_functions', $ignore_functions );
+    $ignore_functions = array_unique( $ignore_functions );
+    
+    $out = array();
+    foreach ( $functions as $function ) {
+        if ( in_array( $function, $ignore_functions ) )
+            continue;
+        $out[] = $function;
+    }
+    
+    return $out;
+}
+
 ?>

trunk/wp-admin/plugin-editor.php

@@ -82 +82 @@
         $error = 1;
 
-    if ( ! $error )
-        $content = htmlspecialchars(file_get_contents($real_file));
+    if ( ! $error ) {
+        $content = file_get_contents( $real_file );
+        
+        if ( 'php' == mb_substr( $real_file, mb_strrpos( $real_file, '.' ) + 1 ) ) {
+            $functions = wp_doc_link_parse( $content );
+            
+            $docs_select = '<select name="docs-list" id="docs-list">';
+            $docs_select .= '<option value="">' . __( 'Function Name...' ) . '</option>';
+            foreach ( $functions as $function) {
+                $docs_select .= '<option value="' . urlencode( $function ) . '">' . htmlspecialchars( $function ) . '()</option>';
+            }
+            $docs_select .= '</select>';
+        }
+        
+        $content = htmlspecialchars( $content );
+    }
 
     ?>
@@ -125 +139 @@
     <ul>
 <?php foreach($plugin_files as $plugin_file) : ?>
-        <li><a href="plugin-editor.php?file=<?php echo $plugin_file; ?>"><?php echo $plugins[$plugin_file]['Name']; ?></a></li>
+        <li<?php echo $file == $plugin_file ? ' class="highlight"' : ''; ?>><a href="plugin-editor.php?file=<?php echo $plugin_file; ?>"><?php echo $plugins[$plugin_file]['Name']; ?></a></li>
 <?php endforeach; ?>
     </ul>
@@ -136 +150 @@
         <input type="hidden" name="file" value="<?php echo $file ?>" />
         </div>
+        <?php if ( count( $functions ) ) : ?>
+        <div id="documentation"><label for="docs-list">Documentation:</label> <?php echo $docs_select ?> <input type="button" class="button" value=" <?php _e( 'Lookup' ) ?> " onclick="if ( '' != jQuery('#docs-list').val() ) { window.open( 'http://api.wordpress.org/core/handbook/1.0/?function=' + escape( jQuery( '#docs-list' ).val() ) + '&locale=<?php echo urlencode( get_locale() ) ?>&version=<?php echo urlencode( $wp_version ) ?>&redirect=true'); }" /></div>
+        <?php endif; ?>
 <?php if ( is_writeable($real_file) ) : ?>
     <?php if ( in_array($file, (array) get_option('active_plugins')) ) { ?>

trunk/wp-admin/theme-editor.php

@@ -88 +88 @@
         $f = fopen($real_file, 'r');
         $content = fread($f, filesize($real_file));
-        $content = htmlspecialchars($content);
+
+        if ( 'php' == mb_substr( $real_file, mb_strrpos( $real_file, '.' ) + 1 ) ) {
+            $functions = wp_doc_link_parse( $content );
+            
+            $docs_select = '<select name="docs-list" id="docs-list">';
+            $docs_select .= '<option value="">' . __( 'Function Name...' ) . '</option>';
+            foreach ( $functions as $function) {                    
+                $docs_select .= '<option value="' . urlencode( $function ) . '">' . htmlspecialchars( $function ) . '()</option>';
+            }
+            $docs_select .= '</select>';
+        }
+
+        $content = htmlspecialchars( $content );
     }
 
@@ -188 +200 @@
          <input type="hidden" name="theme" value="<?php echo $theme ?>" />
          </div>
+        <?php if ( count( $functions ) ) : ?>
+        <div id="documentation"><label for="docs-list">Documentation:</label> <?php echo $docs_select ?> <input type="button" class="button" value=" <?php _e( 'Lookup' ) ?> " onclick="if ( '' != jQuery('#docs-list').val() ) { window.open( 'http://api.wordpress.org/core/handbook/1.0/?function=' + escape( jQuery( '#docs-list' ).val() ) + '&locale=<?php echo urlencode( get_locale() ) ?>&version=<?php echo urlencode( $wp_version ) ?>&redirect=true'); }" /></div>
+        <?php endif; ?>
 
         <div>