wp-admin/plugin-editor.php

   1 <?php
   2 /**
   3  * Edit plugin editor administration panel.
   4  *
   5  * @package WordPress
   6  * @subpackage Administration
   7  */
   8
   9 /** WordPress Administration Bootstrap */
  10 require_once('./admin.php');
  11
  12 if ( is_multisite() && ! is_network_admin() ) {
  13         wp_redirect( network_admin_url( 'plugin-editor.php' ) );
  14         exit();
  15 }
  16
  17 if ( !current_user_can('edit_plugins') )
  18         wp_die( __('You do not have sufficient permissions to edit plugins for this site.') );
  19
  20 $title = __("Edit Plugins");
  21 $parent_file = 'plugins.php';
  22
  23 wp_reset_vars(array('action', 'redirect', 'profile', 'error', 'warning', 'a', 'file', 'plugin'));
  24
  25 $plugins = get_plugins();
  26
  27 if ( empty($plugins) )
  28         wp_die( __('There are no plugins installed on this site.') );
  29
  30 if ( isset($_REQUEST['file']) )
  31         $plugin = stripslashes($_REQUEST['file']);
  32
  33 if ( empty($plugin) ) {
  34         $plugin = array_keys($plugins);
  35         $plugin = $plugin[0];
  36 }
  37
  38 $plugin_files = get_plugin_files($plugin);
  39
  40 if ( empty($file) )
  41         $file = $plugin_files[0];
  42 else
  43         $file = stripslashes($file);
  44
  45 $file = validate_file_to_edit($file, $plugin_files);
  46 $real_file = WP_PLUGIN_DIR . '/' . $file;
  47 $scrollto = isset($_REQUEST['scrollto']) ? (int) $_REQUEST['scrollto'] : 0;
  48
  49 switch ( $action ) {
  50
  51 case 'update':
  52
  53         check_admin_referer('edit-plugin_' . $file);
  54
  55         $newcontent = stripslashes($_POST['newcontent']);
  56         if ( is_writeable($real_file) ) {
  57                 $f = fopen($real_file, 'w+');
  58                 fwrite($f, $newcontent);
  59                 fclose($f);
  60
  61                 $network_wide = is_plugin_active_for_network( $file );
  62
  63                 // Deactivate so we can test it.
  64                 if ( is_plugin_active($file) || isset($_POST['phperror']) ) {
  65                         if ( is_plugin_active($file) )
  66                                 deactivate_plugins($file, true);
  67
  68                         if ( ! is_network_admin() )
  69                                 update_option( 'recently_activated', array( $file => time() ) + (array) get_option( 'recently_activated' ) );
  70
  71                         wp_redirect(add_query_arg('_wpnonce', wp_create_nonce('edit-plugin-test_' . $file), "plugin-editor.php?file=$file&liveupdate=1&scrollto=$scrollto&networkwide=" . $network_wide));
  72                         exit;
  73                 }
  74                 wp_redirect( self_admin_url("plugin-editor.php?file=$file&a=te&scrollto=$scrollto") );
  75         } else {
  76                 wp_redirect( self_admin_url("plugin-editor.php?file=$file&scrollto=$scrollto") );
  77         }
  78         exit;
  79
  80 break;
  81
  82 default:
  83
  84         if ( isset($_GET['liveupdate']) ) {
  85                 check_admin_referer('edit-plugin-test_' . $file);
  86
  87                 $error = validate_plugin($file);
  88                 if ( is_wp_error($error) )
  89                         wp_die( $error );
  90
  91                 if ( ( ! empty( $_GET['networkwide'] ) && ! is_plugin_active_for_network($file) ) || ! is_plugin_active($file) )
  92                         activate_plugin($file, "plugin-editor.php?file=$file&phperror=1", ! empty( $_GET['networkwide'] ) ); // we'll override this later if the plugin can be included without fatal error
  93
  94                 wp_redirect( self_admin_url("plugin-editor.php?file=$file&a=te&scrollto=$scrollto") );
  95                 exit;
  96         }
  97
  98         // List of allowable extensions
  99         $editable_extensions = array('php', 'txt', 'text', 'js', 'css', 'html', 'htm', 'xml', 'inc', 'include');
 100         $editable_extensions = (array) apply_filters('editable_extensions', $editable_extensions);
 101
 102         if ( ! is_file($real_file) ) {
 103                 wp_die(sprintf('<p>%s</p>', __('No such file exists! Double check the name and try again.')));
 104         } else {
 105                 // Get the extension of the file
 106                 if ( preg_match('/\.([^.]+)$/', $real_file, $matches) ) {
 107                         $ext = strtolower($matches[1]);
 108                         // If extension is not in the acceptable list, skip it
 109                         if ( !in_array( $ext, $editable_extensions) )
 110                                 wp_die(sprintf('<p>%s</p>', __('Files of this type are not editable.')));
 111                 }
 112         }
 113
 114         get_current_screen()->add_help_tab( array(
 115         'id'            => 'overview',
 116         'title'         => __('Overview'),
 117         'content'       =>
 118                 '<p>' . __('You can use the editor to make changes to any of your plugins&#8217; individual PHP files. Be aware that if you make changes, plugins updates will overwrite your customizations.') . '</p>' .
 119                 '<p>' . __('Choose a plugin to edit from the menu in the upper right and click the Select button. Click once on any file name to load it in the editor, and make your changes. Don&#8217;t forget to save your changes (Update File) when you&#8217;re finished.') . '</p>' .
 120                 '<p>' . __('The Documentation menu below the editor lists the PHP functions recognized in the plugin file. Clicking Lookup takes you to a web page about that particular function.') . '</p>' .
 121                 '<p id="newcontent-description">' . __('In the editing area the Tab key enters a tab character. To move below this area by pressing Tab, press the Esc key followed by the Tab key.') . '</p>' .
 122                 '<p>' . __('If you want to make changes but don&#8217;t want them to be overwritten when the plugin is updated, you may be ready to think about writing your own plugin. For information on how to edit plugins, write your own from scratch, or just better understand their anatomy, check out the links below.') . '</p>' .
 123                 ( is_network_admin() ? '<p>' . __('Any edits to files from this screen will be reflected on all sites in the network.') . '</p>' : '' )
 124         ) );
 125
 126         get_current_screen()->set_help_sidebar(
 127                 '<p><strong>' . __('For more information:') . '</strong></p>' .
 128                 '<p>' . __('<a href="http://codex.wordpress.org/Plugins_Editor_Screen" target="_blank">Documentation on Editing Plugins</a>') . '</p>' .
 129                 '<p>' . __('<a href="http://codex.wordpress.org/Writing_a_Plugin" target="_blank">Documentation on Writing Plugins</a>') . '</p>' .
 130                 '<p>' . __('<a href="http://wordpress.org/support/" target="_blank">Support Forums</a>') . '</p>'
 131         );
 132
 133         require_once(ABSPATH . 'wp-admin/admin-header.php');
 134
 135         update_recently_edited(WP_PLUGIN_DIR . '/' . $file);
 136
 137         $content = file_get_contents( $real_file );
 138
 139         if ( '.php' == substr( $real_file, strrpos( $real_file, '.' ) ) ) {
 140                 $functions = wp_doc_link_parse( $content );
 141
 142                 if ( !empty($functions) ) {
 143                         $docs_select = '<select name="docs-list" id="docs-list">';
 144                         $docs_select .= '<option value="">' . __( 'Function Name&hellip;' ) . '</option>';
 145                         foreach ( $functions as $function) {
 146                                 $docs_select .= '<option value="' . esc_attr( $function ) . '">' . esc_html( $function ) . '()</option>';
 147                         }
 148                         $docs_select .= '</select>';
 149                 }
 150         }
 151
 152         $content = esc_textarea( $content );
 153         ?>
 154 <?php if (isset($_GET['a'])) : ?>
 155  <div id="message" class="updated"><p><?php _e('File edited successfully.') ?></p></div>
 156 <?php elseif (isset($_GET['phperror'])) : ?>
 157  <div id="message" class="updated"><p><?php _e('This plugin has been deactivated because your changes resulted in a <strong>fatal error</strong>.') ?></p>
 158         <?php
 159                 if ( wp_verify_nonce($_GET['_error_nonce'], 'plugin-activation-error_' . $file) ) { ?>
 160         <iframe style="border:0" width="100%" height="70px" src="<?php bloginfo('wpurl'); ?>/wp-admin/plugins.php?action=error_scrape&amp;plugin=<?php echo esc_attr($file); ?>&amp;_wpnonce=<?php echo esc_attr($_GET['_error_nonce']); ?>"></iframe>
 161         <?php } ?>
 162 </div>
 163 <?php endif; ?>
 164 <div class="wrap">
 165 <?php screen_icon(); ?>
 166 <h2><?php echo esc_html( $title ); ?></h2>
 167
 168 <div class="fileedit-sub">
 169 <div class="alignleft">
 170 <big><?php
 171         if ( is_plugin_active($plugin) ) {
 172                 if ( is_writeable($real_file) )
 173                         echo sprintf(__('Editing <strong>%s</strong> (active)'), $file);
 174                 else
 175                         echo sprintf(__('Browsing <strong>%s</strong> (active)'), $file);
 176         } else {
 177                 if ( is_writeable($real_file) )
 178                         echo sprintf(__('Editing <strong>%s</strong> (inactive)'), $file);
 179                 else
 180                         echo sprintf(__('Browsing <strong>%s</strong> (inactive)'), $file);
 181         }
 182         ?></big>
 183 </div>
 184 <div class="alignright">
 185         <form action="plugin-editor.php" method="post">
 186                 <strong><label for="plugin"><?php _e('Select plugin to edit:'); ?> </label></strong>
 187                 <select name="plugin" id="plugin">
 188 <?php
 189         foreach ( $plugins as $plugin_key => $a_plugin ) {
 190                 $plugin_name = $a_plugin['Name'];
 191                 if ( $plugin_key == $plugin )
 192                         $selected = " selected='selected'";
 193                 else
 194                         $selected = '';
 195                 $plugin_name = esc_attr($plugin_name);
 196                 $plugin_key = esc_attr($plugin_key);
 197                 echo "\n\t<option value=\"$plugin_key\" $selected>$plugin_name</option>";
 198         }
 199 ?>
 200                 </select>
 201                 <?php submit_button( __( 'Select' ), 'button', 'Submit', false ); ?>
 202         </form>
 203 </div>
 204 <br class="clear" />
 205 </div>
 206
 207 <div id="templateside">
 208         <h3><?php _e('Plugin Files'); ?></h3>
 209
 210         <ul>
 211 <?php
 212 foreach ( $plugin_files as $plugin_file ) :
 213         // Get the extension of the file
 214         if ( preg_match('/\.([^.]+)$/', $plugin_file, $matches) ) {
 215                 $ext = strtolower($matches[1]);
 216                 // If extension is not in the acceptable list, skip it
 217                 if ( !in_array( $ext, $editable_extensions ) )
 218                         continue;
 219         } else {
 220                 // No extension found
 221                 continue;
 222         }
 223 ?>
 224                 <li<?php echo $file == $plugin_file ? ' class="highlight"' : ''; ?>><a href="plugin-editor.php?file=<?php echo urlencode( $plugin_file ) ?>&amp;plugin=<?php echo urlencode( $plugin ) ?>"><?php echo $plugin_file ?></a></li>
 225 <?php endforeach; ?>
 226         </ul>
 227 </div>
 228 <form name="template" id="template" action="plugin-editor.php" method="post">
 229         <?php wp_nonce_field('edit-plugin_' . $file) ?>
 230                 <div><textarea cols="70" rows="25" name="newcontent" id="newcontent" aria-describedby="newcontent-description"><?php echo $content; ?></textarea>
 231                 <input type="hidden" name="action" value="update" />
 232                 <input type="hidden" name="file" value="<?php echo esc_attr($file) ?>" />
 233                 <input type="hidden" name="plugin" value="<?php echo esc_attr($plugin) ?>" />
 234                 <input type="hidden" name="scrollto" id="scrollto" value="<?php echo $scrollto; ?>" />
 235                 </div>
 236                 <?php if ( !empty( $docs_select ) ) : ?>
 237                 <div id="documentation" class="hide-if-no-js"><label for="docs-list"><?php _e('Documentation:') ?></label> <?php echo $docs_select ?> <input type="button" class="button" value="<?php esc_attr_e( 'Lookup' ) ?> " onclick="if ( '' != jQuery('#docs-list').val() ) { window.open( 'http://api.wordpress.org/core/handbook/1.0/?function=' + escape( jQuery( '#docs-list' ).val() ) + '&amp;locale=<?php echo urlencode( get_locale() ) ?>&amp;version=<?php echo urlencode( $wp_version ) ?>&amp;redirect=true'); }" /></div>
 238                 <?php endif; ?>
 239 <?php if ( is_writeable($real_file) ) : ?>
 240         <?php if ( in_array( $file, (array) get_option( 'active_plugins', array() ) ) ) { ?>
 241                 <p><?php _e('<strong>Warning:</strong> Making changes to active plugins is not recommended. If your changes cause a fatal error, the plugin will be automatically deactivated.'); ?></p>
 242         <?php } ?>
 243         <p class="submit">
 244         <?php
 245                 if ( isset($_GET['phperror']) ) {
 246                         echo "<input type='hidden' name='phperror' value='1' />";
 247                         submit_button( __( 'Update File and Attempt to Reactivate' ), 'primary', 'submit', false );
 248                 } else {
 249                         submit_button( __( 'Update File' ), 'primary', 'submit', false );
 250                 }
 251         ?>
 252         </p>
 253 <?php else : ?>
 254         <p><em><?php _e('You need to make this file writable before you can save your changes. See <a href="http://codex.wordpress.org/Changing_File_Permissions">the Codex</a> for more information.'); ?></em></p>
 255 <?php endif; ?>
 256 </form>
 257 <br class="clear" />
 258 </div>
 259 <script type="text/javascript">
 260 jQuery(document).ready(function($){
 261         $('#template').submit(function(){ $('#scrollto').val( $('#newcontent').scrollTop() ); });
 262         $('#newcontent').scrollTop( $('#scrollto').val() );
 263 });
 264 </script>
 265 <?php
 266         break;
 267 }
 268 include(ABSPATH . "wp-admin/admin-footer.php");