mirror of
https://github.com/WordPress/WordPress.git
synced 2024-06-27 07:14:57 +02:00
b698881469
This is an effort to provide a speed bump before heading into something potentially destructive and some education for users on better alternatives, even as we make the file editors safer to use. Each user, including existing users, will be shown a one-time dismissible modal warning on their first visit to each of the theme and plugin file editors. Copy tweaks to come. props michelleweber, Ipstenu, melchoyce, adamsilverstein, westonruter, toddnestor, aryamaaru, ZaneMatthew, cliffseal, helen. fixes #31779. Built from https://develop.svn.wordpress.org/trunk@41774 git-svn-id: http://core.svn.wordpress.org/trunk@41608 1a063a9b-81f0-0310-95a4-ce76da25c4cd
302 lines
12 KiB
PHP
302 lines
12 KiB
PHP
<?php
|
|
/**
|
|
* Edit plugin editor administration panel.
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Administration
|
|
*/
|
|
|
|
/** WordPress Administration Bootstrap */
|
|
require_once( dirname( __FILE__ ) . '/admin.php' );
|
|
|
|
if ( is_multisite() && ! is_network_admin() ) {
|
|
wp_redirect( network_admin_url( 'plugin-editor.php' ) );
|
|
exit();
|
|
}
|
|
|
|
if ( !current_user_can('edit_plugins') )
|
|
wp_die( __('Sorry, you are not allowed to edit plugins for this site.') );
|
|
|
|
$title = __("Edit Plugins");
|
|
$parent_file = 'plugins.php';
|
|
|
|
$plugins = get_plugins();
|
|
|
|
if ( empty( $plugins ) ) {
|
|
include( ABSPATH . 'wp-admin/admin-header.php' );
|
|
?>
|
|
<div class="wrap">
|
|
<h1><?php echo esc_html( $title ); ?></h1>
|
|
<div id="message" class="error"><p><?php _e( 'You do not appear to have any plugins available at this time.' ); ?></p></div>
|
|
</div>
|
|
<?php
|
|
include( ABSPATH . 'wp-admin/admin-footer.php' );
|
|
exit;
|
|
}
|
|
|
|
$file = '';
|
|
$plugin = '';
|
|
if ( isset( $_REQUEST['file'] ) ) {
|
|
$file = wp_unslash( $_REQUEST['file'] );
|
|
}
|
|
|
|
if ( isset( $_REQUEST['plugin'] ) ) {
|
|
$plugin = wp_unslash( $_REQUEST['plugin'] );
|
|
}
|
|
|
|
if ( empty( $plugin ) ) {
|
|
if ( $file ) {
|
|
|
|
// Locate the plugin for a given plugin file being edited.
|
|
$file_dirname = dirname( $file );
|
|
foreach ( array_keys( $plugins ) as $plugin_candidate ) {
|
|
if ( $plugin_candidate === $file || ( '.' !== $file_dirname && dirname( $plugin_candidate ) === $file_dirname ) ) {
|
|
$plugin = $plugin_candidate;
|
|
break;
|
|
}
|
|
}
|
|
|
|
// Fallback to the file as the plugin.
|
|
if ( empty( $plugin ) ) {
|
|
$plugin = $file;
|
|
}
|
|
} else {
|
|
$plugin = array_keys( $plugins );
|
|
$plugin = $plugin[0];
|
|
}
|
|
}
|
|
|
|
$plugin_files = get_plugin_files($plugin);
|
|
|
|
if ( empty( $file ) ) {
|
|
$file = $plugin_files[0];
|
|
}
|
|
|
|
$file = validate_file_to_edit($file, $plugin_files);
|
|
$real_file = WP_PLUGIN_DIR . '/' . $file;
|
|
|
|
// Handle fallback editing of file when JavaScript is not available.
|
|
$edit_error = null;
|
|
$posted_content = null;
|
|
if ( 'POST' === $_SERVER['REQUEST_METHOD'] ) {
|
|
$r = wp_edit_theme_plugin_file( wp_unslash( $_POST ) );
|
|
if ( is_wp_error( $r ) ) {
|
|
$edit_error = $r;
|
|
if ( check_ajax_referer( 'edit-plugin_' . $file, 'nonce', false ) && isset( $_POST['newcontent'] ) ) {
|
|
$posted_content = wp_unslash( $_POST['newcontent'] );
|
|
}
|
|
} else {
|
|
wp_redirect( add_query_arg(
|
|
array(
|
|
'a' => 1, // This means "success" for some reason.
|
|
'plugin' => $plugin,
|
|
'file' => $file,
|
|
),
|
|
admin_url( 'plugin-editor.php' )
|
|
) );
|
|
exit;
|
|
}
|
|
}
|
|
|
|
// List of allowable extensions
|
|
$editable_extensions = wp_get_plugin_file_editable_extensions( $plugin );
|
|
|
|
if ( ! is_file($real_file) ) {
|
|
wp_die(sprintf('<p>%s</p>', __('No such file exists! Double check the name and try again.')));
|
|
} else {
|
|
// Get the extension of the file
|
|
if ( preg_match('/\.([^.]+)$/', $real_file, $matches) ) {
|
|
$ext = strtolower($matches[1]);
|
|
// If extension is not in the acceptable list, skip it
|
|
if ( !in_array( $ext, $editable_extensions) )
|
|
wp_die(sprintf('<p>%s</p>', __('Files of this type are not editable.')));
|
|
}
|
|
}
|
|
|
|
get_current_screen()->add_help_tab( array(
|
|
'id' => 'overview',
|
|
'title' => __('Overview'),
|
|
'content' =>
|
|
'<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>' .
|
|
'<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>' .
|
|
'<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>' .
|
|
'<p id="editor-keyboard-trap-help-1">' . __( 'When using a keyboard to navigate:' ) . '</p>' .
|
|
'<ul>' .
|
|
'<li id="editor-keyboard-trap-help-2">' . __( 'In the editing area, the Tab key enters a tab character.' ) . '</li>' .
|
|
'<li id="editor-keyboard-trap-help-3">' . __( 'To move away from this area, press the Esc key followed by the Tab key.' ) . '</li>' .
|
|
'<li id="editor-keyboard-trap-help-4">' . __( 'Screen reader users: when in forms mode, you may need to press the Esc key twice.' ) . '</li>' .
|
|
'</ul>' .
|
|
'<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>' .
|
|
( is_network_admin() ? '<p>' . __('Any edits to files from this screen will be reflected on all sites in the network.') . '</p>' : '' )
|
|
) );
|
|
|
|
get_current_screen()->set_help_sidebar(
|
|
'<p><strong>' . __('For more information:') . '</strong></p>' .
|
|
'<p>' . __('<a href="https://codex.wordpress.org/Plugins_Editor_Screen">Documentation on Editing Plugins</a>') . '</p>' .
|
|
'<p>' . __('<a href="https://codex.wordpress.org/Writing_a_Plugin">Documentation on Writing Plugins</a>') . '</p>' .
|
|
'<p>' . __('<a href="https://wordpress.org/support/">Support Forums</a>') . '</p>'
|
|
);
|
|
|
|
$settings = array(
|
|
'codeEditor' => wp_enqueue_code_editor( array( 'file' => $real_file ) ),
|
|
);
|
|
wp_enqueue_script( 'wp-theme-plugin-editor' );
|
|
wp_add_inline_script( 'wp-theme-plugin-editor', sprintf( 'jQuery( function( $ ) { wp.themePluginEditor.init( $( "#template" ), %s ); } )', wp_json_encode( $settings ) ) );
|
|
wp_add_inline_script( 'wp-theme-plugin-editor', sprintf( 'wp.themePluginEditor.themeOrPlugin = "plugin";' ) );
|
|
|
|
require_once(ABSPATH . 'wp-admin/admin-header.php');
|
|
|
|
update_recently_edited(WP_PLUGIN_DIR . '/' . $file);
|
|
|
|
if ( ! empty( $posted_content ) ) {
|
|
$content = $posted_content;
|
|
} else {
|
|
$content = file_get_contents( $real_file );
|
|
}
|
|
|
|
if ( '.php' == substr( $real_file, strrpos( $real_file, '.' ) ) ) {
|
|
$functions = wp_doc_link_parse( $content );
|
|
|
|
if ( !empty($functions) ) {
|
|
$docs_select = '<select name="docs-list" id="docs-list">';
|
|
$docs_select .= '<option value="">' . __( 'Function Name…' ) . '</option>';
|
|
foreach ( $functions as $function) {
|
|
$docs_select .= '<option value="' . esc_attr( $function ) . '">' . esc_html( $function ) . '()</option>';
|
|
}
|
|
$docs_select .= '</select>';
|
|
}
|
|
}
|
|
|
|
$content = esc_textarea( $content );
|
|
?>
|
|
<div class="wrap">
|
|
<h1><?php echo esc_html( $title ); ?></h1>
|
|
|
|
<?php if ( isset( $_GET['a'] ) ) : ?>
|
|
<div id="message" class="updated notice is-dismissible">
|
|
<p><?php _e( 'File edited successfully.' ); ?></p>
|
|
</div>
|
|
<?php elseif ( is_wp_error( $edit_error ) ) : ?>
|
|
<div id="message" class="notice notice-error">
|
|
<p><?php _e( 'There was an error while trying to update the file. You may need to fix something and try updating again.' ); ?></p>
|
|
<pre><?php echo esc_html( $edit_error->get_error_message() ? $edit_error->get_error_message() : $edit_error->get_error_code() ); ?></pre>
|
|
</div>
|
|
<?php endif; ?>
|
|
|
|
<div class="fileedit-sub">
|
|
<div class="alignleft">
|
|
<h2>
|
|
<?php
|
|
if ( is_plugin_active( $plugin ) ) {
|
|
if ( is_writeable( $real_file ) ) {
|
|
/* translators: %s: plugin file name */
|
|
echo sprintf( __( 'Editing %s (active)' ), '<strong>' . esc_html( $file ) . '</strong>' );
|
|
} else {
|
|
/* translators: %s: plugin file name */
|
|
echo sprintf( __( 'Browsing %s (active)' ), '<strong>' . esc_html( $file ) . '</strong>' );
|
|
}
|
|
} else {
|
|
if ( is_writeable( $real_file ) ) {
|
|
/* translators: %s: plugin file name */
|
|
echo sprintf( __( 'Editing %s (inactive)' ), '<strong>' . esc_html( $file ) . '</strong>' );
|
|
} else {
|
|
/* translators: %s: plugin file name */
|
|
echo sprintf( __( 'Browsing %s (inactive)' ), '<strong>' . esc_html( $file ) . '</strong>' );
|
|
}
|
|
}
|
|
?>
|
|
</h2>
|
|
</div>
|
|
<div class="alignright">
|
|
<form action="plugin-editor.php" method="get">
|
|
<strong><label for="plugin"><?php _e('Select plugin to edit:'); ?> </label></strong>
|
|
<select name="plugin" id="plugin">
|
|
<?php
|
|
foreach ( $plugins as $plugin_key => $a_plugin ) {
|
|
$plugin_name = $a_plugin['Name'];
|
|
if ( $plugin_key == $plugin )
|
|
$selected = " selected='selected'";
|
|
else
|
|
$selected = '';
|
|
$plugin_name = esc_attr($plugin_name);
|
|
$plugin_key = esc_attr($plugin_key);
|
|
echo "\n\t<option value=\"$plugin_key\" $selected>$plugin_name</option>";
|
|
}
|
|
?>
|
|
</select>
|
|
<?php submit_button( __( 'Select' ), '', 'Submit', false ); ?>
|
|
</form>
|
|
</div>
|
|
<br class="clear" />
|
|
</div>
|
|
|
|
<div id="templateside">
|
|
<h2><?php _e( 'Plugin Files' ); ?></h2>
|
|
|
|
<?php
|
|
$plugin_editable_files = array();
|
|
foreach ( $plugin_files as $plugin_file ) {
|
|
if ( preg_match('/\.([^.]+)$/', $plugin_file, $matches ) && in_array( $matches[1], $editable_extensions ) ) {
|
|
$plugin_editable_files[] = $plugin_file;
|
|
}
|
|
}
|
|
?>
|
|
<ul>
|
|
<?php foreach ( $plugin_editable_files as $plugin_file ) : ?>
|
|
<li class="<?php echo esc_attr( $file === $plugin_file ? 'notice notice-info' : '' ); ?>">
|
|
<a href="plugin-editor.php?file=<?php echo urlencode( $plugin_file ); ?>&plugin=<?php echo urlencode( $plugin ); ?>"><?php echo esc_html( preg_replace( '#^.+?/#', '', $plugin_file ) ); ?></a>
|
|
</li>
|
|
<?php endforeach; ?>
|
|
</ul>
|
|
</div>
|
|
<form name="template" id="template" action="plugin-editor.php" method="post">
|
|
<?php wp_nonce_field( 'edit-plugin_' . $file, 'nonce' ); ?>
|
|
<div>
|
|
<label for="newcontent" id="theme-plugin-editor-label"><?php _e( 'Selected file content:' ); ?></label>
|
|
<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>
|
|
<input type="hidden" name="action" value="update" />
|
|
<input type="hidden" name="file" value="<?php echo esc_attr( $file ); ?>" />
|
|
<input type="hidden" name="plugin" value="<?php echo esc_attr( $plugin ); ?>" />
|
|
</div>
|
|
<?php if ( !empty( $docs_select ) ) : ?>
|
|
<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( '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>
|
|
<?php endif; ?>
|
|
<?php if ( is_writeable($real_file) ) : ?>
|
|
<div class="editor-notices">
|
|
<?php if ( in_array( $plugin, (array) get_option( 'active_plugins', array() ) ) ) { ?>
|
|
<div class="notice notice-warning inline active-plugin-edit-warning">
|
|
<p><?php _e('<strong>Warning:</strong> Making changes to active plugins is not recommended.'); ?></p>
|
|
</div>
|
|
<?php } ?>
|
|
</div>
|
|
<p class="submit">
|
|
<?php submit_button( __( 'Update File' ), 'primary', 'submit', false ); ?>
|
|
<span class="spinner"></span>
|
|
</p>
|
|
<?php else : ?>
|
|
<p><em><?php _e('You need to make this file writable before you can save your changes. See <a href="https://codex.wordpress.org/Changing_File_Permissions">the Codex</a> for more information.'); ?></em></p>
|
|
<?php endif; ?>
|
|
<?php wp_print_file_editor_templates(); ?>
|
|
</form>
|
|
<br class="clear" />
|
|
</div>
|
|
<?php
|
|
$dismissed_pointers = explode( ',', (string) get_user_meta( get_current_user_id(), 'dismissed_wp_pointers', true ) );
|
|
if ( ! in_array( 'plugin_editor_notice', $dismissed_pointers, true ) ) :
|
|
?>
|
|
<div id="file-editor-warning" class="notification-dialog-wrap file-editor-warning hide-if-no-js">
|
|
<div class="notification-dialog-background"></div>
|
|
<div class="notification-dialog" role="dialog" aria-labelledby="file-editor-warning-title" tabindex="0">
|
|
<div class="file-editor-warning-content">
|
|
<h1 id="file-editor-warning-title"><?php _e( 'Heads up!' ); ?></h1>
|
|
<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 theme or other plugins, and can leave you unable to log back in to WordPress and undo changes.' ); ?></p>
|
|
<p><?php _e( 'If you absolutely have to edit this plugin, create a copy with a new name and hang on to the original version, so you can re-enable a functional version if something goes wrong.' ); ?></p>
|
|
<p><button type="button" class="file-editor-warning-dismiss button-primary"><?php _e( 'I understand' ); ?></button></p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<?php
|
|
endif; // editor warning notice
|
|
|
|
include(ABSPATH . "wp-admin/admin-footer.php");
|