3 * Rewrite API: WP_Rewrite class
11 * Core class used to implement a rewrite component API.
13 * The WordPress Rewrite class writes the rewrite module rules to the .htaccess
14 * file. It also handles parsing the request to get the correct setup for the
15 * WordPress Query class.
17 * The Rewrite along with WP class function as a front controller for WordPress.
18 * You can add rules to trigger your page view and processing using this
19 * component. The full functionality of a front controller does not exist,
20 * meaning you can't define how the template files load based on the rewrite
27 * Permalink structure for posts.
32 public $permalink_structure;
35 * Whether to add trailing slashes.
40 public $use_trailing_slashes;
43 * Base for the author permalink structure (example.com/$author_base/authorname).
49 var $author_base = 'author';
52 * Permalink structure for author archives.
58 var $author_structure;
61 * Permalink structure for date archives.
70 * Permalink structure for pages.
79 * Base of the search permalink structure (example.com/$search_base/query).
85 var $search_base = 'search';
88 * Permalink structure for searches.
94 var $search_structure;
97 * Comments permalink base.
103 var $comments_base = 'comments';
106 * Pagination permalink base.
111 public $pagination_base = 'page';
114 * Comments pagination permalink base.
120 var $comments_pagination_base = 'comment-page';
123 * Feed permalink base.
129 var $feed_base = 'feed';
132 * Comments feed permalink structure.
138 var $comment_feed_structure;
141 * Feed request permalink structure.
150 * The static portion of the post permalink structure.
152 * If the permalink structure is "/archive/%post_id%" then the front
153 * is "/archive/". If the permalink structure is "/%year%/%postname%/"
154 * then the front is "/".
160 * @see WP_Rewrite::init()
165 * The prefix for all permalink structures.
167 * If PATHINFO/index permalinks are in use then the root is the value of
168 * `WP_Rewrite::$index` with a trailing slash appended. Otherwise the root
175 * @see WP_Rewrite::init()
176 * @see WP_Rewrite::using_index_permalinks()
181 * The name of the index file which is the entry point to all requests.
187 public $index = 'index.php';
190 * Variable name to use for regex matches in the rewritten query.
199 * Rewrite rules to match against the request to find the redirect or query.
208 * Additional rules added external to the rewrite class.
210 * Those not generated by the class, see add_rewrite_rule().
216 var $extra_rules = array();
219 * Additional rules that belong at the beginning to match first.
221 * Those not generated by the class, see add_rewrite_rule().
227 var $extra_rules_top = array();
230 * Rules that don't redirect to WordPress' index.php.
232 * These rules are written to the mod_rewrite portion of the .htaccess,
233 * and are added by add_external_rule().
239 var $non_wp_rules = array();
242 * Extra permalink structures, e.g. categories, added by add_permastruct().
248 var $extra_permastructs = array();
251 * Endpoints (like /trackback/) added by add_rewrite_endpoint().
260 * Whether to write every mod_rewrite rule for WordPress into the .htaccess file.
262 * This is off by default, turning it on might print a lot of rewrite rules
263 * to the .htaccess file.
269 * @see WP_Rewrite::mod_rewrite_rules()
271 public $use_verbose_rules = false;
274 * Could post permalinks be confused with those of pages?
276 * If the first rewrite tag in the post permalink structure is one that could
277 * also match a page name (e.g. %postname% or %author%) then this flag is
278 * set to true. Prior to WordPress 3.3 this flag indicated that every page
279 * would have a set of rules added to the top of the rewrite rules array.
280 * Now it tells WP::parse_request() to check if a URL matching the page
281 * permastruct is actually a page before accepting it.
287 * @see WP_Rewrite::init()
289 public $use_verbose_page_rules = true;
292 * Rewrite tags that can be used in permalink structures.
294 * These are translated into the regular expressions stored in
295 * `WP_Rewrite::$rewritereplace` and are rewritten to the query
296 * variables listed in WP_Rewrite::$queryreplace.
298 * Additional tags can be added with add_rewrite_tag().
304 var $rewritecode = array(
319 * Regular expressions to be substituted into rewrite rules in place
320 * of rewrite tags, see WP_Rewrite::$rewritecode.
326 var $rewritereplace = array(
341 * Query variables that rewrite tags map to, see WP_Rewrite::$rewritecode.
347 var $queryreplace = array(
362 * Supported default feeds.
367 public $feeds = array( 'feed', 'rdf', 'rss', 'rss2', 'atom' );
370 * Determines whether permalinks are being used.
372 * This can be either rewrite module or permalink in the HTTP query string.
377 * @return bool True, if permalinks are enabled.
379 public function using_permalinks() {
380 return ! empty($this->permalink_structure);
384 * Determines whether permalinks are being used and rewrite module is not enabled.
386 * Means that permalink links are enabled and index.php is in the URL.
391 * @return bool Whether permalink links are enabled and index.php is in the URL.
393 public function using_index_permalinks() {
394 if ( empty( $this->permalink_structure ) ) {
398 // If the index is not in the permalink, we're using mod_rewrite.
399 return preg_match( '#^/*' . $this->index . '#', $this->permalink_structure );
403 * Determines whether permalinks are being used and rewrite module is enabled.
405 * Using permalinks and index.php is not in the URL.
410 * @return bool Whether permalink links are enabled and index.php is NOT in the URL.
412 public function using_mod_rewrite_permalinks() {
413 return $this->using_permalinks() && ! $this->using_index_permalinks();
417 * Indexes for matches for usage in preg_*() functions.
419 * The format of the string is, with empty matches property value, '$NUM'.
420 * The 'NUM' will be replaced with the value in the $number parameter. With
421 * the matches property not empty, the value of the returned string will
422 * contain that value of the matches property. The format then will be
423 * '$MATCHES[NUM]', with MATCHES as the value in the property and NUM the
424 * value of the $number parameter.
429 * @param int $number Index number.
432 public function preg_index($number) {
436 if ( ! empty($this->matches) ) {
437 $match_prefix = '$' . $this->matches . '[';
441 return "$match_prefix$number$match_suffix";
445 * Retrieves all page and attachments for pages URIs.
447 * The attachments are for those that have pages as parents and will be
453 * @global wpdb $wpdb WordPress database abstraction object.
455 * @return array Array of page URIs as first element and attachment URIs as second element.
457 public function page_uri_index() {
460 // Get pages in order of hierarchy, i.e. children after parents.
461 $pages = $wpdb->get_results("SELECT ID, post_name, post_parent FROM $wpdb->posts WHERE post_type = 'page' AND post_status != 'auto-draft'");
462 $posts = get_page_hierarchy( $pages );
464 // If we have no pages get out quick.
466 return array( array(), array() );
468 // Now reverse it, because we need parents after children for rewrite rules to work properly.
469 $posts = array_reverse($posts, true);
471 $page_uris = array();
472 $page_attachment_uris = array();
474 foreach ( $posts as $id => $post ) {
476 $uri = get_page_uri($id);
477 $attachments = $wpdb->get_results( $wpdb->prepare( "SELECT ID, post_name, post_parent FROM $wpdb->posts WHERE post_type = 'attachment' AND post_parent = %d", $id ));
478 if ( !empty($attachments) ) {
479 foreach ( $attachments as $attachment ) {
480 $attach_uri = get_page_uri($attachment->ID);
481 $page_attachment_uris[$attach_uri] = $attachment->ID;
485 $page_uris[$uri] = $id;
488 return array( $page_uris, $page_attachment_uris );
492 * Retrieves all of the rewrite rules for pages.
497 * @return array Page rewrite rules.
499 public function page_rewrite_rules() {
500 // The extra .? at the beginning prevents clashes with other regular expressions in the rules array.
501 $this->add_rewrite_tag( '%pagename%', '(.?.+?)', 'pagename=' );
503 return $this->generate_rewrite_rules( $this->get_page_permastruct(), EP_PAGES, true, true, false, false );
507 * Retrieves date permalink structure, with year, month, and day.
509 * The permalink structure for the date, if not set already depends on the
510 * permalink structure. It can be one of three formats. The first is year,
511 * month, day; the second is day, month, year; and the last format is month,
512 * day, year. These are matched against the permalink structure for which
513 * one is used. If none matches, then the default will be used, which is
516 * Prevents post ID and date permalinks from overlapping. In the case of
517 * post_id, the date permalink will be prepended with front permalink with
518 * 'date/' before the actual permalink to form the complete date permalink
524 * @return string|false False on no permalink structure. Date permalink structure.
526 public function get_date_permastruct() {
527 if ( isset($this->date_structure) )
528 return $this->date_structure;
530 if ( empty($this->permalink_structure) ) {
531 $this->date_structure = '';
535 // The date permalink must have year, month, and day separated by slashes.
536 $endians = array('%year%/%monthnum%/%day%', '%day%/%monthnum%/%year%', '%monthnum%/%day%/%year%');
538 $this->date_structure = '';
541 foreach ( $endians as $endian ) {
542 if ( false !== strpos($this->permalink_structure, $endian) ) {
543 $date_endian= $endian;
548 if ( empty($date_endian) )
549 $date_endian = '%year%/%monthnum%/%day%';
552 * Do not allow the date tags and %post_id% to overlap in the permalink
553 * structure. If they do, move the date tags to $front/date/.
555 $front = $this->front;
556 preg_match_all('/%.+?%/', $this->permalink_structure, $tokens);
558 foreach ( (array) $tokens[0] as $token) {
559 if ( '%post_id%' == $token && ($tok_index <= 3) ) {
560 $front = $front . 'date/';
566 $this->date_structure = $front . $date_endian;
568 return $this->date_structure;
572 * Retrieves the year permalink structure without month and day.
574 * Gets the date permalink structure and strips out the month and day
575 * permalink structures.
580 * @return false|string False on failure. Year structure on success.
582 public function get_year_permastruct() {
583 $structure = $this->get_date_permastruct();
585 if ( empty($structure) )
588 $structure = str_replace('%monthnum%', '', $structure);
589 $structure = str_replace('%day%', '', $structure);
590 $structure = preg_replace('#/+#', '/', $structure);
596 * Retrieves the month permalink structure without day and with year.
598 * Gets the date permalink structure and strips out the day permalink
599 * structures. Keeps the year permalink structure.
604 * @return false|string False on failure. Year/Month structure on success.
606 public function get_month_permastruct() {
607 $structure = $this->get_date_permastruct();
609 if ( empty($structure) )
612 $structure = str_replace('%day%', '', $structure);
613 $structure = preg_replace('#/+#', '/', $structure);
619 * Retrieves the day permalink structure with month and year.
621 * Keeps date permalink structure with all year, month, and day.
626 * @return string|false False on failure. Year/Month/Day structure on success.
628 public function get_day_permastruct() {
629 return $this->get_date_permastruct();
633 * Retrieves the permalink structure for categories.
635 * If the category_base property has no value, then the category structure
636 * will have the front property value, followed by 'category', and finally
637 * '%category%'. If it does, then the root property will be used, along with
638 * the category_base property value.
643 * @return string|false False on failure. Category permalink structure.
645 public function get_category_permastruct() {
646 return $this->get_extra_permastruct('category');
650 * Retrieve the permalink structure for tags.
652 * If the tag_base property has no value, then the tag structure will have
653 * the front property value, followed by 'tag', and finally '%tag%'. If it
654 * does, then the root property will be used, along with the tag_base
660 * @return string|false False on failure. Tag permalink structure.
662 public function get_tag_permastruct() {
663 return $this->get_extra_permastruct('post_tag');
667 * Retrieves an extra permalink structure by name.
672 * @param string $name Permalink structure name.
673 * @return string|false False if not found. Permalink structure string.
675 public function get_extra_permastruct($name) {
676 if ( empty($this->permalink_structure) )
679 if ( isset($this->extra_permastructs[$name]) )
680 return $this->extra_permastructs[$name]['struct'];
686 * Retrieves the author permalink structure.
688 * The permalink structure is front property, author base, and finally
689 * '/%author%'. Will set the author_structure property and then return it
690 * without attempting to set the value again.
695 * @return string|false False if not found. Permalink structure string.
697 public function get_author_permastruct() {
698 if ( isset($this->author_structure) )
699 return $this->author_structure;
701 if ( empty($this->permalink_structure) ) {
702 $this->author_structure = '';
706 $this->author_structure = $this->front . $this->author_base . '/%author%';
708 return $this->author_structure;
712 * Retrieves the search permalink structure.
714 * The permalink structure is root property, search base, and finally
715 * '/%search%'. Will set the search_structure property and then return it
716 * without attempting to set the value again.
721 * @return string|false False if not found. Permalink structure string.
723 public function get_search_permastruct() {
724 if ( isset($this->search_structure) )
725 return $this->search_structure;
727 if ( empty($this->permalink_structure) ) {
728 $this->search_structure = '';
732 $this->search_structure = $this->root . $this->search_base . '/%search%';
734 return $this->search_structure;
738 * Retrieves the page permalink structure.
740 * The permalink structure is root property, and '%pagename%'. Will set the
741 * page_structure property and then return it without attempting to set the
747 * @return string|false False if not found. Permalink structure string.
749 public function get_page_permastruct() {
750 if ( isset($this->page_structure) )
751 return $this->page_structure;
753 if (empty($this->permalink_structure)) {
754 $this->page_structure = '';
758 $this->page_structure = $this->root . '%pagename%';
760 return $this->page_structure;
764 * Retrieves the feed permalink structure.
766 * The permalink structure is root property, feed base, and finally
767 * '/%feed%'. Will set the feed_structure property and then return it
768 * without attempting to set the value again.
773 * @return string|false False if not found. Permalink structure string.
775 public function get_feed_permastruct() {
776 if ( isset($this->feed_structure) )
777 return $this->feed_structure;
779 if ( empty($this->permalink_structure) ) {
780 $this->feed_structure = '';
784 $this->feed_structure = $this->root . $this->feed_base . '/%feed%';
786 return $this->feed_structure;
790 * Retrieves the comment feed permalink structure.
792 * The permalink structure is root property, comment base property, feed
793 * base and finally '/%feed%'. Will set the comment_feed_structure property
794 * and then return it without attempting to set the value again.
799 * @return string|false False if not found. Permalink structure string.
801 public function get_comment_feed_permastruct() {
802 if ( isset($this->comment_feed_structure) )
803 return $this->comment_feed_structure;
805 if (empty($this->permalink_structure)) {
806 $this->comment_feed_structure = '';
810 $this->comment_feed_structure = $this->root . $this->comments_base . '/' . $this->feed_base . '/%feed%';
812 return $this->comment_feed_structure;
816 * Adds or updates existing rewrite tags (e.g. %postname%).
818 * If the tag already exists, replace the existing pattern and query for
819 * that tag, otherwise add the new tag.
824 * @see WP_Rewrite::$rewritecode
825 * @see WP_Rewrite::$rewritereplace
826 * @see WP_Rewrite::$queryreplace
828 * @param string $tag Name of the rewrite tag to add or update.
829 * @param string $regex Regular expression to substitute the tag for in rewrite rules.
830 * @param string $query String to append to the rewritten query. Must end in '='.
832 public function add_rewrite_tag( $tag, $regex, $query ) {
833 $position = array_search( $tag, $this->rewritecode );
834 if ( false !== $position && null !== $position ) {
835 $this->rewritereplace[ $position ] = $regex;
836 $this->queryreplace[ $position ] = $query;
838 $this->rewritecode[] = $tag;
839 $this->rewritereplace[] = $regex;
840 $this->queryreplace[] = $query;
846 * Removes an existing rewrite tag.
851 * @see WP_Rewrite::$rewritecode
852 * @see WP_Rewrite::$rewritereplace
853 * @see WP_Rewrite::$queryreplace
855 * @param string $tag Name of the rewrite tag to remove.
857 public function remove_rewrite_tag( $tag ) {
858 $position = array_search( $tag, $this->rewritecode );
859 if ( false !== $position && null !== $position ) {
860 unset( $this->rewritecode[ $position ] );
861 unset( $this->rewritereplace[ $position ] );
862 unset( $this->queryreplace[ $position ] );
867 * Generates rewrite rules from a permalink structure.
869 * The main WP_Rewrite function for building the rewrite rule list. The
870 * contents of the function is a mix of black magic and regular expressions,
871 * so best just ignore the contents and move to the parameters.
876 * @param string $permalink_structure The permalink structure.
877 * @param int $ep_mask Optional. Endpoint mask defining what endpoints are added to the structure.
878 * Accepts `EP_NONE`, `EP_PERMALINK`, `EP_ATTACHMENT`, `EP_DATE`, `EP_YEAR`,
879 * `EP_MONTH`, `EP_DAY`, `EP_ROOT`, `EP_COMMENTS`, `EP_SEARCH`, `EP_CATEGORIES`,
880 * `EP_TAGS`, `EP_AUTHORS`, `EP_PAGES`, `EP_ALL_ARCHIVES`, and `EP_ALL`.
882 * @param bool $paged Optional. Whether archive pagination rules should be added for the structure.
884 * @param bool $feed Optional Whether feed rewrite rules should be added for the structure.
886 * @param bool $forcomments Optional. Whether the feed rules should be a query for a comments feed.
888 * @param bool $walk_dirs Optional. Whether the 'directories' making up the structure should be walked
889 * over and rewrite rules built for each in-turn. Default true.
890 * @param bool $endpoints Optional. Whether endpoints should be applied to the generated rewrite rules.
892 * @return array Rewrite rule list.
894 public function generate_rewrite_rules($permalink_structure, $ep_mask = EP_NONE, $paged = true, $feed = true, $forcomments = false, $walk_dirs = true, $endpoints = true) {
895 // Build a regex to match the feed section of URLs, something like (feed|atom|rss|rss2)/?
897 foreach ( (array) $this->feeds as $feed_name)
898 $feedregex2 .= $feed_name . '|';
899 $feedregex2 = '(' . trim($feedregex2, '|') . ')/?$';
902 * $feedregex is identical but with /feed/ added on as well, so URLs like <permalink>/feed/atom
903 * and <permalink>/atom are both possible
905 $feedregex = $this->feed_base . '/' . $feedregex2;
907 // Build a regex to match the trackback and page/xx parts of URLs.
908 $trackbackregex = 'trackback/?$';
909 $pageregex = $this->pagination_base . '/?([0-9]{1,})/?$';
910 $commentregex = $this->comments_pagination_base . '-([0-9]{1,})/?$';
911 $embedregex = 'embed/?$';
913 // Build up an array of endpoint regexes to append => queries to append.
915 $ep_query_append = array ();
916 foreach ( (array) $this->endpoints as $endpoint) {
917 // Match everything after the endpoint name, but allow for nothing to appear there.
918 $epmatch = $endpoint[1] . '(/(.*))?/?$';
920 // This will be appended on to the rest of the query for each dir.
921 $epquery = '&' . $endpoint[2] . '=';
922 $ep_query_append[$epmatch] = array ( $endpoint[0], $epquery );
926 // Get everything up to the first rewrite tag.
927 $front = substr($permalink_structure, 0, strpos($permalink_structure, '%'));
929 // Build an array of the tags (note that said array ends up being in $tokens[0]).
930 preg_match_all('/%.+?%/', $permalink_structure, $tokens);
932 $num_tokens = count($tokens[0]);
934 $index = $this->index; //probably 'index.php'
936 $trackbackindex = $index;
937 $embedindex = $index;
940 * Build a list from the rewritecode and queryreplace arrays, that will look something
941 * like tagname=$matches[i] where i is the current $i.
944 for ( $i = 0; $i < $num_tokens; ++$i ) {
946 $queries[$i] = $queries[$i - 1] . '&';
950 $query_token = str_replace($this->rewritecode, $this->queryreplace, $tokens[0][$i]) . $this->preg_index($i+1);
951 $queries[$i] .= $query_token;
954 // Get the structure, minus any cruft (stuff that isn't tags) at the front.
955 $structure = $permalink_structure;
957 $structure = str_replace($front, '', $structure);
960 * Create a list of dirs to walk over, making rewrite rules for each level
961 * so for example, a $structure of /%year%/%monthnum%/%postname% would create
962 * rewrite rules for /%year%/, /%year%/%monthnum%/ and /%year%/%monthnum%/%postname%
964 $structure = trim($structure, '/');
965 $dirs = $walk_dirs ? explode('/', $structure) : array( $structure );
966 $num_dirs = count($dirs);
968 // Strip slashes from the front of $front.
969 $front = preg_replace('|^/+|', '', $front);
971 // The main workhorse loop.
972 $post_rewrite = array();
974 for ( $j = 0; $j < $num_dirs; ++$j ) {
975 // Get the struct for this dir, and trim slashes off the front.
976 $struct .= $dirs[$j] . '/'; // Accumulate. see comment near explode('/', $structure) above.
977 $struct = ltrim($struct, '/');
979 // Replace tags with regexes.
980 $match = str_replace($this->rewritecode, $this->rewritereplace, $struct);
982 // Make a list of tags, and store how many there are in $num_toks.
983 $num_toks = preg_match_all('/%.+?%/', $struct, $toks);
985 // Get the 'tagname=$matches[i]'.
986 $query = ( ! empty( $num_toks ) && isset( $queries[$num_toks - 1] ) ) ? $queries[$num_toks - 1] : '';
988 // Set up $ep_mask_specific which is used to match more specific URL types.
989 switch ( $dirs[$j] ) {
991 $ep_mask_specific = EP_YEAR;
994 $ep_mask_specific = EP_MONTH;
997 $ep_mask_specific = EP_DAY;
1000 $ep_mask_specific = EP_NONE;
1003 // Create query for /page/xx.
1004 $pagematch = $match . $pageregex;
1005 $pagequery = $index . '?' . $query . '&paged=' . $this->preg_index($num_toks + 1);
1007 // Create query for /comment-page-xx.
1008 $commentmatch = $match . $commentregex;
1009 $commentquery = $index . '?' . $query . '&cpage=' . $this->preg_index($num_toks + 1);
1011 if ( get_option('page_on_front') ) {
1012 // Create query for Root /comment-page-xx.
1013 $rootcommentmatch = $match . $commentregex;
1014 $rootcommentquery = $index . '?' . $query . '&page_id=' . get_option('page_on_front') . '&cpage=' . $this->preg_index($num_toks + 1);
1017 // Create query for /feed/(feed|atom|rss|rss2|rdf).
1018 $feedmatch = $match . $feedregex;
1019 $feedquery = $feedindex . '?' . $query . '&feed=' . $this->preg_index($num_toks + 1);
1021 // Create query for /(feed|atom|rss|rss2|rdf) (see comment near creation of $feedregex).
1022 $feedmatch2 = $match . $feedregex2;
1023 $feedquery2 = $feedindex . '?' . $query . '&feed=' . $this->preg_index($num_toks + 1);
1025 // Create query and regex for embeds.
1026 $embedmatch = $match . $embedregex;
1027 $embedquery = $embedindex . '?' . $query . '&embed=true';
1029 // If asked to, turn the feed queries into comment feed ones.
1030 if ( $forcomments ) {
1031 $feedquery .= '&withcomments=1';
1032 $feedquery2 .= '&withcomments=1';
1035 // Start creating the array of rewrites for this dir.
1038 // ...adding on /feed/ regexes => queries
1040 $rewrite = array( $feedmatch => $feedquery, $feedmatch2 => $feedquery2, $embedmatch => $embedquery );
1043 //...and /page/xx ones
1045 $rewrite = array_merge( $rewrite, array( $pagematch => $pagequery ) );
1048 // Only on pages with comments add ../comment-page-xx/.
1049 if ( EP_PAGES & $ep_mask || EP_PERMALINK & $ep_mask ) {
1050 $rewrite = array_merge($rewrite, array($commentmatch => $commentquery));
1051 } elseif ( EP_ROOT & $ep_mask && get_option('page_on_front') ) {
1052 $rewrite = array_merge($rewrite, array($rootcommentmatch => $rootcommentquery));
1057 foreach ( (array) $ep_query_append as $regex => $ep) {
1058 // Add the endpoints on if the mask fits.
1059 if ( $ep[0] & $ep_mask || $ep[0] & $ep_mask_specific )
1060 $rewrite[$match . $regex] = $index . '?' . $query . $ep[1] . $this->preg_index($num_toks + 2);
1064 // If we've got some tags in this dir.
1070 * Check to see if this dir is permalink-level: i.e. the structure specifies an
1071 * individual post. Do this by checking it contains at least one of 1) post name,
1072 * 2) post ID, 3) page name, 4) timestamp (year, month, day, hour, second and
1073 * minute all present). Set these flags now as we need them for the endpoints.
1075 if ( strpos($struct, '%postname%') !== false
1076 || strpos($struct, '%post_id%') !== false
1077 || strpos($struct, '%pagename%') !== false
1078 || (strpos($struct, '%year%') !== false && strpos($struct, '%monthnum%') !== false && strpos($struct, '%day%') !== false && strpos($struct, '%hour%') !== false && strpos($struct, '%minute%') !== false && strpos($struct, '%second%') !== false)
1081 if ( strpos($struct, '%pagename%') !== false )
1086 // For custom post types, we need to add on endpoints as well.
1087 foreach ( get_post_types( array('_builtin' => false ) ) as $ptype ) {
1088 if ( strpos($struct, "%$ptype%") !== false ) {
1091 // This is for page style attachment URLs.
1092 $page = is_post_type_hierarchical( $ptype );
1098 // If creating rules for a permalink, do all the endpoints like attachments etc.
1100 // Create query and regex for trackback.
1101 $trackbackmatch = $match . $trackbackregex;
1102 $trackbackquery = $trackbackindex . '?' . $query . '&tb=1';
1104 // Create query and regex for embeds.
1105 $embedmatch = $match . $embedregex;
1106 $embedquery = $embedindex . '?' . $query . '&embed=true';
1108 // Trim slashes from the end of the regex for this dir.
1109 $match = rtrim($match, '/');
1111 // Get rid of brackets.
1112 $submatchbase = str_replace( array('(', ')'), '', $match);
1114 // Add a rule for at attachments, which take the form of <permalink>/some-text.
1115 $sub1 = $submatchbase . '/([^/]+)/';
1117 // Add trackback regex <permalink>/trackback/...
1118 $sub1tb = $sub1 . $trackbackregex;
1120 // And <permalink>/feed/(atom|...)
1121 $sub1feed = $sub1 . $feedregex;
1123 // And <permalink>/(feed|atom...)
1124 $sub1feed2 = $sub1 . $feedregex2;
1126 // And <permalink>/comment-page-xx
1127 $sub1comment = $sub1 . $commentregex;
1129 // And <permalink>/embed/...
1130 $sub1embed = $sub1 . $embedregex;
1133 * Add another rule to match attachments in the explicit form:
1134 * <permalink>/attachment/some-text
1136 $sub2 = $submatchbase . '/attachment/([^/]+)/';
1138 // And add trackbacks <permalink>/attachment/trackback.
1139 $sub2tb = $sub2 . $trackbackregex;
1141 // Feeds, <permalink>/attachment/feed/(atom|...)
1142 $sub2feed = $sub2 . $feedregex;
1144 // And feeds again on to this <permalink>/attachment/(feed|atom...)
1145 $sub2feed2 = $sub2 . $feedregex2;
1147 // And <permalink>/comment-page-xx
1148 $sub2comment = $sub2 . $commentregex;
1150 // And <permalink>/embed/...
1151 $sub2embed = $sub2 . $embedregex;
1153 // Create queries for these extra tag-ons we've just dealt with.
1154 $subquery = $index . '?attachment=' . $this->preg_index(1);
1155 $subtbquery = $subquery . '&tb=1';
1156 $subfeedquery = $subquery . '&feed=' . $this->preg_index(2);
1157 $subcommentquery = $subquery . '&cpage=' . $this->preg_index(2);
1158 $subembedquery = $subquery . '&embed=true';
1160 // Do endpoints for attachments.
1161 if ( !empty($endpoints) ) {
1162 foreach ( (array) $ep_query_append as $regex => $ep ) {
1163 if ( $ep[0] & EP_ATTACHMENT ) {
1164 $rewrite[$sub1 . $regex] = $subquery . $ep[1] . $this->preg_index(3);
1165 $rewrite[$sub2 . $regex] = $subquery . $ep[1] . $this->preg_index(3);
1171 * Now we've finished with endpoints, finish off the $sub1 and $sub2 matches
1172 * add a ? as we don't have to match that last slash, and finally a $ so we
1173 * match to the end of the URL
1179 * Post pagination, e.g. <permalink>/2/
1180 * Previously: '(/[0-9]+)?/?$', which produced '/2' for page.
1181 * When cast to int, returned 0.
1183 $match = $match . '(?:/([0-9]+))?/?$';
1184 $query = $index . '?' . $query . '&page=' . $this->preg_index($num_toks + 1);
1186 // Not matching a permalink so this is a lot simpler.
1188 // Close the match and finalise the query.
1190 $query = $index . '?' . $query;
1194 * Create the final array for this dir by joining the $rewrite array (which currently
1195 * only contains rules/queries for trackback, pages etc) to the main regex/query for
1198 $rewrite = array_merge($rewrite, array($match => $query));
1200 // If we're matching a permalink, add those extras (attachments etc) on.
1203 $rewrite = array_merge(array($trackbackmatch => $trackbackquery), $rewrite);
1206 $rewrite = array_merge( array( $embedmatch => $embedquery ), $rewrite );
1208 // Add regexes/queries for attachments, attachment trackbacks and so on.
1210 // Require <permalink>/attachment/stuff form for pages because of confusion with subpages.
1211 $rewrite = array_merge( $rewrite, array(
1213 $sub1tb => $subtbquery,
1214 $sub1feed => $subfeedquery,
1215 $sub1feed2 => $subfeedquery,
1216 $sub1comment => $subcommentquery,
1217 $sub1embed => $subembedquery
1221 $rewrite = array_merge( array( $sub2 => $subquery, $sub2tb => $subtbquery, $sub2feed => $subfeedquery, $sub2feed2 => $subfeedquery, $sub2comment => $subcommentquery, $sub2embed => $subembedquery ), $rewrite );
1224 // Add the rules for this dir to the accumulating $post_rewrite.
1225 $post_rewrite = array_merge($rewrite, $post_rewrite);
1228 // The finished rules. phew!
1229 return $post_rewrite;
1233 * Generates rewrite rules with permalink structure and walking directory only.
1235 * Shorten version of WP_Rewrite::generate_rewrite_rules() that allows for shorter
1236 * list of parameters. See the method for longer description of what generating
1237 * rewrite rules does.
1242 * @see WP_Rewrite::generate_rewrite_rules() See for long description and rest of parameters.
1244 * @param string $permalink_structure The permalink structure to generate rules.
1245 * @param bool $walk_dirs Optional, default is false. Whether to create list of directories to walk over.
1248 public function generate_rewrite_rule($permalink_structure, $walk_dirs = false) {
1249 return $this->generate_rewrite_rules($permalink_structure, EP_NONE, false, false, false, $walk_dirs);
1253 * Constructs rewrite matches and queries from permalink structure.
1255 * Runs the action 'generate_rewrite_rules' with the parameter that is an
1256 * reference to the current WP_Rewrite instance to further manipulate the
1257 * permalink structures and rewrite rules. Runs the 'rewrite_rules_array'
1258 * filter on the full rewrite rule array.
1260 * There are two ways to manipulate the rewrite rules, one by hooking into
1261 * the 'generate_rewrite_rules' action and gaining full control of the
1262 * object or just manipulating the rewrite rule array before it is passed
1263 * from the function.
1268 * @return array An associate array of matches and queries.
1270 public function rewrite_rules() {
1273 if ( empty($this->permalink_structure) )
1276 // robots.txt -only if installed at the root
1277 $home_path = parse_url( home_url() );
1278 $robots_rewrite = ( empty( $home_path['path'] ) || '/' == $home_path['path'] ) ? array( 'robots\.txt$' => $this->index . '?robots=1' ) : array();
1280 // Old feed and service files.
1281 $deprecated_files = array(
1282 '.*wp-(atom|rdf|rss|rss2|feed|commentsrss2)\.php$' => $this->index . '?feed=old',
1283 '.*wp-app\.php(/.*)?$' => $this->index . '?error=403',
1286 // Registration rules.
1287 $registration_pages = array();
1288 if ( is_multisite() && is_main_site() ) {
1289 $registration_pages['.*wp-signup.php$'] = $this->index . '?signup=true';
1290 $registration_pages['.*wp-activate.php$'] = $this->index . '?activate=true';
1294 $registration_pages['.*wp-register.php$'] = $this->index . '?register=true';
1296 // Post rewrite rules.
1297 $post_rewrite = $this->generate_rewrite_rules( $this->permalink_structure, EP_PERMALINK );
1300 * Filter rewrite rules used for "post" archives.
1304 * @param array $post_rewrite The rewrite rules for posts.
1306 $post_rewrite = apply_filters( 'post_rewrite_rules', $post_rewrite );
1308 // Date rewrite rules.
1309 $date_rewrite = $this->generate_rewrite_rules($this->get_date_permastruct(), EP_DATE);
1312 * Filter rewrite rules used for date archives.
1314 * Likely date archives would include /yyyy/, /yyyy/mm/, and /yyyy/mm/dd/.
1318 * @param array $date_rewrite The rewrite rules for date archives.
1320 $date_rewrite = apply_filters( 'date_rewrite_rules', $date_rewrite );
1322 // Root-level rewrite rules.
1323 $root_rewrite = $this->generate_rewrite_rules($this->root . '/', EP_ROOT);
1326 * Filter rewrite rules used for root-level archives.
1328 * Likely root-level archives would include pagination rules for the homepage
1329 * as well as site-wide post feeds (e.g. /feed/, and /feed/atom/).
1333 * @param array $root_rewrite The root-level rewrite rules.
1335 $root_rewrite = apply_filters( 'root_rewrite_rules', $root_rewrite );
1337 // Comments rewrite rules.
1338 $comments_rewrite = $this->generate_rewrite_rules($this->root . $this->comments_base, EP_COMMENTS, false, true, true, false);
1341 * Filter rewrite rules used for comment feed archives.
1343 * Likely comments feed archives include /comments/feed/, and /comments/feed/atom/.
1347 * @param array $comments_rewrite The rewrite rules for the site-wide comments feeds.
1349 $comments_rewrite = apply_filters( 'comments_rewrite_rules', $comments_rewrite );
1351 // Search rewrite rules.
1352 $search_structure = $this->get_search_permastruct();
1353 $search_rewrite = $this->generate_rewrite_rules($search_structure, EP_SEARCH);
1356 * Filter rewrite rules used for search archives.
1358 * Likely search-related archives include /search/search+query/ as well as
1359 * pagination and feed paths for a search.
1363 * @param array $search_rewrite The rewrite rules for search queries.
1365 $search_rewrite = apply_filters( 'search_rewrite_rules', $search_rewrite );
1367 // Author rewrite rules.
1368 $author_rewrite = $this->generate_rewrite_rules($this->get_author_permastruct(), EP_AUTHORS);
1371 * Filter rewrite rules used for author archives.
1373 * Likely author archives would include /author/author-name/, as well as
1374 * pagination and feed paths for author archives.
1378 * @param array $author_rewrite The rewrite rules for author archives.
1380 $author_rewrite = apply_filters( 'author_rewrite_rules', $author_rewrite );
1382 // Pages rewrite rules.
1383 $page_rewrite = $this->page_rewrite_rules();
1386 * Filter rewrite rules used for "page" post type archives.
1390 * @param array $page_rewrite The rewrite rules for the "page" post type.
1392 $page_rewrite = apply_filters( 'page_rewrite_rules', $page_rewrite );
1394 // Extra permastructs.
1395 foreach ( $this->extra_permastructs as $permastructname => $struct ) {
1396 if ( is_array( $struct ) ) {
1397 if ( count( $struct ) == 2 )
1398 $rules = $this->generate_rewrite_rules( $struct[0], $struct[1] );
1400 $rules = $this->generate_rewrite_rules( $struct['struct'], $struct['ep_mask'], $struct['paged'], $struct['feed'], $struct['forcomments'], $struct['walk_dirs'], $struct['endpoints'] );
1402 $rules = $this->generate_rewrite_rules( $struct );
1406 * Filter rewrite rules used for individual permastructs.
1408 * The dynamic portion of the hook name, `$permastructname`, refers
1409 * to the name of the registered permastruct, e.g. 'post_tag' (tags),
1410 * 'category' (categories), etc.
1414 * @param array $rules The rewrite rules generated for the current permastruct.
1416 $rules = apply_filters( $permastructname . '_rewrite_rules', $rules );
1417 if ( 'post_tag' == $permastructname ) {
1420 * Filter rewrite rules used specifically for Tags.
1423 * @deprecated 3.1.0 Use 'post_tag_rewrite_rules' instead
1425 * @param array $rules The rewrite rules generated for tags.
1427 $rules = apply_filters( 'tag_rewrite_rules', $rules );
1430 $this->extra_rules_top = array_merge($this->extra_rules_top, $rules);
1433 // Put them together.
1434 if ( $this->use_verbose_page_rules )
1435 $this->rules = array_merge($this->extra_rules_top, $robots_rewrite, $deprecated_files, $registration_pages, $root_rewrite, $comments_rewrite, $search_rewrite, $author_rewrite, $date_rewrite, $page_rewrite, $post_rewrite, $this->extra_rules);
1437 $this->rules = array_merge($this->extra_rules_top, $robots_rewrite, $deprecated_files, $registration_pages, $root_rewrite, $comments_rewrite, $search_rewrite, $author_rewrite, $date_rewrite, $post_rewrite, $page_rewrite, $this->extra_rules);
1440 * Fires after the rewrite rules are generated.
1444 * @param WP_Rewrite $this Current WP_Rewrite instance, passed by reference.
1446 do_action_ref_array( 'generate_rewrite_rules', array( &$this ) );
1449 * Filter the full set of generated rewrite rules.
1453 * @param array $this->rules The compiled array of rewrite rules.
1455 $this->rules = apply_filters( 'rewrite_rules_array', $this->rules );
1457 return $this->rules;
1461 * Retrieves the rewrite rules.
1463 * The difference between this method and WP_Rewrite::rewrite_rules() is that
1464 * this method stores the rewrite rules in the 'rewrite_rules' option and retrieves
1465 * it. This prevents having to process all of the permalinks to get the rewrite rules
1466 * in the form of caching.
1471 * @return array Rewrite rules.
1473 public function wp_rewrite_rules() {
1474 $this->rules = get_option('rewrite_rules');
1475 if ( empty($this->rules) ) {
1476 $this->matches = 'matches';
1477 $this->rewrite_rules();
1478 update_option('rewrite_rules', $this->rules);
1481 return $this->rules;
1485 * Retrieves mod_rewrite-formatted rewrite rules to write to .htaccess.
1487 * Does not actually write to the .htaccess file, but creates the rules for
1488 * the process that will.
1490 * Will add the non_wp_rules property rules to the .htaccess file before
1491 * the WordPress rewrite rules one.
1498 public function mod_rewrite_rules() {
1499 if ( ! $this->using_permalinks() )
1502 $site_root = parse_url( site_url() );
1503 if ( isset( $site_root['path'] ) )
1504 $site_root = trailingslashit($site_root['path']);
1506 $home_root = parse_url(home_url());
1507 if ( isset( $home_root['path'] ) )
1508 $home_root = trailingslashit($home_root['path']);
1512 $rules = "<IfModule mod_rewrite.c>\n";
1513 $rules .= "RewriteEngine On\n";
1514 $rules .= "RewriteBase $home_root\n";
1516 // Prevent -f checks on index.php.
1517 $rules .= "RewriteRule ^index\.php$ - [L]\n";
1519 // Add in the rules that don't redirect to WP's index.php (and thus shouldn't be handled by WP at all).
1520 foreach ( (array) $this->non_wp_rules as $match => $query) {
1521 // Apache 1.3 does not support the reluctant (non-greedy) modifier.
1522 $match = str_replace('.+?', '.+', $match);
1524 $rules .= 'RewriteRule ^' . $match . ' ' . $home_root . $query . " [QSA,L]\n";
1527 if ( $this->use_verbose_rules ) {
1528 $this->matches = '';
1529 $rewrite = $this->rewrite_rules();
1530 $num_rules = count($rewrite);
1531 $rules .= "RewriteCond %{REQUEST_FILENAME} -f [OR]\n" .
1532 "RewriteCond %{REQUEST_FILENAME} -d\n" .
1533 "RewriteRule ^.*$ - [S=$num_rules]\n";
1535 foreach ( (array) $rewrite as $match => $query) {
1536 // Apache 1.3 does not support the reluctant (non-greedy) modifier.
1537 $match = str_replace('.+?', '.+', $match);
1539 if ( strpos($query, $this->index) !== false )
1540 $rules .= 'RewriteRule ^' . $match . ' ' . $home_root . $query . " [QSA,L]\n";
1542 $rules .= 'RewriteRule ^' . $match . ' ' . $site_root . $query . " [QSA,L]\n";
1545 $rules .= "RewriteCond %{REQUEST_FILENAME} !-f\n" .
1546 "RewriteCond %{REQUEST_FILENAME} !-d\n" .
1547 "RewriteRule . {$home_root}{$this->index} [L]\n";
1550 $rules .= "</IfModule>\n";
1553 * Filter the list of rewrite rules formatted for output to an .htaccess file.
1557 * @param string $rules mod_rewrite Rewrite rules formatted for .htaccess.
1559 $rules = apply_filters( 'mod_rewrite_rules', $rules );
1562 * Filter the list of rewrite rules formatted for output to an .htaccess file.
1565 * @deprecated 1.5.0 Use the mod_rewrite_rules filter instead.
1567 * @param string $rules mod_rewrite Rewrite rules formatted for .htaccess.
1569 return apply_filters( 'rewrite_rules', $rules );
1573 * Retrieves IIS7 URL Rewrite formatted rewrite rules to write to web.config file.
1575 * Does not actually write to the web.config file, but creates the rules for
1576 * the process that will.
1581 * @param bool $add_parent_tags Optional. Whether to add parent tags to the rewrite rule sets.
1583 * @return string IIS7 URL rewrite rule sets.
1585 public function iis7_url_rewrite_rules( $add_parent_tags = false ) {
1586 if ( ! $this->using_permalinks() )
1589 if ( $add_parent_tags ) {
1590 $rules .= '<configuration>
1597 <rule name="WordPress: ' . esc_attr( home_url() ) . '" patternSyntax="Wildcard">
1600 <add input="{REQUEST_FILENAME}" matchType="IsFile" negate="true" />
1601 <add input="{REQUEST_FILENAME}" matchType="IsDirectory" negate="true" />
1603 <action type="Rewrite" url="index.php" />
1606 if ( $add_parent_tags ) {
1615 * Filter the list of rewrite rules formatted for output to a web.config.
1619 * @param string $rules Rewrite rules formatted for IIS web.config.
1621 return apply_filters( 'iis7_url_rewrite_rules', $rules );
1625 * Adds a rewrite rule that transforms a URL structure to a set of query vars.
1627 * Any value in the $after parameter that isn't 'bottom' will result in the rule
1628 * being placed at the top of the rewrite rules.
1631 * @since 4.4.0 Array support was added to the `$query` parameter.
1634 * @param string $regex Regular expression to match request against.
1635 * @param string|array $query The corresponding query vars for this rewrite rule.
1636 * @param string $after Optional. Priority of the new rule. Accepts 'top'
1637 * or 'bottom'. Default 'bottom'.
1639 public function add_rule( $regex, $query, $after = 'bottom' ) {
1640 if ( is_array( $query ) ) {
1642 $query = add_query_arg( $query, 'index.php' );
1644 $index = false === strpos( $query, '?' ) ? strlen( $query ) : strpos( $query, '?' );
1645 $front = substr( $query, 0, $index );
1647 $external = $front != $this->index;
1650 // "external" = it doesn't correspond to index.php.
1652 $this->add_external_rule( $regex, $query );
1654 if ( 'bottom' == $after ) {
1655 $this->extra_rules = array_merge( $this->extra_rules, array( $regex => $query ) );
1657 $this->extra_rules_top = array_merge( $this->extra_rules_top, array( $regex => $query ) );
1663 * Adds a rewrite rule that doesn't correspond to index.php.
1668 * @param string $regex Regular expression to match request against.
1669 * @param string $query The corresponding query vars for this rewrite rule.
1671 public function add_external_rule( $regex, $query ) {
1672 $this->non_wp_rules[ $regex ] = $query;
1676 * Adds an endpoint, like /trackback/.
1679 * @since 3.9.0 $query_var parameter added.
1680 * @since 4.3.0 Added support for skipping query var registration by passing `false` to `$query_var`.
1683 * @see add_rewrite_endpoint() for full documentation.
1686 * @param string $name Name of the endpoint.
1687 * @param int $places Endpoint mask describing the places the endpoint should be added.
1688 * @param string|bool $query_var Optional. Name of the corresponding query variable. Pass `false` to
1689 * skip registering a query_var for this endpoint. Defaults to the
1692 public function add_endpoint( $name, $places, $query_var = true ) {
1695 // For backward compatibility, if null has explicitly been passed as `$query_var`, assume `true`.
1696 if ( true === $query_var || null === func_get_arg( 2 ) ) {
1699 $this->endpoints[] = array( $places, $name, $query_var );
1702 $wp->add_query_var( $query_var );
1707 * Adds a new permalink structure.
1709 * A permalink structure (permastruct) is an abstract definition of a set of rewrite rules;
1710 * it is an easy way of expressing a set of regular expressions that rewrite to a set of
1711 * query strings. The new permastruct is added to the WP_Rewrite::$extra_permastructs array.
1713 * When the rewrite rules are built by WP_Rewrite::rewrite_rules(), all of these extra
1714 * permastructs are passed to WP_Rewrite::generate_rewrite_rules() which transforms them
1715 * into the regular expressions that many love to hate.
1717 * The `$args` parameter gives you control over how WP_Rewrite::generate_rewrite_rules()
1718 * works on the new permastruct.
1723 * @param string $name Name for permalink structure.
1724 * @param string $struct Permalink structure (e.g. category/%category%)
1725 * @param array $args {
1726 * Optional. Arguments for building rewrite rules based on the permalink structure.
1727 * Default empty array.
1729 * @type bool $with_front Whether the structure should be prepended with `WP_Rewrite::$front`.
1731 * @type int $ep_mask The endpoint mask defining which endpoints are added to the structure.
1732 * Accepts `EP_NONE`, `EP_PERMALINK`, `EP_ATTACHMENT`, `EP_DATE`, `EP_YEAR`,
1733 * `EP_MONTH`, `EP_DAY`, `EP_ROOT`, `EP_COMMENTS`, `EP_SEARCH`, `EP_CATEGORIES`,
1734 * `EP_TAGS`, `EP_AUTHORS`, `EP_PAGES`, `EP_ALL_ARCHIVES`, and `EP_ALL`.
1735 * Default `EP_NONE`.
1736 * @type bool $paged Whether archive pagination rules should be added for the structure.
1738 * @type bool $feed Whether feed rewrite rules should be added for the structure. Default true.
1739 * @type bool $forcomments Whether the feed rules should be a query for a comments feed. Default false.
1740 * @type bool $walk_dirs Whether the 'directories' making up the structure should be walked over
1741 * and rewrite rules built for each in-turn. Default true.
1742 * @type bool $endpoints Whether endpoints should be applied to the generated rules. Default true.
1745 public function add_permastruct( $name, $struct, $args = array() ) {
1746 // Backwards compatibility for the old parameters: $with_front and $ep_mask.
1747 if ( ! is_array( $args ) )
1748 $args = array( 'with_front' => $args );
1749 if ( func_num_args() == 4 )
1750 $args['ep_mask'] = func_get_arg( 3 );
1753 'with_front' => true,
1754 'ep_mask' => EP_NONE,
1757 'forcomments' => false,
1758 'walk_dirs' => true,
1759 'endpoints' => true,
1761 $args = array_intersect_key( $args, $defaults );
1762 $args = wp_parse_args( $args, $defaults );
1764 if ( $args['with_front'] )
1765 $struct = $this->front . $struct;
1767 $struct = $this->root . $struct;
1768 $args['struct'] = $struct;
1770 $this->extra_permastructs[ $name ] = $args;
1774 * Removes a permalink structure.
1779 * @param string $name Name for permalink structure.
1781 public function remove_permastruct( $name ) {
1782 unset( $this->extra_permastructs[ $name ] );
1786 * Removes rewrite rules and then recreate rewrite rules.
1788 * Calls WP_Rewrite::wp_rewrite_rules() after removing the 'rewrite_rules' option.
1789 * If the function named 'save_mod_rewrite_rules' exists, it will be called.
1794 * @staticvar bool $do_hard_later
1796 * @param bool $hard Whether to update .htaccess (hard flush) or just update rewrite_rules option (soft flush). Default is true (hard).
1798 public function flush_rules( $hard = true ) {
1799 static $do_hard_later = null;
1801 // Prevent this action from running before everyone has registered their rewrites.
1802 if ( ! did_action( 'wp_loaded' ) ) {
1803 add_action( 'wp_loaded', array( $this, 'flush_rules' ) );
1804 $do_hard_later = ( isset( $do_hard_later ) ) ? $do_hard_later || $hard : $hard;
1808 if ( isset( $do_hard_later ) ) {
1809 $hard = $do_hard_later;
1810 unset( $do_hard_later );
1813 update_option( 'rewrite_rules', '' );
1814 $this->wp_rewrite_rules();
1817 * Filter whether a "hard" rewrite rule flush should be performed when requested.
1819 * A "hard" flush updates .htaccess (Apache) or web.config (IIS).
1823 * @param bool $hard Whether to flush rewrite rules "hard". Default true.
1825 if ( ! $hard || ! apply_filters( 'flush_rewrite_rules_hard', true ) ) {
1828 if ( function_exists( 'save_mod_rewrite_rules' ) )
1829 save_mod_rewrite_rules();
1830 if ( function_exists( 'iis7_save_url_rewrite_rules' ) )
1831 iis7_save_url_rewrite_rules();
1835 * Sets up the object's properties.
1837 * The 'use_verbose_page_rules' object property will be set to true if the
1838 * permalink structure begins with one of the following: '%postname%', '%category%',
1839 * '%tag%', or '%author%'.
1844 public function init() {
1845 $this->extra_rules = $this->non_wp_rules = $this->endpoints = array();
1846 $this->permalink_structure = get_option('permalink_structure');
1847 $this->front = substr($this->permalink_structure, 0, strpos($this->permalink_structure, '%'));
1850 if ( $this->using_index_permalinks() )
1851 $this->root = $this->index . '/';
1853 unset($this->author_structure);
1854 unset($this->date_structure);
1855 unset($this->page_structure);
1856 unset($this->search_structure);
1857 unset($this->feed_structure);
1858 unset($this->comment_feed_structure);
1859 $this->use_trailing_slashes = ( '/' == substr($this->permalink_structure, -1, 1) );
1861 // Enable generic rules for pages if permalink structure doesn't begin with a wildcard.
1862 if ( preg_match("/^[^%]*%(?:postname|category|tag|author)%/", $this->permalink_structure) )
1863 $this->use_verbose_page_rules = true;
1865 $this->use_verbose_page_rules = false;
1869 * Sets the main permalink structure for the site.
1871 * Will update the 'permalink_structure' option, if there is a difference
1872 * between the current permalink structure and the parameter value. Calls
1873 * WP_Rewrite::init() after the option is updated.
1875 * Fires the 'permalink_structure_changed' action once the init call has
1876 * processed passing the old and new values
1881 * @param string $permalink_structure Permalink structure.
1883 public function set_permalink_structure($permalink_structure) {
1884 if ( $permalink_structure != $this->permalink_structure ) {
1885 $old_permalink_structure = $this->permalink_structure;
1886 update_option('permalink_structure', $permalink_structure);
1891 * Fires after the permalink structure is updated.
1895 * @param string $old_permalink_structure The previous permalink structure.
1896 * @param string $permalink_structure The new permalink structure.
1898 do_action( 'permalink_structure_changed', $old_permalink_structure, $permalink_structure );
1903 * Sets the category base for the category permalink.
1905 * Will update the 'category_base' option, if there is a difference between
1906 * the current category base and the parameter value. Calls WP_Rewrite::init()
1907 * after the option is updated.
1912 * @param string $category_base Category permalink structure base.
1914 public function set_category_base($category_base) {
1915 if ( $category_base != get_option('category_base') ) {
1916 update_option('category_base', $category_base);
1922 * Sets the tag base for the tag permalink.
1924 * Will update the 'tag_base' option, if there is a difference between the
1925 * current tag base and the parameter value. Calls WP_Rewrite::init() after
1926 * the option is updated.
1931 * @param string $tag_base Tag permalink structure base.
1933 public function set_tag_base( $tag_base ) {
1934 if ( $tag_base != get_option( 'tag_base') ) {
1935 update_option( 'tag_base', $tag_base );
1941 * Constructor - Calls init(), which runs setup.
1947 public function __construct() {