[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-admin/ -> options-permalink.php (source)

   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  
  16  $title       = __( 'Permalink Settings' );
  17  $parent_file = 'options-general.php';
  18  
  19  get_current_screen()->add_help_tab(
  20      array(
  21          'id'      => 'overview',
  22          'title'   => __( 'Overview' ),
  23          '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>' .
  24              '<p>' . __( 'This screen allows you to choose your permalink structure. You can choose from common settings or create custom URL structures.' ) . '</p>' .
  25              '<p>' . __( 'You must click the Save Changes button at the bottom of the screen for new settings to take effect.' ) . '</p>',
  26      )
  27  );
  28  
  29  get_current_screen()->add_help_tab(
  30      array(
  31          'id'      => 'permalink-settings',
  32          'title'   => __( 'Permalink Settings' ),
  33          '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>' .
  34              '<p>' . sprintf(
  35                  /* translators: '%' character. */
  36                  __( 'If you pick an option other than Plain, your general URL path with structure tags (terms surrounded by %s) will also appear in the custom structure field and your path can be further modified there.' ),
  37                  '<code>%</code>'
  38              ) . '</p>' .
  39              '<p>' . sprintf(
  40                  /* translators: 1: %category%, 2: %tag% */
  41                  __( '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 %1$s or %2$s.' ),
  42                  '<code>%category%</code>',
  43                  '<code>%tag%</code>'
  44              ) . '</p>' .
  45              '<p>' . __( 'You must click the Save Changes button at the bottom of the screen for new settings to take effect.' ) . '</p>',
  46      )
  47  );
  48  
  49  get_current_screen()->add_help_tab(
  50      array(
  51          'id'      => 'custom-structures',
  52          'title'   => __( 'Custom Structures' ),
  53          '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>' .
  54              '<p>' . __( 'You must click the Save Changes button at the bottom of the screen for new settings to take effect.' ) . '</p>',
  55      )
  56  );
  57  
  58  get_current_screen()->set_help_sidebar(
  59      '<p><strong>' . __( 'For more information:' ) . '</strong></p>' .
  60      '<p>' . __( '<a href="https://wordpress.org/support/article/settings-permalinks-screen/">Documentation on Permalinks Settings</a>' ) . '</p>' .
  61      '<p>' . __( '<a href="https://wordpress.org/support/article/using-permalinks/">Documentation on Using Permalinks</a>' ) . '</p>' .
  62      '<p>' . __( '<a href="https://wordpress.org/support/">Support</a>' ) . '</p>'
  63  );
  64  
  65  $home_path           = get_home_path();
  66  $iis7_permalinks     = iis7_supports_permalinks();
  67  $permalink_structure = get_option( 'permalink_structure' );
  68  
  69  $prefix      = '';
  70  $blog_prefix = '';
  71  if ( ! got_url_rewrite() ) {
  72      $prefix = '/index.php';
  73  }
  74  
  75  /**
  76   * In a subdirectory configuration of multisite, the `/blog` prefix is used by
  77   * default on the main site to avoid collisions with other sites created on that
  78   * network. If the `permalink_structure` option has been changed to remove this
  79   * base prefix, WordPress core can no longer account for the possible collision.
  80   */
  81  if ( is_multisite() && ! is_subdomain_install() && is_main_site() && 0 === strpos( $permalink_structure, '/blog/' ) ) {
  82      $blog_prefix = '/blog';
  83  }
  84  
  85  $category_base   = get_option( 'category_base' );
  86  $tag_base        = get_option( 'tag_base' );
  87  $update_required = false;
  88  
  89  if ( $iis7_permalinks ) {
  90      if ( ( ! file_exists( $home_path . 'web.config' ) && win_is_writable( $home_path ) ) || win_is_writable( $home_path . 'web.config' ) ) {
  91          $writable = true;
  92      } else {
  93          $writable = false;
  94      }
  95  } elseif ( $is_nginx ) {
  96      $writable = false;
  97  } else {
  98      if ( ( ! file_exists( $home_path . '.htaccess' ) && is_writable( $home_path ) ) || is_writable( $home_path . '.htaccess' ) ) {
  99          $writable = true;
 100      } else {
 101          $writable        = false;
 102          $existing_rules  = array_filter( extract_from_markers( $home_path . '.htaccess', 'WordPress' ) );
 103          $new_rules       = array_filter( explode( "\n", $wp_rewrite->mod_rewrite_rules() ) );
 104          $update_required = ( $new_rules !== $existing_rules );
 105      }
 106  }
 107  
 108  $using_index_permalinks = $wp_rewrite->using_index_permalinks();
 109  
 110  if ( isset( $_POST['permalink_structure'] ) || isset( $_POST['category_base'] ) ) {
 111      check_admin_referer( 'update-permalink' );
 112  
 113      if ( isset( $_POST['permalink_structure'] ) ) {
 114          if ( isset( $_POST['selection'] ) && 'custom' != $_POST['selection'] ) {
 115              $permalink_structure = $_POST['selection'];
 116          } else {
 117              $permalink_structure = $_POST['permalink_structure'];
 118          }
 119  
 120          if ( ! empty( $permalink_structure ) ) {
 121              $permalink_structure = preg_replace( '#/+#', '/', '/' . str_replace( '#', '', $permalink_structure ) );
 122              if ( $prefix && $blog_prefix ) {
 123                  $permalink_structure = $prefix . preg_replace( '#^/?index\.php#', '', $permalink_structure );
 124              } else {
 125                  $permalink_structure = $blog_prefix . $permalink_structure;
 126              }
 127          }
 128  
 129          $permalink_structure = sanitize_option( 'permalink_structure', $permalink_structure );
 130  
 131          $wp_rewrite->set_permalink_structure( $permalink_structure );
 132      }
 133  
 134      if ( isset( $_POST['category_base'] ) ) {
 135          $category_base = $_POST['category_base'];
 136          if ( ! empty( $category_base ) ) {
 137              $category_base = $blog_prefix . preg_replace( '#/+#', '/', '/' . str_replace( '#', '', $category_base ) );
 138          }
 139          $wp_rewrite->set_category_base( $category_base );
 140      }
 141  
 142      if ( isset( $_POST['tag_base'] ) ) {
 143          $tag_base = $_POST['tag_base'];
 144          if ( ! empty( $tag_base ) ) {
 145              $tag_base = $blog_prefix . preg_replace( '#/+#', '/', '/' . str_replace( '#', '', $tag_base ) );
 146          }
 147          $wp_rewrite->set_tag_base( $tag_base );
 148      }
 149  
 150      $message = __( 'Permalink structure updated.' );
 151  
 152      if ( $iis7_permalinks ) {
 153          if ( $permalink_structure && ! $using_index_permalinks && ! $writable ) {
 154              $message = __( 'You should update your web.config now.' );
 155          } elseif ( $permalink_structure && ! $using_index_permalinks && $writable ) {
 156              $message = __( 'Permalink structure updated. Remove write access on web.config file now!' );
 157          }
 158      } elseif ( ! $is_nginx && $permalink_structure && ! $using_index_permalinks && ! $writable && $update_required ) {
 159          $message = __( 'You should update your .htaccess now.' );
 160      }
 161  
 162      if ( ! get_settings_errors() ) {
 163          add_settings_error( 'general', 'settings_updated', $message, 'success' );
 164      }
 165  
 166      set_transient( 'settings_errors', get_settings_errors(), 30 );
 167  
 168      wp_redirect( admin_url( 'options-permalink.php?settings-updated=true' ) );
 169      exit;
 170  }
 171  
 172  flush_rewrite_rules();
 173  
 174  require( ABSPATH . 'wp-admin/admin-header.php' );
 175  ?>
 176  <div class="wrap">
 177  <h1><?php echo esc_html( $title ); ?></h1>
 178  
 179  <form name="form" action="options-permalink.php" method="post">
 180  <?php wp_nonce_field( 'update-permalink' ); ?>
 181  
 182      <p>
 183      <?php
 184          printf(
 185              /* translators: %s: Documentation URL. */
 186              __( '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="%s">number of tags are available</a>, and here are some examples to get you started.' ),
 187              __( 'https://wordpress.org/support/article/using-permalinks/' )
 188          );
 189          ?>
 190      </p>
 191  
 192  <?php
 193  if ( is_multisite() && ! is_subdomain_install() && is_main_site() && 0 === strpos( $permalink_structure, '/blog/' ) ) {
 194      $permalink_structure = preg_replace( '|^/?blog|', '', $permalink_structure );
 195      $category_base       = preg_replace( '|^/?blog|', '', $category_base );
 196      $tag_base            = preg_replace( '|^/?blog|', '', $tag_base );
 197  }
 198  
 199  $structures = array(
 200      0 => '',
 201      1 => $prefix . '/%year%/%monthnum%/%day%/%postname%/',
 202      2 => $prefix . '/%year%/%monthnum%/%postname%/',
 203      3 => $prefix . '/' . _x( 'archives', 'sample permalink base' ) . '/%post_id%',
 204      4 => $prefix . '/%postname%/',
 205  );
 206  ?>
 207  <h2 class="title"><?php _e( 'Common Settings' ); ?></h2>
 208  <table class="form-table permalink-structure">
 209      <tr>
 210          <th scope="row"><label><input name="selection" type="radio" value="" <?php checked( '', $permalink_structure ); ?> /> <?php _e( 'Plain' ); ?></label></th>
 211          <td><code><?php echo get_option( 'home' ); ?>/?p=123</code></td>
 212      </tr>
 213      <tr>
 214          <th scope="row"><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>
 215          <td><code><?php echo get_option( 'home' ) . $blog_prefix . $prefix . '/' . gmdate( 'Y' ) . '/' . gmdate( 'm' ) . '/' . gmdate( 'd' ) . '/' . _x( 'sample-post', 'sample permalink structure' ) . '/'; ?></code></td>
 216      </tr>
 217      <tr>
 218          <th scope="row"><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>
 219          <td><code><?php echo get_option( 'home' ) . $blog_prefix . $prefix . '/' . gmdate( 'Y' ) . '/' . gmdate( 'm' ) . '/' . _x( 'sample-post', 'sample permalink structure' ) . '/'; ?></code></td>
 220      </tr>
 221      <tr>
 222          <th scope="row"><label><input name="selection" type="radio" value="<?php echo esc_attr( $structures[3] ); ?>" <?php checked( $structures[3], $permalink_structure ); ?> /> <?php _e( 'Numeric' ); ?></label></th>
 223          <td><code><?php echo get_option( 'home' ) . $blog_prefix . $prefix . '/' . _x( 'archives', 'sample permalink base' ) . '/123'; ?></code></td>
 224      </tr>
 225      <tr>
 226          <th scope="row"><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>
 227          <td><code><?php echo get_option( 'home' ) . $blog_prefix . $prefix . '/' . _x( 'sample-post', 'sample permalink structure' ) . '/'; ?></code></td>
 228      </tr>
 229      <tr>
 230          <th scope="row">
 231              <label><input name="selection" id="custom_selection" type="radio" value="custom" <?php checked( ! in_array( $permalink_structure, $structures ) ); ?> />
 232              <?php _e( 'Custom Structure' ); ?>
 233              </label>
 234          </th>
 235          <td>
 236              <code><?php echo get_option( 'home' ) . $blog_prefix; ?></code>
 237              <input name="permalink_structure" id="permalink_structure" type="text" value="<?php echo esc_attr( $permalink_structure ); ?>" class="regular-text code" />
 238              <div class="available-structure-tags hide-if-no-js">
 239                  <div id="custom_selection_updated" aria-live="assertive" class="screen-reader-text"></div>
 240                  <?php
 241                  $available_tags = array(
 242                      /* translators: %s: Permalink structure tag. */
 243                      'year'     => __( '%s (The year of the post, four digits, for example 2004.)' ),
 244                      /* translators: %s: Permalink structure tag. */
 245                      'monthnum' => __( '%s (Month of the year, for example 05.)' ),
 246                      /* translators: %s: Permalink structure tag. */
 247                      'day'      => __( '%s (Day of the month, for example 28.)' ),
 248                      /* translators: %s: Permalink structure tag. */
 249                      'hour'     => __( '%s (Hour of the day, for example 15.)' ),
 250                      /* translators: %s: Permalink structure tag. */
 251                      'minute'   => __( '%s (Minute of the hour, for example 43.)' ),
 252                      /* translators: %s: Permalink structure tag. */
 253                      'second'   => __( '%s (Second of the minute, for example 33.)' ),
 254                      /* translators: %s: Permalink structure tag. */
 255                      'post_id'  => __( '%s (The unique ID of the post, for example 423.)' ),
 256                      /* translators: %s: Permalink structure tag. */
 257                      'postname' => __( '%s (The sanitized post title (slug).)' ),
 258                      /* translators: %s: Permalink structure tag. */
 259                      'category' => __( '%s (Category slug. Nested sub-categories appear as nested directories in the URL.)' ),
 260                      /* translators: %s: Permalink structure tag. */
 261                      'author'   => __( '%s (A sanitized version of the author name.)' ),
 262                  );
 263  
 264                  /**
 265                   * Filters the list of available permalink structure tags on the Permalinks settings page.
 266                   *
 267                   * @since 4.8.0
 268                   *
 269                   * @param string[] $available_tags An array of key => value pairs of available permalink structure tags.
 270                   */
 271                  $available_tags = apply_filters( 'available_permalink_structure_tags', $available_tags );
 272  
 273                  /* translators: %s: Permalink structure tag. */
 274                  $structure_tag_added = __( '%s added to permalink structure' );
 275  
 276                  /* translators: %s: Permalink structure tag. */
 277                  $structure_tag_already_used = __( '%s (already used in permalink structure)' );
 278  
 279                  if ( ! empty( $available_tags ) ) :
 280                      ?>
 281                      <p><?php _e( 'Available tags:' ); ?></p>
 282                      <ul role="list">
 283                          <?php
 284                          foreach ( $available_tags as $tag => $explanation ) {
 285                              ?>
 286                              <li>
 287                                  <button type="button"
 288                                          class="button button-secondary"
 289                                          aria-label="<?php echo esc_attr( sprintf( $explanation, $tag ) ); ?>"
 290                                          data-added="<?php echo esc_attr( sprintf( $structure_tag_added, $tag ) ); ?>"
 291                                          data-used="<?php echo esc_attr( sprintf( $structure_tag_already_used, $tag ) ); ?>">
 292                                      <?php echo '%' . $tag . '%'; ?>
 293                                  </button>
 294                              </li>
 295                              <?php
 296                          }
 297                          ?>
 298                      </ul>
 299                  <?php endif; ?>
 300              </div>
 301          </td>
 302      </tr>
 303  </table>
 304  
 305  <h2 class="title"><?php _e( 'Optional' ); ?></h2>
 306  <p>
 307  <?php
 308  /* translators: %s: Placeholder that must come at the start of the URL. */
 309  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 );
 310  ?>
 311  </p>
 312  
 313  <table class="form-table" role="presentation">
 314      <tr>
 315          <th><label for="category_base"><?php /* translators: Prefix for category permalinks. */ _e( 'Category base' ); ?></label></th>
 316          <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>
 317      </tr>
 318      <tr>
 319          <th><label for="tag_base"><?php _e( 'Tag base' ); ?></label></th>
 320          <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>
 321      </tr>
 322      <?php do_settings_fields( 'permalink', 'optional' ); ?>
 323  </table>
 324  
 325  <?php do_settings_sections( 'permalink' ); ?>
 326  
 327  <?php submit_button(); ?>
 328  </form>
 329  <?php if ( ! is_multisite() ) { ?>
 330      <?php
 331      if ( $iis7_permalinks ) :
 332          if ( isset( $_POST['submit'] ) && $permalink_structure && ! $using_index_permalinks && ! $writable ) :
 333              if ( file_exists( $home_path . 'web.config' ) ) :
 334                  ?>
 335  <p>
 336                  <?php
 337                  printf(
 338                      /* translators: 1: web.config, 2: Documentation URL, 3: CTRL + a, 4: Element code. */
 339                      __( 'If your %1$s file was <a href="%2$s">writable</a>, we could do this automatically, but it isn&#8217;t so this is the url rewrite rule you should have in your %1$s file. Click in the field and press %3$s to select all. Then insert this rule inside of the %4$s element in %1$s file.' ),
 340                      '<code>web.config</code>',
 341                      __( 'https://wordpress.org/support/article/changing-file-permissions/' ),
 342                      '<kbd>CTRL + a</kbd>',
 343                      '<code>/&lt;configuration&gt;/&lt;system.webServer&gt;/&lt;rewrite&gt;/&lt;rules&gt;</code>'
 344                  );
 345                  ?>
 346  </p>
 347  <form action="options-permalink.php" method="post">
 348                  <?php wp_nonce_field( 'update-permalink' ); ?>
 349      <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>
 350  </form>
 351  <p>
 352                  <?php
 353                  printf(
 354                      /* translators: %s: web.config */
 355                      __( 'If you temporarily make your %s file writable for us to generate rewrite rules automatically, do not forget to revert the permissions after rule has been saved.' ),
 356                      '<code>web.config</code>'
 357                  );
 358                  ?>
 359  </p>
 360          <?php else : ?>
 361  <p>
 362              <?php
 363              printf(
 364                  /* translators: 1: Documentation URL, 2: web.config, 3: CTRL + a */
 365                  __( 'If the root directory of your site was <a href="%1$s">writable</a>, we could do this automatically, but it isn&#8217;t so this is the url rewrite rule you should have in your %2$s file. Create a new file, called %2$s in the root directory of your site. Click in the field and press %3$s to select all. Then insert this code into the %2$s file.' ),
 366                  __( 'https://wordpress.org/support/article/changing-file-permissions/' ),
 367                  '<code>web.config</code>',
 368                  '<kbd>CTRL + a</kbd>'
 369              );
 370              ?>
 371  </p>
 372  <form action="options-permalink.php" method="post">
 373              <?php wp_nonce_field( 'update-permalink' ); ?>
 374      <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>
 375  </form>
 376  <p>
 377              <?php
 378              printf(
 379                  /* translators: %s: web.config */
 380                  __( 'If you temporarily make your site&#8217;s root directory writable for us to generate the %s file automatically, do not forget to revert the permissions after the file has been created.' ),
 381                  '<code>web.config</code>'
 382              );
 383              ?>
 384  </p>
 385          <?php endif; ?>
 386      <?php endif; ?>
 387  <?php elseif ( $is_nginx ) : ?>
 388      <p><?php _e( '<a href="https://wordpress.org/support/article/nginx/">Documentation on Nginx configuration</a>.' ); ?></p>
 389      <?php
 390  else :
 391      if ( $permalink_structure && ! $using_index_permalinks && ! $writable && $update_required ) :
 392          ?>
 393  <p>
 394          <?php
 395          printf(
 396              /* translators: 1: .htaccess, 2: Documentation URL, 3: CTRL + a */
 397              __( 'If your %1$s file was <a href="%2$s">writable</a>, we could do this automatically, but it isn&#8217;t so these are the mod_rewrite rules you should have in your %1$s file. Click in the field and press %3$s to select all.' ),
 398              '<code>.htaccess</code>',
 399              __( 'https://wordpress.org/support/article/changing-file-permissions/' ),
 400              '<kbd>CTRL + a</kbd>'
 401          );
 402          ?>
 403  </p>
 404  <form action="options-permalink.php" method="post">
 405          <?php wp_nonce_field( 'update-permalink' ); ?>
 406      <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>
 407  </form>
 408      <?php endif; ?>
 409  <?php endif; ?>
 410  <?php } // multisite ?>
 411  
 412  </div>
 413  
 414  <?php require( ABSPATH . 'wp-admin/admin-footer.php' ); ?>


Generated: Thu Sep 19 01:00:03 2019 Cross-referenced by PHPXref 0.7.1