3 * Edit plugin editor administration panel.
6 * @subpackage Administration
9 /** WordPress Administration Bootstrap */
10 require_once( dirname( __FILE__ ) . '/admin.php' );
12 if ( is_multisite() && ! is_network_admin() ) {
13 wp_redirect( network_admin_url( 'plugin-editor.php' ) );
17 if ( !current_user_can('edit_plugins') )
18 wp_die( __('You do not have sufficient permissions to edit plugins for this site.') );
20 $title = __("Edit Plugins");
21 $parent_file = 'plugins.php';
23 wp_reset_vars( array( 'action', 'error', 'file', 'plugin' ) );
25 $plugins = get_plugins();
27 if ( empty( $plugins ) ) {
28 include( ABSPATH . 'wp-admin/admin-header.php' );
31 <h2><?php echo esc_html( $title ); ?></h2>
32 <div id="message" class="error"><p><?php _e( 'You do not appear to have any plugins available at this time.' ); ?></p></div>
35 include( ABSPATH . 'wp-admin/admin-footer.php' );
41 } elseif ( empty( $plugin ) ) {
42 $plugin = array_keys($plugins);
46 $plugin_files = get_plugin_files($plugin);
49 $file = $plugin_files[0];
51 $file = validate_file_to_edit($file, $plugin_files);
52 $real_file = WP_PLUGIN_DIR . '/' . $file;
53 $scrollto = isset($_REQUEST['scrollto']) ? (int) $_REQUEST['scrollto'] : 0;
59 check_admin_referer('edit-plugin_' . $file);
61 $newcontent = wp_unslash( $_POST['newcontent'] );
62 if ( is_writeable($real_file) ) {
63 $f = fopen($real_file, 'w+');
64 fwrite($f, $newcontent);
67 $network_wide = is_plugin_active_for_network( $file );
69 // Deactivate so we can test it.
70 if ( is_plugin_active($file) || isset($_POST['phperror']) ) {
71 if ( is_plugin_active($file) )
72 deactivate_plugins($file, true);
74 if ( ! is_network_admin() )
75 update_option( 'recently_activated', array( $file => time() ) + (array) get_option( 'recently_activated' ) );
77 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));
80 wp_redirect( self_admin_url("plugin-editor.php?file=$file&a=te&scrollto=$scrollto") );
82 wp_redirect( self_admin_url("plugin-editor.php?file=$file&scrollto=$scrollto") );
90 if ( isset($_GET['liveupdate']) ) {
91 check_admin_referer('edit-plugin-test_' . $file);
93 $error = validate_plugin($file);
94 if ( is_wp_error($error) )
97 if ( ( ! empty( $_GET['networkwide'] ) && ! is_plugin_active_for_network($file) ) || ! is_plugin_active($file) )
98 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
100 wp_redirect( self_admin_url("plugin-editor.php?file=$file&a=te&scrollto=$scrollto") );
104 // List of allowable extensions
105 $editable_extensions = array('php', 'txt', 'text', 'js', 'css', 'html', 'htm', 'xml', 'inc', 'include');
108 * Filter file type extensions editable in the plugin editor.
112 * @param array $editable_extensions An array of editable plugin file extensions.
114 $editable_extensions = (array) apply_filters( 'editable_extensions', $editable_extensions );
116 if ( ! is_file($real_file) ) {
117 wp_die(sprintf('<p>%s</p>', __('No such file exists! Double check the name and try again.')));
119 // Get the extension of the file
120 if ( preg_match('/\.([^.]+)$/', $real_file, $matches) ) {
121 $ext = strtolower($matches[1]);
122 // If extension is not in the acceptable list, skip it
123 if ( !in_array( $ext, $editable_extensions) )
124 wp_die(sprintf('<p>%s</p>', __('Files of this type are not editable.')));
128 get_current_screen()->add_help_tab( array(
130 'title' => __('Overview'),
132 '<p>' . __('You can use the editor to make changes to any of your plugins’ individual PHP files. Be aware that if you make changes, plugins updates will overwrite your customizations.') . '</p>' .
133 '<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’t forget to save your changes (Update File) when you’re finished.') . '</p>' .
134 '<p>' . __('The Documentation menu below the editor lists the PHP functions recognized in the plugin file. Clicking Look Up takes you to a web page about that particular function.') . '</p>' .
135 '<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>' .
136 '<p>' . __('If you want to make changes but don’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>' .
137 ( is_network_admin() ? '<p>' . __('Any edits to files from this screen will be reflected on all sites in the network.') . '</p>' : '' )
140 get_current_screen()->set_help_sidebar(
141 '<p><strong>' . __('For more information:') . '</strong></p>' .
142 '<p>' . __('<a href="http://codex.wordpress.org/Plugins_Editor_Screen" target="_blank">Documentation on Editing Plugins</a>') . '</p>' .
143 '<p>' . __('<a href="http://codex.wordpress.org/Writing_a_Plugin" target="_blank">Documentation on Writing Plugins</a>') . '</p>' .
144 '<p>' . __('<a href="https://wordpress.org/support/" target="_blank">Support Forums</a>') . '</p>'
147 require_once(ABSPATH . 'wp-admin/admin-header.php');
149 update_recently_edited(WP_PLUGIN_DIR . '/' . $file);
151 $content = file_get_contents( $real_file );
153 if ( '.php' == substr( $real_file, strrpos( $real_file, '.' ) ) ) {
154 $functions = wp_doc_link_parse( $content );
156 if ( !empty($functions) ) {
157 $docs_select = '<select name="docs-list" id="docs-list">';
158 $docs_select .= '<option value="">' . __( 'Function Name…' ) . '</option>';
159 foreach ( $functions as $function) {
160 $docs_select .= '<option value="' . esc_attr( $function ) . '">' . esc_html( $function ) . '()</option>';
162 $docs_select .= '</select>';
166 $content = esc_textarea( $content );
168 <?php if (isset($_GET['a'])) : ?>
169 <div id="message" class="updated"><p><?php _e('File edited successfully.') ?></p></div>
170 <?php elseif (isset($_GET['phperror'])) : ?>
171 <div id="message" class="updated"><p><?php _e('This plugin has been deactivated because your changes resulted in a <strong>fatal error</strong>.') ?></p>
173 if ( wp_verify_nonce($_GET['_error_nonce'], 'plugin-activation-error_' . $file) ) { ?>
174 <iframe style="border:0" width="100%" height="70px" src="<?php bloginfo('wpurl'); ?>/wp-admin/plugins.php?action=error_scrape&plugin=<?php echo esc_attr($file); ?>&_wpnonce=<?php echo esc_attr($_GET['_error_nonce']); ?>"></iframe>
179 <h2><?php echo esc_html( $title ); ?></h2>
181 <div class="fileedit-sub">
182 <div class="alignleft">
184 if ( is_plugin_active($plugin) ) {
185 if ( is_writeable($real_file) )
186 echo sprintf(__('Editing <strong>%s</strong> (active)'), $file);
188 echo sprintf(__('Browsing <strong>%s</strong> (active)'), $file);
190 if ( is_writeable($real_file) )
191 echo sprintf(__('Editing <strong>%s</strong> (inactive)'), $file);
193 echo sprintf(__('Browsing <strong>%s</strong> (inactive)'), $file);
197 <div class="alignright">
198 <form action="plugin-editor.php" method="post">
199 <strong><label for="plugin"><?php _e('Select plugin to edit:'); ?> </label></strong>
200 <select name="plugin" id="plugin">
202 foreach ( $plugins as $plugin_key => $a_plugin ) {
203 $plugin_name = $a_plugin['Name'];
204 if ( $plugin_key == $plugin )
205 $selected = " selected='selected'";
208 $plugin_name = esc_attr($plugin_name);
209 $plugin_key = esc_attr($plugin_key);
210 echo "\n\t<option value=\"$plugin_key\" $selected>$plugin_name</option>";
214 <?php submit_button( __( 'Select' ), 'button', 'Submit', false ); ?>
220 <div id="templateside">
221 <h3><?php _e('Plugin Files'); ?></h3>
225 foreach ( $plugin_files as $plugin_file ) :
226 // Get the extension of the file
227 if ( preg_match('/\.([^.]+)$/', $plugin_file, $matches) ) {
228 $ext = strtolower($matches[1]);
229 // If extension is not in the acceptable list, skip it
230 if ( !in_array( $ext, $editable_extensions ) )
233 // No extension found
237 <li<?php echo $file == $plugin_file ? ' class="highlight"' : ''; ?>><a href="plugin-editor.php?file=<?php echo urlencode( $plugin_file ) ?>&plugin=<?php echo urlencode( $plugin ) ?>"><?php echo $plugin_file ?></a></li>
241 <form name="template" id="template" action="plugin-editor.php" method="post">
242 <?php wp_nonce_field('edit-plugin_' . $file) ?>
243 <div><textarea cols="70" rows="25" name="newcontent" id="newcontent" aria-describedby="newcontent-description"><?php echo $content; ?></textarea>
244 <input type="hidden" name="action" value="update" />
245 <input type="hidden" name="file" value="<?php echo esc_attr($file) ?>" />
246 <input type="hidden" name="plugin" value="<?php echo esc_attr($plugin) ?>" />
247 <input type="hidden" name="scrollto" id="scrollto" value="<?php echo $scrollto; ?>" />
249 <?php if ( !empty( $docs_select ) ) : ?>
250 <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( 'Look Up' ) ?> " 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>
252 <?php if ( is_writeable($real_file) ) : ?>
253 <?php if ( in_array( $file, (array) get_option( 'active_plugins', array() ) ) ) { ?>
254 <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>
258 if ( isset($_GET['phperror']) ) {
259 echo "<input type='hidden' name='phperror' value='1' />";
260 submit_button( __( 'Update File and Attempt to Reactivate' ), 'primary', 'submit', false );
262 submit_button( __( 'Update File' ), 'primary', 'submit', false );
267 <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>
272 <script type="text/javascript">
273 jQuery(document).ready(function($){
274 $('#template').submit(function(){ $('#scrollto').val( $('#newcontent').scrollTop() ); });
275 $('#newcontent').scrollTop( $('#scrollto').val() );
281 include(ABSPATH . "wp-admin/admin-footer.php");