| [ Index ] |
PHP Cross Reference of WordPress |
[Summary view] [Print] [Text view]
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( dirname( __FILE__ ) . '/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( __( 'Sorry, you are not allowed to edit plugins for this site.' ) ); 19 } 20 21 $title = __( 'Edit Plugins' ); 22 $parent_file = 'plugins.php'; 23 24 $plugins = get_plugins(); 25 26 if ( empty( $plugins ) ) { 27 include( ABSPATH . 'wp-admin/admin-header.php' ); 28 ?> 29 <div class="wrap"> 30 <h1><?php echo esc_html( $title ); ?></h1> 31 <div id="message" class="error"><p><?php _e( 'You do not appear to have any plugins available at this time.' ); ?></p></div> 32 </div> 33 <?php 34 include( ABSPATH . 'wp-admin/admin-footer.php' ); 35 exit; 36 } 37 38 $file = ''; 39 $plugin = ''; 40 if ( isset( $_REQUEST['file'] ) ) { 41 $file = wp_unslash( $_REQUEST['file'] ); 42 } 43 44 if ( isset( $_REQUEST['plugin'] ) ) { 45 $plugin = wp_unslash( $_REQUEST['plugin'] ); 46 } 47 48 if ( empty( $plugin ) ) { 49 if ( $file ) { 50 51 // Locate the plugin for a given plugin file being edited. 52 $file_dirname = dirname( $file ); 53 foreach ( array_keys( $plugins ) as $plugin_candidate ) { 54 if ( $plugin_candidate === $file || ( '.' !== $file_dirname && dirname( $plugin_candidate ) === $file_dirname ) ) { 55 $plugin = $plugin_candidate; 56 break; 57 } 58 } 59 60 // Fallback to the file as the plugin. 61 if ( empty( $plugin ) ) { 62 $plugin = $file; 63 } 64 } else { 65 $plugin = array_keys( $plugins ); 66 $plugin = $plugin[0]; 67 } 68 } 69 70 $plugin_files = get_plugin_files( $plugin ); 71 72 if ( empty( $file ) ) { 73 $file = $plugin_files[0]; 74 } 75 76 $file = validate_file_to_edit( $file, $plugin_files ); 77 $real_file = WP_PLUGIN_DIR . '/' . $file; 78 79 // Handle fallback editing of file when JavaScript is not available. 80 $edit_error = null; 81 $posted_content = null; 82 if ( 'POST' === $_SERVER['REQUEST_METHOD'] ) { 83 $r = wp_edit_theme_plugin_file( wp_unslash( $_POST ) ); 84 if ( is_wp_error( $r ) ) { 85 $edit_error = $r; 86 if ( check_ajax_referer( 'edit-plugin_' . $file, 'nonce', false ) && isset( $_POST['newcontent'] ) ) { 87 $posted_content = wp_unslash( $_POST['newcontent'] ); 88 } 89 } else { 90 wp_redirect( 91 add_query_arg( 92 array( 93 'a' => 1, // This means "success" for some reason. 94 'plugin' => $plugin, 95 'file' => $file, 96 ), 97 admin_url( 'plugin-editor.php' ) 98 ) 99 ); 100 exit; 101 } 102 } 103 104 // List of allowable extensions 105 $editable_extensions = wp_get_plugin_file_editable_extensions( $plugin ); 106 107 if ( ! is_file( $real_file ) ) { 108 wp_die( sprintf( '<p>%s</p>', __( 'File does not exist! Please double check the name and try again.' ) ) ); 109 } else { 110 // Get the extension of the file 111 if ( preg_match( '/\.([^.]+)$/', $real_file, $matches ) ) { 112 $ext = strtolower( $matches[1] ); 113 // If extension is not in the acceptable list, skip it 114 if ( ! in_array( $ext, $editable_extensions ) ) { 115 wp_die( sprintf( '<p>%s</p>', __( 'Files of this type are not editable.' ) ) ); 116 } 117 } 118 } 119 120 get_current_screen()->add_help_tab( 121 array( 122 'id' => 'overview', 123 'title' => __( 'Overview' ), 124 'content' => 125 '<p>' . __( 'You can use the plugin 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>' . 126 '<p>' . __( 'Choose a plugin to edit from the dropdown menu 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>' . 127 '<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>' . 128 '<p id="editor-keyboard-trap-help-1">' . __( 'When using a keyboard to navigate:' ) . '</p>' . 129 '<ul>' . 130 '<li id="editor-keyboard-trap-help-2">' . __( 'In the editing area, the Tab key enters a tab character.' ) . '</li>' . 131 '<li id="editor-keyboard-trap-help-3">' . __( 'To move away from this area, press the Esc key followed by the Tab key.' ) . '</li>' . 132 '<li id="editor-keyboard-trap-help-4">' . __( 'Screen reader users: when in forms mode, you may need to press the Esc key twice.' ) . '</li>' . 133 '</ul>' . 134 '<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>' . 135 ( is_network_admin() ? '<p>' . __( 'Any edits to files from this screen will be reflected on all sites in the network.' ) . '</p>' : '' ), 136 ) 137 ); 138 139 get_current_screen()->set_help_sidebar( 140 '<p><strong>' . __( 'For more information:' ) . '</strong></p>' . 141 '<p>' . __( '<a href="https://wordpress.org/support/article/plugins-editor-screen/">Documentation on Editing Plugins</a>' ) . '</p>' . 142 '<p>' . __( '<a href="https://developer.wordpress.org/plugins/">Documentation on Writing Plugins</a>' ) . '</p>' . 143 '<p>' . __( '<a href="https://wordpress.org/support/">Support</a>' ) . '</p>' 144 ); 145 146 $settings = array( 147 'codeEditor' => wp_enqueue_code_editor( array( 'file' => $real_file ) ), 148 ); 149 wp_enqueue_script( 'wp-theme-plugin-editor' ); 150 wp_add_inline_script( 'wp-theme-plugin-editor', sprintf( 'jQuery( function( $ ) { wp.themePluginEditor.init( $( "#template" ), %s ); } )', wp_json_encode( $settings ) ) ); 151 wp_add_inline_script( 'wp-theme-plugin-editor', sprintf( 'wp.themePluginEditor.themeOrPlugin = "plugin";' ) ); 152 153 require_once( ABSPATH . 'wp-admin/admin-header.php' ); 154 155 update_recently_edited( WP_PLUGIN_DIR . '/' . $file ); 156 157 if ( ! empty( $posted_content ) ) { 158 $content = $posted_content; 159 } else { 160 $content = file_get_contents( $real_file ); 161 } 162 163 if ( '.php' == substr( $real_file, strrpos( $real_file, '.' ) ) ) { 164 $functions = wp_doc_link_parse( $content ); 165 166 if ( ! empty( $functions ) ) { 167 $docs_select = '<select name="docs-list" id="docs-list">'; 168 $docs_select .= '<option value="">' . __( 'Function Name…' ) . '</option>'; 169 foreach ( $functions as $function ) { 170 $docs_select .= '<option value="' . esc_attr( $function ) . '">' . esc_html( $function ) . '()</option>'; 171 } 172 $docs_select .= '</select>'; 173 } 174 } 175 176 $content = esc_textarea( $content ); 177 ?> 178 <div class="wrap"> 179 <h1><?php echo esc_html( $title ); ?></h1> 180 181 <?php if ( isset( $_GET['a'] ) ) : ?> 182 <div id="message" class="updated notice is-dismissible"> 183 <p><?php _e( 'File edited successfully.' ); ?></p> 184 </div> 185 <?php elseif ( is_wp_error( $edit_error ) ) : ?> 186 <div id="message" class="notice notice-error"> 187 <p><?php _e( 'There was an error while trying to update the file. You may need to fix something and try updating again.' ); ?></p> 188 <pre><?php echo esc_html( $edit_error->get_error_message() ? $edit_error->get_error_message() : $edit_error->get_error_code() ); ?></pre> 189 </div> 190 <?php endif; ?> 191 192 <div class="fileedit-sub"> 193 <div class="alignleft"> 194 <h2> 195 <?php 196 if ( is_plugin_active( $plugin ) ) { 197 if ( is_writeable( $real_file ) ) { 198 /* translators: %s: Plugin file name. */ 199 echo sprintf( __( 'Editing %s (active)' ), '<strong>' . esc_html( $file ) . '</strong>' ); 200 } else { 201 /* translators: %s: Plugin file name. */ 202 echo sprintf( __( 'Browsing %s (active)' ), '<strong>' . esc_html( $file ) . '</strong>' ); 203 } 204 } else { 205 if ( is_writeable( $real_file ) ) { 206 /* translators: %s: Plugin file name. */ 207 echo sprintf( __( 'Editing %s (inactive)' ), '<strong>' . esc_html( $file ) . '</strong>' ); 208 } else { 209 /* translators: %s: Plugin file name. */ 210 echo sprintf( __( 'Browsing %s (inactive)' ), '<strong>' . esc_html( $file ) . '</strong>' ); 211 } 212 } 213 ?> 214 </h2> 215 </div> 216 <div class="alignright"> 217 <form action="plugin-editor.php" method="get"> 218 <strong><label for="plugin"><?php _e( 'Select plugin to edit:' ); ?> </label></strong> 219 <select name="plugin" id="plugin"> 220 <?php 221 foreach ( $plugins as $plugin_key => $a_plugin ) { 222 $plugin_name = $a_plugin['Name']; 223 if ( $plugin_key == $plugin ) { 224 $selected = " selected='selected'"; 225 } else { 226 $selected = ''; 227 } 228 $plugin_name = esc_attr( $plugin_name ); 229 $plugin_key = esc_attr( $plugin_key ); 230 echo "\n\t<option value=\"$plugin_key\" $selected>$plugin_name</option>"; 231 } 232 ?> 233 </select> 234 <?php submit_button( __( 'Select' ), '', 'Submit', false ); ?> 235 </form> 236 </div> 237 <br class="clear" /> 238 </div> 239 240 <div id="templateside"> 241 <h2 id="plugin-files-label"><?php _e( 'Plugin Files' ); ?></h2> 242 243 <?php 244 $plugin_editable_files = array(); 245 foreach ( $plugin_files as $plugin_file ) { 246 if ( preg_match( '/\.([^.]+)$/', $plugin_file, $matches ) && in_array( $matches[1], $editable_extensions ) ) { 247 $plugin_editable_files[] = $plugin_file; 248 } 249 } 250 ?> 251 <ul role="tree" aria-labelledby="plugin-files-label"> 252 <li role="treeitem" tabindex="-1" aria-expanded="true" aria-level="1" aria-posinset="1" aria-setsize="1"> 253 <ul role="group"> 254 <?php wp_print_plugin_file_tree( wp_make_plugin_file_tree( $plugin_editable_files ) ); ?> 255 </ul> 256 </ul> 257 </div> 258 <form name="template" id="template" action="plugin-editor.php" method="post"> 259 <?php wp_nonce_field( 'edit-plugin_' . $file, 'nonce' ); ?> 260 <div> 261 <label for="newcontent" id="theme-plugin-editor-label"><?php _e( 'Selected file content:' ); ?></label> 262 <textarea cols="70" rows="25" name="newcontent" id="newcontent" aria-describedby="editor-keyboard-trap-help-1 editor-keyboard-trap-help-2 editor-keyboard-trap-help-3 editor-keyboard-trap-help-4"><?php echo $content; ?></textarea> 263 <input type="hidden" name="action" value="update" /> 264 <input type="hidden" name="file" value="<?php echo esc_attr( $file ); ?>" /> 265 <input type="hidden" name="plugin" value="<?php echo esc_attr( $plugin ); ?>" /> 266 </div> 267 <?php if ( ! empty( $docs_select ) ) : ?> 268 <div id="documentation" class="hide-if-no-js"><label for="docs-list"><?php _e( 'Documentation:' ); ?></label> <?php echo $docs_select; ?> <input disabled id="docs-lookup" type="button" class="button" value="<?php esc_attr_e( 'Look Up' ); ?> " onclick="if ( '' != jQuery('#docs-list').val() ) { window.open( 'https://api.wordpress.org/core/handbook/1.0/?function=' + escape( jQuery( '#docs-list' ).val() ) + '&locale=<?php echo urlencode( get_user_locale() ); ?>&version=<?php echo urlencode( get_bloginfo( 'version' ) ); ?>&redirect=true'); }" /></div> 269 <?php endif; ?> 270 <?php if ( is_writeable( $real_file ) ) : ?> 271 <div class="editor-notices"> 272 <?php if ( in_array( $plugin, (array) get_option( 'active_plugins', array() ) ) ) { ?> 273 <div class="notice notice-warning inline active-plugin-edit-warning"> 274 <p><?php _e( '<strong>Warning:</strong> Making changes to active plugins is not recommended.' ); ?></p> 275 </div> 276 <?php } ?> 277 </div> 278 <p class="submit"> 279 <?php submit_button( __( 'Update File' ), 'primary', 'submit', false ); ?> 280 <span class="spinner"></span> 281 </p> 282 <?php else : ?> 283 <p><em> 284 <?php 285 printf( 286 /* translators: %s: Documentation URL. */ 287 __( 'You need to make this file writable before you can save your changes. See <a href="%s">Changing File Permissions</a> for more information.' ), 288 __( 'https://wordpress.org/support/article/changing-file-permissions/' ) 289 ); 290 ?> 291 </em></p> 292 <?php endif; ?> 293 <?php wp_print_file_editor_templates(); ?> 294 </form> 295 <br class="clear" /> 296 </div> 297 <?php 298 $dismissed_pointers = explode( ',', (string) get_user_meta( get_current_user_id(), 'dismissed_wp_pointers', true ) ); 299 if ( ! in_array( 'plugin_editor_notice', $dismissed_pointers, true ) ) : 300 // Get a back URL 301 $referer = wp_get_referer(); 302 $excluded_referer_basenames = array( 'plugin-editor.php', 'wp-login.php' ); 303 304 if ( $referer && ! in_array( basename( parse_url( $referer, PHP_URL_PATH ) ), $excluded_referer_basenames, true ) ) { 305 $return_url = $referer; 306 } else { 307 $return_url = admin_url( '/' ); 308 } 309 ?> 310 <div id="file-editor-warning" class="notification-dialog-wrap file-editor-warning hide-if-no-js hidden"> 311 <div class="notification-dialog-background"></div> 312 <div class="notification-dialog"> 313 <div class="file-editor-warning-content"> 314 <div class="file-editor-warning-message"> 315 <h1><?php _e( 'Heads up!' ); ?></h1> 316 <p><?php _e( 'You appear to be making direct edits to your plugin in the WordPress dashboard. We recommend that you don’t! Editing plugins directly may introduce incompatibilities that break your site and your changes may be lost in future updates.' ); ?></p> 317 <p><?php _e( 'If you absolutely have to make direct edits to this plugin, use a file manager to create a copy with a new name and hang on to the original. That way, you can re-enable a functional version if something goes wrong.' ); ?></p> 318 </div> 319 <p> 320 <a class="button file-editor-warning-go-back" href="<?php echo esc_url( $return_url ); ?>"><?php _e( 'Go back' ); ?></a> 321 <button type="button" class="file-editor-warning-dismiss button button-primary"><?php _e( 'I understand' ); ?></button> 322 </p> 323 </div> 324 </div> 325 </div> 326 <?php 327 endif; // Editor warning notice. 328 329 include( ABSPATH . 'wp-admin/admin-footer.php' );
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated: Wed Jan 22 01:00:03 2020 | Cross-referenced by PHPXref 0.7.1 |