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