WordPress PHP Cross Reference Blogging Systems

Source: /wp-admin/options-permalink.php - 268 lines - 15077 bytes - Summary - Text - Print

Description: Permalink Settings Administration Screen.

   1  <?php
   2  /**
   3   * Permalink Settings Administration Screen.
   4   *
   5   * @package WordPress
   6   * @subpackage Administration
   7   */
   8  
   9  /** WordPress Administration Bootstrap */
  10  require_once( dirname( __FILE__ ) . '/admin.php' );
  11  
  12  if ( ! current_user_can( 'manage_options' ) )
  13      wp_die( __( 'Sorry, you are not allowed to manage options for this site.' ) );
  14  
  15  $title = __('Permalink Settings');
  16  $parent_file = 'options-general.php';
  17  
  18  get_current_screen()->add_help_tab( array(
  19      'id'      => 'overview',
  20      'title'   => __('Overview'),
  21      'content' => '<p>' . __('Permalinks are the permanent URLs to your individual pages and blog posts, as well as your category and tag archives. A permalink is the web address used to link to your content. The URL to each post should be permanent, and never change &#8212; hence the name permalink.') . '</p>' .
  22          '<p>' . __( 'This screen allows you to choose your permalink structure. You can choose from common settings or create custom URL structures.' ) . '</p>' .
  23          '<p>' . __('You must click the Save Changes button at the bottom of the screen for new settings to take effect.') . '</p>',
  24  ) );
  25  
  26  get_current_screen()->add_help_tab( array(
  27      'id'      => 'permalink-settings',
  28      'title'   => __('Permalink Settings'),
  29      'content' => '<p>' . __( 'Permalinks can contain useful information, such as the post date, title, or other elements. You can choose from any of the suggested permalink formats, or you can craft your own if you select Custom Structure.' ) . '</p>' .
  30          '<p>' . __( 'If you pick an option other than Plain, your general URL path with structure tags (terms surrounded by <code>%</code>) will also appear in the custom structure field and your path can be further modified there.' ) . '</p>' .
  31          '<p>' . __('When you assign multiple categories or tags to a post, only one can show up in the permalink: the lowest numbered category. This applies if your custom structure includes <code>%category%</code> or <code>%tag%</code>.') . '</p>' .
  32          '<p>' . __('You must click the Save Changes button at the bottom of the screen for new settings to take effect.') . '</p>',
  33  ) );
  34  
  35  get_current_screen()->add_help_tab( array(
  36      'id'      => 'custom-structures',
  37      'title'   => __('Custom Structures'),
  38      'content' => '<p>' . __('The Optional fields let you customize the &#8220;category&#8221; and &#8220;tag&#8221; base names that will appear in archive URLs. For example, the page listing all posts in the &#8220;Uncategorized&#8221; category could be <code>/topics/uncategorized</code> instead of <code>/category/uncategorized</code>.') . '</p>' .
  39          '<p>' . __('You must click the Save Changes button at the bottom of the screen for new settings to take effect.') . '</p>',
  40  ) );
  41  
  42  get_current_screen()->set_help_sidebar(
  43      '<p><strong>' . __('For more information:') . '</strong></p>' .
  44      '<p>' . __('<a href="https://codex.wordpress.org/Settings_Permalinks_Screen" target="_blank">Documentation on Permalinks Settings</a>') . '</p>' .
  45      '<p>' . __('<a href="https://codex.wordpress.org/Using_Permalinks" target="_blank">Documentation on Using Permalinks</a>') . '</p>' .
  46      '<p>' . __('<a href="https://wordpress.org/support/" target="_blank">Support Forums</a>') . '</p>'
  47  );
  48  
  49  add_filter('admin_head', 'options_permalink_add_js');
  50  
  51  $home_path = get_home_path();
  52  $iis7_permalinks = iis7_supports_permalinks();
  53  $permalink_structure = get_option( 'permalink_structure' );
  54  
  55  $prefix = $blog_prefix = '';
  56  if ( ! got_url_rewrite() )
  57      $prefix = '/index.php';
  58  
  59  /**
  60   * In a subdirectory configuration of multisite, the `/blog` prefix is used by
  61   * default on the main site to avoid collisions with other sites created on that
  62   * network. If the `permalink_structure` option has been changed to remove this
  63   * base prefix, WordPress core can no longer account for the possible collision.
  64   */
  65  if ( is_multisite() && ! is_subdomain_install() && is_main_site() && 0 === strpos( $permalink_structure, '/blog/' ) ) {
  66      $blog_prefix = '/blog';
  67  }
  68  
  69  $category_base       = get_option( 'category_base' );
  70  $tag_base            = get_option( 'tag_base' );
  71  $update_required     = false;
  72  
  73  if ( $iis7_permalinks ) {
  74      if ( ( ! file_exists($home_path . 'web.config') && win_is_writable($home_path) ) || win_is_writable($home_path . 'web.config') )
  75          $writable = true;
  76      else
  77          $writable = false;
  78  } elseif ( $is_nginx ) {
  79      $writable = false;
  80  } else {
  81      if ( ( ! file_exists( $home_path . '.htaccess' ) && is_writable( $home_path ) ) || is_writable( $home_path . '.htaccess' ) ) {
  82          $writable = true;
  83      } else {
  84          $writable = false;
  85          $existing_rules  = array_filter( extract_from_markers( $home_path . '.htaccess', 'WordPress' ) );
  86          $new_rules       = array_filter( explode( "\n", $wp_rewrite->mod_rewrite_rules() ) );
  87          $update_required = ( $new_rules !== $existing_rules );
  88      }
  89  }
  90  
  91  $using_index_permalinks = $wp_rewrite->using_index_permalinks();
  92  
  93  if ( isset($_POST['permalink_structure']) || isset($_POST['category_base']) ) {
  94      check_admin_referer('update-permalink');
  95  
  96      if ( isset( $_POST['permalink_structure'] ) ) {
  97          if ( isset( $_POST['selection'] ) && 'custom' != $_POST['selection'] )
  98              $permalink_structure = $_POST['selection'];
  99          else
 100              $permalink_structure = $_POST['permalink_structure'];
 101  
 102          if ( ! empty( $permalink_structure ) ) {
 103              $permalink_structure = preg_replace( '#/+#', '/', '/' . str_replace( '#', '', $permalink_structure ) );
 104              if ( $prefix && $blog_prefix )
 105                  $permalink_structure = $prefix . preg_replace( '#^/?index\.php#', '', $permalink_structure );
 106              else
 107                  $permalink_structure = $blog_prefix . $permalink_structure;
 108          }
 109  
 110          $permalink_structure = sanitize_option( 'permalink_structure', $permalink_structure );
 111  
 112          $wp_rewrite->set_permalink_structure( $permalink_structure );
 113      }
 114  
 115      if ( isset( $_POST['category_base'] ) ) {
 116          $category_base = $_POST['category_base'];
 117          if ( ! empty( $category_base ) )
 118              $category_base = $blog_prefix . preg_replace('#/+#', '/', '/' . str_replace( '#', '', $category_base ) );
 119          $wp_rewrite->set_category_base( $category_base );
 120      }
 121  
 122      if ( isset( $_POST['tag_base'] ) ) {
 123          $tag_base = $_POST['tag_base'];
 124          if ( ! empty( $tag_base ) )
 125              $tag_base = $blog_prefix . preg_replace('#/+#', '/', '/' . str_replace( '#', '', $tag_base ) );
 126          $wp_rewrite->set_tag_base( $tag_base );
 127      }
 128  
 129      $message = __( 'Permalink structure updated.' );
 130  
 131      if ( $iis7_permalinks ) {
 132          if ( $permalink_structure && ! $using_index_permalinks && ! $writable ) {
 133              $message = __( 'You should update your web.config now.' );
 134          } elseif ( $permalink_structure && ! $using_index_permalinks && $writable ) {
 135              $message = __( 'Permalink structure updated. Remove write access on web.config file now!' );
 136          }
 137      } elseif ( ! $is_nginx && $permalink_structure && ! $using_index_permalinks && ! $writable && $update_required ) {
 138          $message = __( 'You should update your .htaccess now.' );
 139      }
 140  
 141      if ( ! get_settings_errors() ) {
 142          add_settings_error( 'general', 'settings_updated', $message, 'updated' );
 143      }
 144  
 145      set_transient( 'settings_errors', get_settings_errors(), 30 );
 146  
 147      wp_redirect( admin_url( 'options-permalink.php?settings-updated=true' ) );
 148      exit;
 149  }
 150  
 151  flush_rewrite_rules();
 152  
 153  require ( ABSPATH . 'wp-admin/admin-header.php' );
 154  ?>
 155  <div class="wrap">
 156  <h1><?php echo esc_html( $title ); ?></h1>
 157  
 158  <form name="form" action="options-permalink.php" method="post">
 159  <?php wp_nonce_field('update-permalink') ?>
 160  
 161    <p><?php _e( 'WordPress offers you the ability to create a custom URL structure for your permalinks and archives. Custom URL structures can improve the aesthetics, usability, and forward-compatibility of your links. A <a href="https://codex.wordpress.org/Using_Permalinks">number of tags are available</a>, and here are some examples to get you started.' ); ?></p>
 162  
 163  <?php
 164  if ( is_multisite() && ! is_subdomain_install() && is_main_site() && 0 === strpos( $permalink_structure, '/blog/' ) ) {
 165      $permalink_structure = preg_replace( '|^/?blog|', '', $permalink_structure );
 166      $category_base = preg_replace( '|^/?blog|', '', $category_base );
 167      $tag_base = preg_replace( '|^/?blog|', '', $tag_base );
 168  }
 169  
 170  $structures = array(
 171      0 => '',
 172      1 => $prefix . '/%year%/%monthnum%/%day%/%postname%/',
 173      2 => $prefix . '/%year%/%monthnum%/%postname%/',
 174      3 => $prefix . '/' . _x( 'archives', 'sample permalink base' ) . '/%post_id%',
 175      4 => $prefix . '/%postname%/',
 176  );
 177  ?>
 178  <h2 class="title"><?php _e('Common Settings'); ?></h2>
 179  <table class="form-table permalink-structure">
 180      <tr>
 181          <th><label><input name="selection" type="radio" value="" <?php checked('', $permalink_structure); ?> /> <?php _e( 'Plain' ); ?></label></th>
 182          <td><code><?php echo get_option('home'); ?>/?p=123</code></td>
 183      </tr>
 184      <tr>
 185          <th><label><input name="selection" type="radio" value="<?php echo esc_attr($structures[1]); ?>" <?php checked($structures[1], $permalink_structure); ?> /> <?php _e('Day and name'); ?></label></th>
 186          <td><code><?php echo get_option('home') . $blog_prefix . $prefix . '/' . date('Y') . '/' . date('m') . '/' . date('d') . '/' . _x( 'sample-post', 'sample permalink structure' ) . '/'; ?></code></td>
 187      </tr>
 188      <tr>
 189          <th><label><input name="selection" type="radio" value="<?php echo esc_attr($structures[2]); ?>" <?php checked($structures[2], $permalink_structure); ?> /> <?php _e('Month and name'); ?></label></th>
 190          <td><code><?php echo get_option('home') . $blog_prefix . $prefix . '/' . date('Y') . '/' . date('m') . '/' . _x( 'sample-post', 'sample permalink structure' ) . '/'; ?></code></td>
 191      </tr>
 192      <tr>
 193          <th><label><input name="selection" type="radio" value="<?php echo esc_attr($structures[3]); ?>" <?php checked($structures[3], $permalink_structure); ?> /> <?php _e('Numeric'); ?></label></th>
 194          <td><code><?php echo get_option('home') . $blog_prefix . $prefix . '/' . _x( 'archives', 'sample permalink base' ) . '/123'; ?></code></td>
 195      </tr>
 196      <tr>
 197          <th><label><input name="selection" type="radio" value="<?php echo esc_attr($structures[4]); ?>" <?php checked($structures[4], $permalink_structure); ?> /> <?php _e('Post name'); ?></label></th>
 198          <td><code><?php echo get_option('home') . $blog_prefix . $prefix . '/' . _x( 'sample-post', 'sample permalink structure' ) . '/'; ?></code></td>
 199      </tr>
 200      <tr>
 201          <th>
 202              <label><input name="selection" id="custom_selection" type="radio" value="custom" <?php checked( !in_array($permalink_structure, $structures) ); ?> />
 203              <?php _e('Custom Structure'); ?>
 204              </label>
 205          </th>
 206          <td>
 207              <code><?php echo get_option('home') . $blog_prefix; ?></code>
 208              <input name="permalink_structure" id="permalink_structure" type="text" value="<?php echo esc_attr($permalink_structure); ?>" class="regular-text code" />
 209          </td>
 210      </tr>
 211  </table>
 212  
 213  <h2 class="title"><?php _e('Optional'); ?></h2>
 214  <p><?php
 215  /* translators: %s is a placeholder that must come at the start of the URL. */
 216  printf( __( 'If you like, you may enter custom structures for your category and tag URLs here. For example, using <code>topics</code> as your category base would make your category links like <code>%s/topics/uncategorized/</code>. If you leave these blank the defaults will be used.' ), get_option( 'home' ) . $blog_prefix . $prefix ); ?></p>
 217  
 218  <table class="form-table">
 219      <tr>
 220          <th><label for="category_base"><?php /* translators: prefix for category permalinks */ _e('Category base'); ?></label></th>
 221          <td><?php echo $blog_prefix; ?> <input name="category_base" id="category_base" type="text" value="<?php echo esc_attr( $category_base ); ?>" class="regular-text code" /></td>
 222      </tr>
 223      <tr>
 224          <th><label for="tag_base"><?php _e('Tag base'); ?></label></th>
 225          <td><?php echo $blog_prefix; ?> <input name="tag_base" id="tag_base" type="text" value="<?php echo esc_attr($tag_base); ?>" class="regular-text code" /></td>
 226      </tr>
 227      <?php do_settings_fields('permalink', 'optional'); ?>
 228  </table>
 229  
 230  <?php do_settings_sections('permalink'); ?>
 231  
 232  <?php submit_button(); ?>
 233    </form>
 234  <?php if ( !is_multisite() ) { ?>
 235  <?php if ( $iis7_permalinks ) :
 236      if ( isset($_POST['submit']) && $permalink_structure && ! $using_index_permalinks && ! $writable ) :
 237          if ( file_exists($home_path . 'web.config') ) : ?>
 238  <p><?php _e('If your <code>web.config</code> file were <a href="https://codex.wordpress.org/Changing_File_Permissions">writable</a>, we could do this automatically, but it isn&#8217;t so this is the url rewrite rule you should have in your <code>web.config</code> file. Click in the field and press <kbd>CTRL + a</kbd> to select all. Then insert this rule inside of the <code>/&lt;configuration&gt;/&lt;system.webServer&gt;/&lt;rewrite&gt;/&lt;rules&gt;</code> element in <code>web.config</code> file.') ?></p>
 239  <form action="options-permalink.php" method="post">
 240  <?php wp_nonce_field('update-permalink') ?>
 241      <p><textarea rows="9" class="large-text readonly" name="rules" id="rules" readonly="readonly"><?php echo esc_textarea( $wp_rewrite->iis7_url_rewrite_rules() ); ?></textarea></p>
 242  </form>
 243  <p><?php _e('If you temporarily make your <code>web.config</code> file writable for us to generate rewrite rules automatically, do not forget to revert the permissions after rule has been saved.') ?></p>
 244          <?php else : ?>
 245  <p><?php _e('If the root directory of your site were <a href="https://codex.wordpress.org/Changing_File_Permissions">writable</a>, we could do this automatically, but it isn&#8217;t so this is the url rewrite rule you should have in your <code>web.config</code> file. Create a new file, called <code>web.config</code> in the root directory of your site. Click in the field and press <kbd>CTRL + a</kbd> to select all. Then insert this code into the <code>web.config</code> file.') ?></p>
 246  <form action="options-permalink.php" method="post">
 247  <?php wp_nonce_field('update-permalink') ?>
 248      <p><textarea rows="18" class="large-text readonly" name="rules" id="rules" readonly="readonly"><?php echo esc_textarea( $wp_rewrite->iis7_url_rewrite_rules(true) ); ?></textarea></p>
 249  </form>
 250  <p><?php _e('If you temporarily make your site&#8217;s root directory writable for us to generate the <code>web.config</code> file automatically, do not forget to revert the permissions after the file has been created.') ?></p>
 251          <?php endif; ?>
 252      <?php endif; ?>
 253  <?php elseif ( $is_nginx ) : ?>
 254      <p><?php _e( '<a href="https://codex.wordpress.org/Nginx">Documentation on Nginx configuration</a>.' ); ?></p>
 255  <?php else:
 256      if ( $permalink_structure && ! $using_index_permalinks && ! $writable && $update_required ) : ?>
 257  <p><?php _e('If your <code>.htaccess</code> file were <a href="https://codex.wordpress.org/Changing_File_Permissions">writable</a>, we could do this automatically, but it isn&#8217;t so these are the mod_rewrite rules you should have in your <code>.htaccess</code> file. Click in the field and press <kbd>CTRL + a</kbd> to select all.') ?></p>
 258  <form action="options-permalink.php" method="post">
 259  <?php wp_nonce_field('update-permalink') ?>
 260      <p><textarea rows="6" class="large-text readonly" name="rules" id="rules" readonly="readonly"><?php echo esc_textarea( $wp_rewrite->mod_rewrite_rules() ); ?></textarea></p>
 261  </form>
 262      <?php endif; ?>
 263  <?php endif; ?>
 264  <?php } // multisite ?>
 265  
 266  </div>
 267  
 268  <?php require ( ABSPATH . 'wp-admin/admin-footer.php' ); ?>

title

Description

title

Description

title

Description

title

title

Body