[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-admin/ -> theme-editor.php (source)

   1  <?php
   2  /**
   3   * Theme 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( 'theme-editor.php' ) );
  14      exit;
  15  }
  16  
  17  if ( ! current_user_can( 'edit_themes' ) ) {
  18      wp_die( '<p>' . __( 'Sorry, you are not allowed to edit templates for this site.' ) . '</p>' );
  19  }
  20  
  21  // Used in the HTML title tag.
  22  $title       = __( 'Edit Themes' );
  23  $parent_file = 'themes.php';
  24  
  25  get_current_screen()->add_help_tab(
  26      array(
  27          'id'      => 'overview',
  28          'title'   => __( 'Overview' ),
  29          'content' =>
  30                  '<p>' . __( 'You can use the theme file editor to edit the individual CSS and PHP files which make up your theme.' ) . '</p>' .
  31                  '<p>' . __( 'Begin by choosing a theme to edit from the dropdown menu and clicking the Select button. A list then appears of the theme&#8217;s template files. Clicking once on any file name causes the file to appear in the large Editor box.' ) . '</p>' .
  32                  '<p>' . __( 'For PHP files, you can use the documentation dropdown to select from functions recognized in that file. Look Up takes you to a web page with reference material about that particular function.' ) . '</p>' .
  33                  '<p id="editor-keyboard-trap-help-1">' . __( 'When using a keyboard to navigate:' ) . '</p>' .
  34                  '<ul>' .
  35                  '<li id="editor-keyboard-trap-help-2">' . __( 'In the editing area, the Tab key enters a tab character.' ) . '</li>' .
  36                  '<li id="editor-keyboard-trap-help-3">' . __( 'To move away from this area, press the Esc key followed by the Tab key.' ) . '</li>' .
  37                  '<li id="editor-keyboard-trap-help-4">' . __( 'Screen reader users: when in forms mode, you may need to press the Esc key twice.' ) . '</li>' .
  38                  '</ul>' .
  39                  '<p>' . __( 'After typing in your edits, click Update File.' ) . '</p>' .
  40                  '<p>' . __( '<strong>Advice:</strong> Think very carefully about your site crashing if you are live-editing the theme currently in use.' ) . '</p>' .
  41                  '<p>' . sprintf(
  42                      /* translators: %s: Link to documentation on child themes. */
  43                      __( 'Upgrading to a newer version of the same theme will override changes made here. To avoid this, consider creating a <a href="%s">child theme</a> instead.' ),
  44                      __( 'https://developer.wordpress.org/themes/advanced-topics/child-themes/' )
  45                  ) . '</p>' .
  46                  ( is_network_admin() ? '<p>' . __( 'Any edits to files from this screen will be reflected on all sites in the network.' ) . '</p>' : '' ),
  47      )
  48  );
  49  
  50  get_current_screen()->set_help_sidebar(
  51      '<p><strong>' . __( 'For more information:' ) . '</strong></p>' .
  52      '<p>' . __( '<a href="https://developer.wordpress.org/themes/">Documentation on Theme Development</a>' ) . '</p>' .
  53      '<p>' . __( '<a href="https://wordpress.org/documentation/article/appearance-theme-file-editor-screen/">Documentation on Editing Themes</a>' ) . '</p>' .
  54      '<p>' . __( '<a href="https://developer.wordpress.org/advanced-administration/wordpress/edit-files/">Documentation on Editing Files</a>' ) . '</p>' .
  55      '<p>' . __( '<a href="https://developer.wordpress.org/themes/basics/template-tags/">Documentation on Template Tags</a>' ) . '</p>' .
  56      '<p>' . __( '<a href="https://wordpress.org/support/forums/">Support forums</a>' ) . '</p>'
  57  );
  58  
  59  $action = ! empty( $_REQUEST['action'] ) ? sanitize_text_field( $_REQUEST['action'] ) : '';
  60  $theme  = ! empty( $_REQUEST['theme'] ) ? sanitize_text_field( $_REQUEST['theme'] ) : '';
  61  $file   = ! empty( $_REQUEST['file'] ) ? sanitize_text_field( $_REQUEST['file'] ) : '';
  62  $error  = ! empty( $_REQUEST['error'] );
  63  
  64  if ( $theme ) {
  65      $stylesheet = $theme;
  66  } else {
  67      $stylesheet = get_stylesheet();
  68  }
  69  
  70  $theme = wp_get_theme( $stylesheet );
  71  
  72  if ( ! $theme->exists() ) {
  73      wp_die( __( 'The requested theme does not exist.' ) );
  74  }
  75  
  76  if ( $theme->errors() && 'theme_no_stylesheet' === $theme->errors()->get_error_code() ) {
  77      wp_die( __( 'The requested theme does not exist.' ) . ' ' . $theme->errors()->get_error_message() );
  78  }
  79  
  80  $allowed_files = array();
  81  $style_files   = array();
  82  
  83  $file_types = wp_get_theme_file_editable_extensions( $theme );
  84  
  85  foreach ( $file_types as $type ) {
  86      switch ( $type ) {
  87          case 'php':
  88              $allowed_files += $theme->get_files( 'php', -1 );
  89              break;
  90          case 'css':
  91              $style_files                = $theme->get_files( 'css', -1 );
  92              $allowed_files['style.css'] = $style_files['style.css'];
  93              $allowed_files             += $style_files;
  94              break;
  95          default:
  96              $allowed_files += $theme->get_files( $type, -1 );
  97              break;
  98      }
  99  }
 100  
 101  // Move functions.php and style.css to the top.
 102  if ( isset( $allowed_files['functions.php'] ) ) {
 103      $allowed_files = array( 'functions.php' => $allowed_files['functions.php'] ) + $allowed_files;
 104  }
 105  if ( isset( $allowed_files['style.css'] ) ) {
 106      $allowed_files = array( 'style.css' => $allowed_files['style.css'] ) + $allowed_files;
 107  }
 108  
 109  if ( empty( $file ) ) {
 110      $relative_file = 'style.css';
 111      $file          = $allowed_files['style.css'];
 112  } else {
 113      $relative_file = wp_unslash( $file );
 114      $file          = $theme->get_stylesheet_directory() . '/' . $relative_file;
 115  }
 116  
 117  validate_file_to_edit( $file, $allowed_files );
 118  
 119  // Handle fallback editing of file when JavaScript is not available.
 120  $edit_error     = null;
 121  $posted_content = null;
 122  
 123  if ( 'POST' === $_SERVER['REQUEST_METHOD'] ) {
 124      $edit_result = wp_edit_theme_plugin_file( wp_unslash( $_POST ) );
 125  
 126      if ( is_wp_error( $edit_result ) ) {
 127          $edit_error = $edit_result;
 128  
 129          if ( check_ajax_referer( 'edit-theme_' . $stylesheet . '_' . $relative_file, 'nonce', false ) && isset( $_POST['newcontent'] ) ) {
 130              $posted_content = wp_unslash( $_POST['newcontent'] );
 131          }
 132      } else {
 133          wp_redirect(
 134              add_query_arg(
 135                  array(
 136                      'a'     => 1, // This means "success" for some reason.
 137                      'theme' => $stylesheet,
 138                      'file'  => $relative_file,
 139                  ),
 140                  admin_url( 'theme-editor.php' )
 141              )
 142          );
 143          exit;
 144      }
 145  }
 146  
 147  $settings = array(
 148      'codeEditor' => wp_enqueue_code_editor( compact( 'file' ) ),
 149  );
 150  wp_enqueue_script( 'wp-theme-plugin-editor' );
 151  wp_add_inline_script( 'wp-theme-plugin-editor', sprintf( 'jQuery( function( $ ) { wp.themePluginEditor.init( $( "#template" ), %s ); } )', wp_json_encode( $settings, JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ) ) );
 152  wp_add_inline_script( 'wp-theme-plugin-editor', 'wp.themePluginEditor.themeOrPlugin = "theme";' );
 153  
 154  require_once  ABSPATH . 'wp-admin/admin-header.php';
 155  
 156  update_recently_edited( $file );
 157  
 158  if ( ! is_file( $file ) ) {
 159      $error = true;
 160  }
 161  
 162  $content = '';
 163  if ( ! empty( $posted_content ) ) {
 164      $content = $posted_content;
 165  } elseif ( ! $error && filesize( $file ) > 0 ) {
 166      $f       = fopen( $file, 'r' );
 167      $content = fread( $f, filesize( $file ) );
 168  
 169      if ( str_ends_with( $file, '.php' ) ) {
 170          $functions = wp_doc_link_parse( $content );
 171  
 172          if ( ! empty( $functions ) ) {
 173              $docs_select  = '<select name="docs-list" id="docs-list">';
 174              $docs_select .= '<option value="">' . esc_html__( 'Function Name&hellip;' ) . '</option>';
 175  
 176              foreach ( $functions as $function ) {
 177                  $docs_select .= '<option value="' . esc_attr( $function ) . '">' . esc_html( $function ) . '()</option>';
 178              }
 179  
 180              $docs_select .= '</select>';
 181          }
 182      }
 183  
 184      $content = esc_textarea( $content );
 185  }
 186  
 187  $file_show = array_search( $file, array_filter( $allowed_files ), true );
 188  ?>
 189  <div class="wrap">
 190  <h1><?php echo esc_html( $title ); ?></h1>
 191  
 192  <?php
 193  if ( isset( $_GET['a'] ) ) {
 194      wp_admin_notice(
 195          __( 'File edited successfully.' ),
 196          array(
 197              'id'                 => 'message',
 198              'dismissible'        => true,
 199              'additional_classes' => array( 'updated' ),
 200          )
 201      );
 202  } elseif ( is_wp_error( $edit_error ) ) {
 203      $error_code = esc_html( $edit_error->get_error_message() ? $edit_error->get_error_message() : $edit_error->get_error_code() );
 204      $message    = '<p>' . __( 'There was an error while trying to update the file. You may need to fix something and try updating again.' ) . '</p>
 205      <pre>' . $error_code . '</pre>';
 206      wp_admin_notice(
 207          $message,
 208          array(
 209              'type' => 'error',
 210              'id'   => 'message',
 211          )
 212      );
 213  }
 214  
 215  if ( preg_match( '/\.css$/', $file ) ) {
 216      if ( ! wp_is_block_theme() && current_user_can( 'customize' ) ) {
 217          $message = '<p><strong>' . __( 'Did you know?' ) . '</strong></p><p>' . sprintf(
 218              /* translators: %s: Link to add custom CSS section in either the Customizer (classic themes) or Site Editor (block themes). */
 219              __( 'There is no need to change your CSS here &mdash; you can edit and live preview CSS changes in the <a href="%s">built-in CSS editor</a>.' ),
 220              esc_url( add_query_arg( 'autofocus[section]', 'custom_css', admin_url( 'customize.php' ) ) )
 221          ) . '</p>';
 222          wp_admin_notice(
 223              $message,
 224              array(
 225                  'type' => 'info',
 226                  'id'   => 'message',
 227              )
 228          );
 229      } elseif ( wp_is_block_theme() && current_user_can( 'edit_theme_options' ) ) {
 230          $site_editor_url = admin_url(
 231              add_query_arg(
 232                  urlencode_deep(
 233                      array(
 234                          'p'       => '/styles',
 235                          'section' => '/css',
 236                      )
 237                  ),
 238                  'site-editor.php'
 239              )
 240          );
 241  
 242          $message = '<p><strong>' . __( 'Did you know?' ) . '</strong></p><p>' . sprintf(
 243              /* translators: %s: Link to add custom CSS section in either the Customizer (classic themes) or Site Editor (block themes). */
 244              __( 'There is no need to change your CSS here &mdash; you can edit and live preview CSS changes in the <a href="%s">built-in CSS editor</a>.' ),
 245              esc_url( $site_editor_url )
 246          ) . '</p>';
 247          wp_admin_notice(
 248              $message,
 249              array(
 250                  'type' => 'info',
 251                  'id'   => 'message',
 252              )
 253          );
 254      }
 255      if ( file_exists( preg_replace( '/\.css$/', '.min.css', $file ) ) ) {
 256          $message = '<p><strong>' . __( 'There is a minified version of this stylesheet.' ) . '</strong></p><p>' .
 257              __( 'It is likely that this unminified stylesheet will not be served to visitors.' ) . '</p>';
 258          wp_admin_notice(
 259              $message,
 260              array(
 261                  'type' => 'warning',
 262                  'id'   => 'wp-css-min-warning',
 263              )
 264          );
 265      }
 266  }
 267  ?>
 268  
 269  <div class="fileedit-sub">
 270  <div class="alignleft">
 271  <h2>
 272      <?php
 273      if ( wp_get_theme()->get( 'Name' ) === $theme->display( 'Name' ) ) {
 274          /* translators: %s: Theme name. */
 275          printf( __( 'Editing %s (active)' ), '<strong>' . $theme->display( 'Name' ) . '</strong>' );
 276      } else {
 277          /* translators: %s: Theme name. */
 278          printf( __( 'Editing %s (inactive)' ), '<strong>' . $theme->display( 'Name' ) . '</strong>' );
 279      }
 280      ?>
 281  </h2>
 282  <?php
 283  printf(
 284      /* translators: %s: File path. */
 285      ' <span><strong>' . __( 'File: %s' ) . '</strong></span>',
 286      esc_html( $file_show )
 287  );
 288  ?>
 289  </div>
 290  <div class="alignright">
 291      <form action="theme-editor.php" method="get">
 292          <label for="theme" id="theme-plugin-editor-selector"><?php _e( 'Select theme to edit:' ); ?> </label>
 293          <select name="theme" id="theme">
 294          <?php
 295          foreach ( wp_get_themes( array( 'errors' => null ) ) as $a_stylesheet => $a_theme ) {
 296              if ( $a_theme->errors() && 'theme_no_stylesheet' === $a_theme->errors()->get_error_code() ) {
 297                  continue;
 298              }
 299  
 300              $selected = ( $a_stylesheet === $stylesheet ) ? ' selected="selected"' : '';
 301              echo "\n\t" . '<option value="' . esc_attr( $a_stylesheet ) . '"' . $selected . '>' . $a_theme->display( 'Name' ) . '</option>';
 302          }
 303          ?>
 304          </select>
 305          <?php submit_button( __( 'Select' ), '', 'Submit', false ); ?>
 306      </form>
 307  </div>
 308  <br class="clear" />
 309  </div>
 310  
 311  <?php
 312  if ( $theme->errors() ) {
 313      wp_admin_notice(
 314          '<strong>' . __( 'This theme is broken.' ) . '</strong> ' . $theme->errors()->get_error_message(),
 315          array(
 316              'additional_classes' => array( 'error' ),
 317          )
 318      );
 319  }
 320  ?>
 321  
 322  <div id="templateside">
 323      <h2 id="theme-files-label"><?php _e( 'Theme Files' ); ?></h2>
 324      <ul role="tree" aria-labelledby="theme-files-label">
 325          <?php if ( $theme->parent() ) : ?>
 326              <li class="howto">
 327                  <?php
 328                  printf(
 329                      /* translators: %s: Link to edit parent theme. */
 330                      __( 'This child theme inherits templates from a parent theme, %s.' ),
 331                      sprintf(
 332                          '<a href="%s">%s</a>',
 333                          self_admin_url( 'theme-editor.php?theme=' . urlencode( $theme->get_template() ) ),
 334                          $theme->parent()->display( 'Name' )
 335                      )
 336                  );
 337                  ?>
 338              </li>
 339          <?php endif; ?>
 340          <li role="treeitem" tabindex="-1" aria-expanded="true" aria-level="1" aria-posinset="1" aria-setsize="1">
 341              <ul role="group">
 342                  <?php wp_print_theme_file_tree( wp_make_theme_file_tree( $allowed_files ) ); ?>
 343              </ul>
 344          </li>
 345      </ul>
 346  </div>
 347  
 348  <?php
 349  if ( $error ) :
 350      wp_admin_notice(
 351          __( 'File does not exist! Please double check the name and try again.' ),
 352          array(
 353              'additional_classes' => array( 'error' ),
 354          )
 355      );
 356  else :
 357      ?>
 358      <form name="template" id="template" action="theme-editor.php" method="post">
 359          <?php wp_nonce_field( 'edit-theme_' . $stylesheet . '_' . $relative_file, 'nonce' ); ?>
 360          <div>
 361              <label for="newcontent" id="theme-plugin-editor-label"><?php _e( 'Selected file content:' ); ?></label>
 362              <textarea cols="70" rows="30" 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>
 363              <input type="hidden" name="action" value="update" />
 364              <input type="hidden" name="file" value="<?php echo esc_attr( $relative_file ); ?>" />
 365              <input type="hidden" name="theme" value="<?php echo esc_attr( $theme->get_stylesheet() ); ?>" />
 366          </div>
 367  
 368          <?php if ( ! empty( $functions ) ) : ?>
 369              <div id="documentation" class="hide-if-no-js">
 370                  <label for="docs-list"><?php _e( 'Documentation:' ); ?></label>
 371                  <?php echo $docs_select; ?>
 372                  <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() ) + '&amp;locale=<?php echo urlencode( get_user_locale() ); ?>&amp;version=<?php echo urlencode( get_bloginfo( 'version' ) ); ?>&amp;redirect=true'); }" />
 373              </div>
 374          <?php endif; ?>
 375  
 376          <div>
 377              <div class="editor-notices">
 378                  <?php
 379                  if ( is_child_theme() && $theme->get_stylesheet() === get_template() ) :
 380                      $message  = ( is_writable( $file ) ) ? '<strong>' . __( 'Caution:' ) . '</strong> ' : '';
 381                      $message .= __( 'This is a file in your current parent theme.' );
 382                      wp_admin_notice(
 383                          $message,
 384                          array(
 385                              'type'               => 'warning',
 386                              'additional_classes' => array( 'inline' ),
 387                          )
 388                      );
 389                  endif;
 390                  ?>
 391              </div>
 392              <?php
 393              if ( is_writable( $file ) ) {
 394                  ?>
 395                  <p class="submit">
 396                      <?php submit_button( __( 'Update File' ), 'primary', 'submit', false ); ?>
 397                      <span class="spinner"></span>
 398                  </p>
 399                  <?php
 400              } else {
 401                  ?>
 402                  <p>
 403                      <?php
 404                      printf(
 405                          /* translators: %s: Documentation URL. */
 406                          __( 'You need to make this file writable before you can save your changes. See <a href="%s">Changing File Permissions</a> for more information.' ),
 407                          __( 'https://developer.wordpress.org/advanced-administration/server/file-permissions/' )
 408                      );
 409                      ?>
 410                  </p>
 411                  <?php
 412              }
 413              ?>
 414          </div>
 415  
 416          <?php wp_print_file_editor_templates(); ?>
 417      </form>
 418      <?php
 419  endif; // End if $error.
 420  ?>
 421  <br class="clear" />
 422  </div>
 423  <?php
 424  $dismissed_pointers = explode( ',', (string) get_user_meta( get_current_user_id(), 'dismissed_wp_pointers', true ) );
 425  if ( ! in_array( 'theme_editor_notice', $dismissed_pointers, true ) ) {
 426      // Get a back URL.
 427      $referer = wp_get_referer();
 428  
 429      $excluded_referer_basenames = array( 'theme-editor.php', 'wp-login.php' );
 430  
 431      $return_url = admin_url( '/' );
 432      if ( $referer ) {
 433          $referer_path = parse_url( $referer, PHP_URL_PATH );
 434          if ( is_string( $referer_path ) && ! in_array( basename( $referer_path ), $excluded_referer_basenames, true ) ) {
 435              $return_url = $referer;
 436          }
 437      }
 438      ?>
 439      <div id="file-editor-warning" class="notification-dialog-wrap file-editor-warning hide-if-no-js hidden">
 440          <div class="notification-dialog-background"></div>
 441          <div class="notification-dialog">
 442              <div class="file-editor-warning-content">
 443                  <div class="file-editor-warning-message">
 444                      <h1><?php _e( 'Heads up!' ); ?></h1>
 445                      <p>
 446                          <?php
 447                          _e( 'You appear to be making direct edits to your theme in the WordPress dashboard. It is not recommended! Editing your theme directly could break your site and your changes may be lost in future updates.' );
 448                          ?>
 449                      </p>
 450                          <?php
 451                          if ( ! $theme->parent() ) {
 452                              echo '<p>';
 453                              printf(
 454                                  /* translators: %s: Link to documentation on child themes. */
 455                                  __( 'If you need to tweak more than your theme&#8217;s CSS, you might want to try <a href="%s">making a child theme</a>.' ),
 456                                  esc_url( __( 'https://developer.wordpress.org/themes/advanced-topics/child-themes/' ) )
 457                              );
 458                              echo '</p>';
 459                          }
 460                          ?>
 461                      <p><?php _e( 'If you decide to go ahead with direct edits anyway, 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>
 462                  </div>
 463                  <p>
 464                      <a class="button file-editor-warning-go-back" href="<?php echo esc_url( $return_url ); ?>"><?php _e( 'Go back' ); ?></a>
 465                      <button type="button" class="file-editor-warning-dismiss button button-primary"><?php _e( 'I understand' ); ?></button>
 466                  </p>
 467              </div>
 468          </div>
 469      </div>
 470      <?php
 471  } // Editor warning notice.
 472  
 473  require_once  ABSPATH . 'wp-admin/admin-footer.php';


Generated : Sun Oct 19 08:20:05 2025 Cross-referenced by PHPXref