WordPress 4.4
[autoinstalls/wordpress.git] / wp-includes / class-wp-rewrite.php
1 <?php
2 /**
3  * Rewrite API: WP_Rewrite class
4  *
5  * @package WordPress
6  * @subpackage Rewrite
7  * @since 1.5.0
8  */
9
10 /**
11  * Core class used to implement a rewrite component API.
12  *
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.
16  *
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
21  * rules.
22  *
23  * @since 1.5.0
24  */
25 class WP_Rewrite {
26         /**
27          * Permalink structure for posts.
28          *
29          * @since 1.5.0
30          * @var string
31          */
32         public $permalink_structure;
33
34         /**
35          * Whether to add trailing slashes.
36          *
37          * @since 2.2.0
38          * @var bool
39          */
40         public $use_trailing_slashes;
41
42         /**
43          * Base for the author permalink structure (example.com/$author_base/authorname).
44          *
45          * @since 1.5.0
46          * @access private
47          * @var string
48          */
49         var $author_base = 'author';
50
51         /**
52          * Permalink structure for author archives.
53          *
54          * @since 1.5.0
55          * @access private
56          * @var string
57          */
58         var $author_structure;
59
60         /**
61          * Permalink structure for date archives.
62          *
63          * @since 1.5.0
64          * @access private
65          * @var string
66          */
67         var $date_structure;
68
69         /**
70          * Permalink structure for pages.
71          *
72          * @since 1.5.0
73          * @access private
74          * @var string
75          */
76         var $page_structure;
77
78         /**
79          * Base of the search permalink structure (example.com/$search_base/query).
80          *
81          * @since 1.5.0
82          * @access private
83          * @var string
84          */
85         var $search_base = 'search';
86
87         /**
88          * Permalink structure for searches.
89          *
90          * @since 1.5.0
91          * @access private
92          * @var string
93          */
94         var $search_structure;
95
96         /**
97          * Comments permalink base.
98          *
99          * @since 1.5.0
100          * @access private
101          * @var string
102          */
103         var $comments_base = 'comments';
104
105         /**
106          * Pagination permalink base.
107          *
108          * @since 3.1.0
109          * @var string
110          */
111         public $pagination_base = 'page';
112
113         /**
114          * Comments pagination permalink base.
115          *
116          * @since 4.2.0
117          * @access private
118          * @var string
119          */
120         var $comments_pagination_base = 'comment-page';
121
122         /**
123          * Feed permalink base.
124          *
125          * @since 1.5.0
126          * @access private
127          * @var string
128          */
129         var $feed_base = 'feed';
130
131         /**
132          * Comments feed permalink structure.
133          *
134          * @since 1.5.0
135          * @access private
136          * @var string
137          */
138         var $comment_feed_structure;
139
140         /**
141          * Feed request permalink structure.
142          *
143          * @since 1.5.0
144          * @access private
145          * @var string
146          */
147         var $feed_structure;
148
149         /**
150          * The static portion of the post permalink structure.
151          *
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 "/".
155          *
156          * @since 1.5.0
157          * @access public
158          * @var string
159          *
160          * @see WP_Rewrite::init()
161          */
162         public $front;
163
164         /**
165          * The prefix for all permalink structures.
166          *
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
169          * will be empty.
170          *
171          * @since 1.5.0
172          * @access public
173          * @var string
174          *
175          * @see WP_Rewrite::init()
176          * @see WP_Rewrite::using_index_permalinks()
177          */
178         public $root = '';
179
180         /**
181          * The name of the index file which is the entry point to all requests.
182          *
183          * @since 1.5.0
184          * @access public
185          * @var string
186          */
187         public $index = 'index.php';
188
189         /**
190          * Variable name to use for regex matches in the rewritten query.
191          *
192          * @since 1.5.0
193          * @access private
194          * @var string
195          */
196         var $matches = '';
197
198         /**
199          * Rewrite rules to match against the request to find the redirect or query.
200          *
201          * @since 1.5.0
202          * @access private
203          * @var array
204          */
205         var $rules;
206
207         /**
208          * Additional rules added external to the rewrite class.
209          *
210          * Those not generated by the class, see add_rewrite_rule().
211          *
212          * @since 2.1.0
213          * @access private
214          * @var array
215          */
216         var $extra_rules = array();
217
218         /**
219          * Additional rules that belong at the beginning to match first.
220          *
221          * Those not generated by the class, see add_rewrite_rule().
222          *
223          * @since 2.3.0
224          * @access private
225          * @var array
226          */
227         var $extra_rules_top = array();
228
229         /**
230          * Rules that don't redirect to WordPress' index.php.
231          *
232          * These rules are written to the mod_rewrite portion of the .htaccess,
233          * and are added by add_external_rule().
234          *
235          * @since 2.1.0
236          * @access private
237          * @var array
238          */
239         var $non_wp_rules = array();
240
241         /**
242          * Extra permalink structures, e.g. categories, added by add_permastruct().
243          *
244          * @since 2.1.0
245          * @access private
246          * @var array
247          */
248         var $extra_permastructs = array();
249
250         /**
251          * Endpoints (like /trackback/) added by add_rewrite_endpoint().
252          *
253          * @since 2.1.0
254          * @access private
255          * @var array
256          */
257         var $endpoints;
258
259         /**
260          * Whether to write every mod_rewrite rule for WordPress into the .htaccess file.
261          *
262          * This is off by default, turning it on might print a lot of rewrite rules
263          * to the .htaccess file.
264          *
265          * @since 2.0.0
266          * @access public
267          * @var bool
268          *
269          * @see WP_Rewrite::mod_rewrite_rules()
270          */
271         public $use_verbose_rules = false;
272
273         /**
274          * Could post permalinks be confused with those of pages?
275          *
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.
282          *
283          * @since 2.5.0
284          * @access public
285          * @var bool
286          *
287          * @see WP_Rewrite::init()
288          */
289         public $use_verbose_page_rules = true;
290
291         /**
292          * Rewrite tags that can be used in permalink structures.
293          *
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.
297          *
298          * Additional tags can be added with add_rewrite_tag().
299          *
300          * @since 1.5.0
301          * @access private
302          * @var array
303          */
304         var $rewritecode = array(
305                 '%year%',
306                 '%monthnum%',
307                 '%day%',
308                 '%hour%',
309                 '%minute%',
310                 '%second%',
311                 '%postname%',
312                 '%post_id%',
313                 '%author%',
314                 '%pagename%',
315                 '%search%'
316         );
317
318         /**
319          * Regular expressions to be substituted into rewrite rules in place
320          * of rewrite tags, see WP_Rewrite::$rewritecode.
321          *
322          * @since 1.5.0
323          * @access private
324          * @var array
325          */
326         var $rewritereplace = array(
327                 '([0-9]{4})',
328                 '([0-9]{1,2})',
329                 '([0-9]{1,2})',
330                 '([0-9]{1,2})',
331                 '([0-9]{1,2})',
332                 '([0-9]{1,2})',
333                 '([^/]+)',
334                 '([0-9]+)',
335                 '([^/]+)',
336                 '([^/]+?)',
337                 '(.+)'
338         );
339
340         /**
341          * Query variables that rewrite tags map to, see WP_Rewrite::$rewritecode.
342          *
343          * @since 1.5.0
344          * @access private
345          * @var array
346          */
347         var $queryreplace = array(
348                 'year=',
349                 'monthnum=',
350                 'day=',
351                 'hour=',
352                 'minute=',
353                 'second=',
354                 'name=',
355                 'p=',
356                 'author_name=',
357                 'pagename=',
358                 's='
359         );
360
361         /**
362          * Supported default feeds.
363          *
364          * @since 1.5.0
365          * @var array
366          */
367         public $feeds = array( 'feed', 'rdf', 'rss', 'rss2', 'atom' );
368
369         /**
370          * Determines whether permalinks are being used.
371          *
372          * This can be either rewrite module or permalink in the HTTP query string.
373          *
374          * @since 1.5.0
375          * @access public
376          *
377          * @return bool True, if permalinks are enabled.
378          */
379         public function using_permalinks() {
380                 return ! empty($this->permalink_structure);
381         }
382
383         /**
384          * Determines whether permalinks are being used and rewrite module is not enabled.
385          *
386          * Means that permalink links are enabled and index.php is in the URL.
387          *
388          * @since 1.5.0
389          * @access public
390          *
391          * @return bool Whether permalink links are enabled and index.php is in the URL.
392          */
393         public function using_index_permalinks() {
394                 if ( empty( $this->permalink_structure ) ) {
395                         return false;
396                 }
397
398                 // If the index is not in the permalink, we're using mod_rewrite.
399                 return preg_match( '#^/*' . $this->index . '#', $this->permalink_structure );
400         }
401
402         /**
403          * Determines whether permalinks are being used and rewrite module is enabled.
404          *
405          * Using permalinks and index.php is not in the URL.
406          *
407          * @since 1.5.0
408          * @access public
409          *
410          * @return bool Whether permalink links are enabled and index.php is NOT in the URL.
411          */
412         public function using_mod_rewrite_permalinks() {
413                 return $this->using_permalinks() && ! $this->using_index_permalinks();
414         }
415
416         /**
417          * Indexes for matches for usage in preg_*() functions.
418          *
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.
425          *
426          * @since 1.5.0
427          * @access public
428          *
429          * @param int $number Index number.
430          * @return string
431          */
432         public function preg_index($number) {
433                 $match_prefix = '$';
434                 $match_suffix = '';
435
436                 if ( ! empty($this->matches) ) {
437                         $match_prefix = '$' . $this->matches . '[';
438                         $match_suffix = ']';
439                 }
440
441                 return "$match_prefix$number$match_suffix";
442         }
443
444         /**
445          * Retrieves all page and attachments for pages URIs.
446          *
447          * The attachments are for those that have pages as parents and will be
448          * retrieved.
449          *
450          * @since 2.5.0
451          * @access public
452          *
453          * @global wpdb $wpdb WordPress database abstraction object.
454          *
455          * @return array Array of page URIs as first element and attachment URIs as second element.
456          */
457         public function page_uri_index() {
458                 global $wpdb;
459
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 );
463
464                 // If we have no pages get out quick.
465                 if ( !$posts )
466                         return array( array(), array() );
467
468                 // Now reverse it, because we need parents after children for rewrite rules to work properly.
469                 $posts = array_reverse($posts, true);
470
471                 $page_uris = array();
472                 $page_attachment_uris = array();
473
474                 foreach ( $posts as $id => $post ) {
475                         // URL => page name
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;
482                                 }
483                         }
484
485                         $page_uris[$uri] = $id;
486                 }
487
488                 return array( $page_uris, $page_attachment_uris );
489         }
490
491         /**
492          * Retrieves all of the rewrite rules for pages.
493          *
494          * @since 1.5.0
495          * @access public
496          *
497          * @return array Page rewrite rules.
498          */
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=' );
502
503                 return $this->generate_rewrite_rules( $this->get_page_permastruct(), EP_PAGES, true, true, false, false );
504         }
505
506         /**
507          * Retrieves date permalink structure, with year, month, and day.
508          *
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
514          * year, month, day.
515          *
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
519          * structure.
520          *
521          * @since 1.5.0
522          * @access public
523          *
524          * @return string|false False on no permalink structure. Date permalink structure.
525          */
526         public function get_date_permastruct() {
527                 if ( isset($this->date_structure) )
528                         return $this->date_structure;
529
530                 if ( empty($this->permalink_structure) ) {
531                         $this->date_structure = '';
532                         return false;
533                 }
534
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%');
537
538                 $this->date_structure = '';
539                 $date_endian = '';
540
541                 foreach ( $endians as $endian ) {
542                         if ( false !== strpos($this->permalink_structure, $endian) ) {
543                                 $date_endian= $endian;
544                                 break;
545                         }
546                 }
547
548                 if ( empty($date_endian) )
549                         $date_endian = '%year%/%monthnum%/%day%';
550
551                 /*
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/.
554                  */
555                 $front = $this->front;
556                 preg_match_all('/%.+?%/', $this->permalink_structure, $tokens);
557                 $tok_index = 1;
558                 foreach ( (array) $tokens[0] as $token) {
559                         if ( '%post_id%' == $token && ($tok_index <= 3) ) {
560                                 $front = $front . 'date/';
561                                 break;
562                         }
563                         $tok_index++;
564                 }
565
566                 $this->date_structure = $front . $date_endian;
567
568                 return $this->date_structure;
569         }
570
571         /**
572          * Retrieves the year permalink structure without month and day.
573          *
574          * Gets the date permalink structure and strips out the month and day
575          * permalink structures.
576          *
577          * @since 1.5.0
578          * @access public
579          *
580          * @return false|string False on failure. Year structure on success.
581          */
582         public function get_year_permastruct() {
583                 $structure = $this->get_date_permastruct();
584
585                 if ( empty($structure) )
586                         return false;
587
588                 $structure = str_replace('%monthnum%', '', $structure);
589                 $structure = str_replace('%day%', '', $structure);
590                 $structure = preg_replace('#/+#', '/', $structure);
591
592                 return $structure;
593         }
594
595         /**
596          * Retrieves the month permalink structure without day and with year.
597          *
598          * Gets the date permalink structure and strips out the day permalink
599          * structures. Keeps the year permalink structure.
600          *
601          * @since 1.5.0
602          * @access public
603          *
604          * @return false|string False on failure. Year/Month structure on success.
605          */
606         public function get_month_permastruct() {
607                 $structure = $this->get_date_permastruct();
608
609                 if ( empty($structure) )
610                         return false;
611
612                 $structure = str_replace('%day%', '', $structure);
613                 $structure = preg_replace('#/+#', '/', $structure);
614
615                 return $structure;
616         }
617
618         /**
619          * Retrieves the day permalink structure with month and year.
620          *
621          * Keeps date permalink structure with all year, month, and day.
622          *
623          * @since 1.5.0
624          * @access public
625          *
626          * @return string|false False on failure. Year/Month/Day structure on success.
627          */
628         public function get_day_permastruct() {
629                 return $this->get_date_permastruct();
630         }
631
632         /**
633          * Retrieves the permalink structure for categories.
634          *
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.
639          *
640          * @since 1.5.0
641          * @access public
642          *
643          * @return string|false False on failure. Category permalink structure.
644          */
645         public function get_category_permastruct() {
646                 return $this->get_extra_permastruct('category');
647         }
648
649         /**
650          * Retrieve the permalink structure for tags.
651          *
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
655          * property value.
656          *
657          * @since 2.3.0
658          * @access public
659          *
660          * @return string|false False on failure. Tag permalink structure.
661          */
662         public function get_tag_permastruct() {
663                 return $this->get_extra_permastruct('post_tag');
664         }
665
666         /**
667          * Retrieves an extra permalink structure by name.
668          *
669          * @since 2.5.0
670          * @access public
671          *
672          * @param string $name Permalink structure name.
673          * @return string|false False if not found. Permalink structure string.
674          */
675         public function get_extra_permastruct($name) {
676                 if ( empty($this->permalink_structure) )
677                         return false;
678
679                 if ( isset($this->extra_permastructs[$name]) )
680                         return $this->extra_permastructs[$name]['struct'];
681
682                 return false;
683         }
684
685         /**
686          * Retrieves the author permalink structure.
687          *
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.
691          *
692          * @since 1.5.0
693          * @access public
694          *
695          * @return string|false False if not found. Permalink structure string.
696          */
697         public function get_author_permastruct() {
698                 if ( isset($this->author_structure) )
699                         return $this->author_structure;
700
701                 if ( empty($this->permalink_structure) ) {
702                         $this->author_structure = '';
703                         return false;
704                 }
705
706                 $this->author_structure = $this->front . $this->author_base . '/%author%';
707
708                 return $this->author_structure;
709         }
710
711         /**
712          * Retrieves the search permalink structure.
713          *
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.
717          *
718          * @since 1.5.0
719          * @access public
720          *
721          * @return string|false False if not found. Permalink structure string.
722          */
723         public function get_search_permastruct() {
724                 if ( isset($this->search_structure) )
725                         return $this->search_structure;
726
727                 if ( empty($this->permalink_structure) ) {
728                         $this->search_structure = '';
729                         return false;
730                 }
731
732                 $this->search_structure = $this->root . $this->search_base . '/%search%';
733
734                 return $this->search_structure;
735         }
736
737         /**
738          * Retrieves the page permalink structure.
739          *
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
742          * value again.
743          *
744          * @since 1.5.0
745          * @access public
746          *
747          * @return string|false False if not found. Permalink structure string.
748          */
749         public function get_page_permastruct() {
750                 if ( isset($this->page_structure) )
751                         return $this->page_structure;
752
753                 if (empty($this->permalink_structure)) {
754                         $this->page_structure = '';
755                         return false;
756                 }
757
758                 $this->page_structure = $this->root . '%pagename%';
759
760                 return $this->page_structure;
761         }
762
763         /**
764          * Retrieves the feed permalink structure.
765          *
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.
769          *
770          * @since 1.5.0
771          * @access public
772          *
773          * @return string|false False if not found. Permalink structure string.
774          */
775         public function get_feed_permastruct() {
776                 if ( isset($this->feed_structure) )
777                         return $this->feed_structure;
778
779                 if ( empty($this->permalink_structure) ) {
780                         $this->feed_structure = '';
781                         return false;
782                 }
783
784                 $this->feed_structure = $this->root . $this->feed_base . '/%feed%';
785
786                 return $this->feed_structure;
787         }
788
789         /**
790          * Retrieves the comment feed permalink structure.
791          *
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.
795          *
796          * @since 1.5.0
797          * @access public
798          *
799          * @return string|false False if not found. Permalink structure string.
800          */
801         public function get_comment_feed_permastruct() {
802                 if ( isset($this->comment_feed_structure) )
803                         return $this->comment_feed_structure;
804
805                 if (empty($this->permalink_structure)) {
806                         $this->comment_feed_structure = '';
807                         return false;
808                 }
809
810                 $this->comment_feed_structure = $this->root . $this->comments_base . '/' . $this->feed_base . '/%feed%';
811
812                 return $this->comment_feed_structure;
813         }
814
815         /**
816          * Adds or updates existing rewrite tags (e.g. %postname%).
817          *
818          * If the tag already exists, replace the existing pattern and query for
819          * that tag, otherwise add the new tag.
820          *
821          * @since 1.5.0
822          * @access public
823          *
824          * @see WP_Rewrite::$rewritecode
825          * @see WP_Rewrite::$rewritereplace
826          * @see WP_Rewrite::$queryreplace
827          *
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 '='.
831          */
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;
837                 } else {
838                         $this->rewritecode[] = $tag;
839                         $this->rewritereplace[] = $regex;
840                         $this->queryreplace[] = $query;
841                 }
842         }
843
844         /**
845          * Generates rewrite rules from a permalink structure.
846          *
847          * The main WP_Rewrite function for building the rewrite rule list. The
848          * contents of the function is a mix of black magic and regular expressions,
849          * so best just ignore the contents and move to the parameters.
850          *
851          * @since 1.5.0
852          * @access public
853          *
854          * @param string $permalink_structure The permalink structure.
855          * @param int    $ep_mask             Optional. Endpoint mask defining what endpoints are added to the structure.
856          *                                    Accepts `EP_NONE`, `EP_PERMALINK`, `EP_ATTACHMENT`, `EP_DATE`, `EP_YEAR`,
857          *                                    `EP_MONTH`, `EP_DAY`, `EP_ROOT`, `EP_COMMENTS`, `EP_SEARCH`, `EP_CATEGORIES`,
858          *                                    `EP_TAGS`, `EP_AUTHORS`, `EP_PAGES`, `EP_ALL_ARCHIVES`, and `EP_ALL`.
859          *                                    Default `EP_NONE`.
860          * @param bool   $paged               Optional. Whether archive pagination rules should be added for the structure.
861          *                                    Default true.
862          * @param bool   $feed                Optional Whether feed rewrite rules should be added for the structure.
863          *                                    Default true.
864          * @param bool   $forcomments         Optional. Whether the feed rules should be a query for a comments feed.
865          *                                    Default false.
866          * @param bool   $walk_dirs           Optional. Whether the 'directories' making up the structure should be walked
867          *                                    over and rewrite rules built for each in-turn. Default true.
868          * @param bool   $endpoints           Optional. Whether endpoints should be applied to the generated rewrite rules.
869          *                                    Default true.
870          * @return array Rewrite rule list.
871          */
872         public function generate_rewrite_rules($permalink_structure, $ep_mask = EP_NONE, $paged = true, $feed = true, $forcomments = false, $walk_dirs = true, $endpoints = true) {
873                 // Build a regex to match the feed section of URLs, something like (feed|atom|rss|rss2)/?
874                 $feedregex2 = '';
875                 foreach ( (array) $this->feeds as $feed_name)
876                         $feedregex2 .= $feed_name . '|';
877                 $feedregex2 = '(' . trim($feedregex2, '|') . ')/?$';
878
879                 /*
880                  * $feedregex is identical but with /feed/ added on as well, so URLs like <permalink>/feed/atom
881                  * and <permalink>/atom are both possible
882                  */
883                 $feedregex = $this->feed_base . '/' . $feedregex2;
884
885                 // Build a regex to match the trackback and page/xx parts of URLs.
886                 $trackbackregex = 'trackback/?$';
887                 $pageregex = $this->pagination_base . '/?([0-9]{1,})/?$';
888                 $commentregex = $this->comments_pagination_base . '-([0-9]{1,})/?$';
889                 $embedregex = 'embed/?$';
890
891                 // Build up an array of endpoint regexes to append => queries to append.
892                 if ( $endpoints ) {
893                         $ep_query_append = array ();
894                         foreach ( (array) $this->endpoints as $endpoint) {
895                                 // Match everything after the endpoint name, but allow for nothing to appear there.
896                                 $epmatch = $endpoint[1] . '(/(.*))?/?$';
897
898                                 // This will be appended on to the rest of the query for each dir.
899                                 $epquery = '&' . $endpoint[2] . '=';
900                                 $ep_query_append[$epmatch] = array ( $endpoint[0], $epquery );
901                         }
902                 }
903
904                 // Get everything up to the first rewrite tag.
905                 $front = substr($permalink_structure, 0, strpos($permalink_structure, '%'));
906
907                 // Build an array of the tags (note that said array ends up being in $tokens[0]).
908                 preg_match_all('/%.+?%/', $permalink_structure, $tokens);
909
910                 $num_tokens = count($tokens[0]);
911
912                 $index = $this->index; //probably 'index.php'
913                 $feedindex = $index;
914                 $trackbackindex = $index;
915                 $embedindex = $index;
916
917                 /*
918                  * Build a list from the rewritecode and queryreplace arrays, that will look something
919                  * like tagname=$matches[i] where i is the current $i.
920                  */
921                 $queries = array();
922                 for ( $i = 0; $i < $num_tokens; ++$i ) {
923                         if ( 0 < $i )
924                                 $queries[$i] = $queries[$i - 1] . '&';
925                         else
926                                 $queries[$i] = '';
927
928                         $query_token = str_replace($this->rewritecode, $this->queryreplace, $tokens[0][$i]) . $this->preg_index($i+1);
929                         $queries[$i] .= $query_token;
930                 }
931
932                 // Get the structure, minus any cruft (stuff that isn't tags) at the front.
933                 $structure = $permalink_structure;
934                 if ( $front != '/' )
935                         $structure = str_replace($front, '', $structure);
936
937                 /*
938                  * Create a list of dirs to walk over, making rewrite rules for each level
939                  * so for example, a $structure of /%year%/%monthnum%/%postname% would create
940                  * rewrite rules for /%year%/, /%year%/%monthnum%/ and /%year%/%monthnum%/%postname%
941                  */
942                 $structure = trim($structure, '/');
943                 $dirs = $walk_dirs ? explode('/', $structure) : array( $structure );
944                 $num_dirs = count($dirs);
945
946                 // Strip slashes from the front of $front.
947                 $front = preg_replace('|^/+|', '', $front);
948
949                 // The main workhorse loop.
950                 $post_rewrite = array();
951                 $struct = $front;
952                 for ( $j = 0; $j < $num_dirs; ++$j ) {
953                         // Get the struct for this dir, and trim slashes off the front.
954                         $struct .= $dirs[$j] . '/'; // Accumulate. see comment near explode('/', $structure) above.
955                         $struct = ltrim($struct, '/');
956
957                         // Replace tags with regexes.
958                         $match = str_replace($this->rewritecode, $this->rewritereplace, $struct);
959
960                         // Make a list of tags, and store how many there are in $num_toks.
961                         $num_toks = preg_match_all('/%.+?%/', $struct, $toks);
962
963                         // Get the 'tagname=$matches[i]'.
964                         $query = ( ! empty( $num_toks ) && isset( $queries[$num_toks - 1] ) ) ? $queries[$num_toks - 1] : '';
965
966                         // Set up $ep_mask_specific which is used to match more specific URL types.
967                         switch ( $dirs[$j] ) {
968                                 case '%year%':
969                                         $ep_mask_specific = EP_YEAR;
970                                         break;
971                                 case '%monthnum%':
972                                         $ep_mask_specific = EP_MONTH;
973                                         break;
974                                 case '%day%':
975                                         $ep_mask_specific = EP_DAY;
976                                         break;
977                                 default:
978                                         $ep_mask_specific = EP_NONE;
979                         }
980
981                         // Create query for /page/xx.
982                         $pagematch = $match . $pageregex;
983                         $pagequery = $index . '?' . $query . '&paged=' . $this->preg_index($num_toks + 1);
984
985                         // Create query for /comment-page-xx.
986                         $commentmatch = $match . $commentregex;
987                         $commentquery = $index . '?' . $query . '&cpage=' . $this->preg_index($num_toks + 1);
988
989                         if ( get_option('page_on_front') ) {
990                                 // Create query for Root /comment-page-xx.
991                                 $rootcommentmatch = $match . $commentregex;
992                                 $rootcommentquery = $index . '?' . $query . '&page_id=' . get_option('page_on_front') . '&cpage=' . $this->preg_index($num_toks + 1);
993                         }
994
995                         // Create query for /feed/(feed|atom|rss|rss2|rdf).
996                         $feedmatch = $match . $feedregex;
997                         $feedquery = $feedindex . '?' . $query . '&feed=' . $this->preg_index($num_toks + 1);
998
999                         // Create query for /(feed|atom|rss|rss2|rdf) (see comment near creation of $feedregex).
1000                         $feedmatch2 = $match . $feedregex2;
1001                         $feedquery2 = $feedindex . '?' . $query . '&feed=' . $this->preg_index($num_toks + 1);
1002
1003                         // If asked to, turn the feed queries into comment feed ones.
1004                         if ( $forcomments ) {
1005                                 $feedquery .= '&withcomments=1';
1006                                 $feedquery2 .= '&withcomments=1';
1007                         }
1008
1009                         // Start creating the array of rewrites for this dir.
1010                         $rewrite = array();
1011
1012                         // ...adding on /feed/ regexes => queries
1013                         if ( $feed ) {
1014                                 $rewrite = array( $feedmatch => $feedquery, $feedmatch2 => $feedquery2 );
1015                         }
1016
1017                         //...and /page/xx ones
1018                         if ( $paged ) {
1019                                 $rewrite = array_merge( $rewrite, array( $pagematch => $pagequery ) );
1020                         }
1021
1022                         // Only on pages with comments add ../comment-page-xx/.
1023                         if ( EP_PAGES & $ep_mask || EP_PERMALINK & $ep_mask ) {
1024                                 $rewrite = array_merge($rewrite, array($commentmatch => $commentquery));
1025                         } elseif ( EP_ROOT & $ep_mask && get_option('page_on_front') ) {
1026                                 $rewrite = array_merge($rewrite, array($rootcommentmatch => $rootcommentquery));
1027                         }
1028
1029                         // Do endpoints.
1030                         if ( $endpoints ) {
1031                                 foreach ( (array) $ep_query_append as $regex => $ep) {
1032                                         // Add the endpoints on if the mask fits.
1033                                         if ( $ep[0] & $ep_mask || $ep[0] & $ep_mask_specific )
1034                                                 $rewrite[$match . $regex] = $index . '?' . $query . $ep[1] . $this->preg_index($num_toks + 2);
1035                                 }
1036                         }
1037
1038                         // If we've got some tags in this dir.
1039                         if ( $num_toks ) {
1040                                 $post = false;
1041                                 $page = false;
1042
1043                                 /*
1044                                  * Check to see if this dir is permalink-level: i.e. the structure specifies an
1045                                  * individual post. Do this by checking it contains at least one of 1) post name,
1046                                  * 2) post ID, 3) page name, 4) timestamp (year, month, day, hour, second and
1047                                  * minute all present). Set these flags now as we need them for the endpoints.
1048                                  */
1049                                 if ( strpos($struct, '%postname%') !== false
1050                                                 || strpos($struct, '%post_id%') !== false
1051                                                 || strpos($struct, '%pagename%') !== false
1052                                                 || (strpos($struct, '%year%') !== false && strpos($struct, '%monthnum%') !== false && strpos($struct, '%day%') !== false && strpos($struct, '%hour%') !== false && strpos($struct, '%minute%') !== false && strpos($struct, '%second%') !== false)
1053                                                 ) {
1054                                         $post = true;
1055                                         if ( strpos($struct, '%pagename%') !== false )
1056                                                 $page = true;
1057                                 }
1058
1059                                 if ( ! $post ) {
1060                                         // For custom post types, we need to add on endpoints as well.
1061                                         foreach ( get_post_types( array('_builtin' => false ) ) as $ptype ) {
1062                                                 if ( strpos($struct, "%$ptype%") !== false ) {
1063                                                         $post = true;
1064
1065                                                         // This is for page style attachment URLs.
1066                                                         $page = is_post_type_hierarchical( $ptype );
1067                                                         break;
1068                                                 }
1069                                         }
1070                                 }
1071
1072                                 // If creating rules for a permalink, do all the endpoints like attachments etc.
1073                                 if ( $post ) {
1074                                         // Create query and regex for trackback.
1075                                         $trackbackmatch = $match . $trackbackregex;
1076                                         $trackbackquery = $trackbackindex . '?' . $query . '&tb=1';
1077
1078                                         // Create query and regex for embeds.
1079                                         $embedmatch = $match . $embedregex;
1080                                         $embedquery = $embedindex . '?' . $query . '&embed=true';
1081
1082                                         // Trim slashes from the end of the regex for this dir.
1083                                         $match = rtrim($match, '/');
1084
1085                                         // Get rid of brackets.
1086                                         $submatchbase = str_replace( array('(', ')'), '', $match);
1087
1088                                         // Add a rule for at attachments, which take the form of <permalink>/some-text.
1089                                         $sub1 = $submatchbase . '/([^/]+)/';
1090
1091                                         // Add trackback regex <permalink>/trackback/...
1092                                         $sub1tb = $sub1 . $trackbackregex;
1093
1094                                         // And <permalink>/feed/(atom|...)
1095                                         $sub1feed = $sub1 . $feedregex;
1096
1097                                         // And <permalink>/(feed|atom...)
1098                                         $sub1feed2 = $sub1 . $feedregex2;
1099
1100                                         // And <permalink>/comment-page-xx
1101                                         $sub1comment = $sub1 . $commentregex;
1102
1103                                         // And <permalink>/embed/...
1104                                         $sub1embed = $sub1 . $embedregex;
1105
1106                                         /*
1107                                          * Add another rule to match attachments in the explicit form:
1108                                          * <permalink>/attachment/some-text
1109                                          */
1110                                         $sub2 = $submatchbase . '/attachment/([^/]+)/';
1111
1112                                         // And add trackbacks <permalink>/attachment/trackback.
1113                                         $sub2tb = $sub2 . $trackbackregex;
1114
1115                                         // Feeds, <permalink>/attachment/feed/(atom|...)
1116                                         $sub2feed = $sub2 . $feedregex;
1117
1118                                         // And feeds again on to this <permalink>/attachment/(feed|atom...)
1119                                         $sub2feed2 = $sub2 . $feedregex2;
1120
1121                                         // And <permalink>/comment-page-xx
1122                                         $sub2comment = $sub2 . $commentregex;
1123
1124                                         // And <permalink>/embed/...
1125                                         $sub2embed = $sub2 . $embedregex;
1126
1127                                         // Create queries for these extra tag-ons we've just dealt with.
1128                                         $subquery = $index . '?attachment=' . $this->preg_index(1);
1129                                         $subtbquery = $subquery . '&tb=1';
1130                                         $subfeedquery = $subquery . '&feed=' . $this->preg_index(2);
1131                                         $subcommentquery = $subquery . '&cpage=' . $this->preg_index(2);
1132                                         $subembedquery = $subquery . '&embed=true';
1133
1134                                         // Do endpoints for attachments.
1135                                         if ( !empty($endpoints) ) {
1136                                                 foreach ( (array) $ep_query_append as $regex => $ep ) {
1137                                                         if ( $ep[0] & EP_ATTACHMENT ) {
1138                                                                 $rewrite[$sub1 . $regex] = $subquery . $ep[1] . $this->preg_index(3);
1139                                                                 $rewrite[$sub2 . $regex] = $subquery . $ep[1] . $this->preg_index(3);
1140                                                         }
1141                                                 }
1142                                         }
1143
1144                                         /*
1145                                          * Now we've finished with endpoints, finish off the $sub1 and $sub2 matches
1146                                          * add a ? as we don't have to match that last slash, and finally a $ so we
1147                                          * match to the end of the URL
1148                                          */
1149                                         $sub1 .= '?$';
1150                                         $sub2 .= '?$';
1151
1152                                         /*
1153                                          * Post pagination, e.g. <permalink>/2/
1154                                          * Previously: '(/[0-9]+)?/?$', which produced '/2' for page.
1155                                          * When cast to int, returned 0.
1156                                          */
1157                                         $match = $match . '(?:/([0-9]+))?/?$';
1158                                         $query = $index . '?' . $query . '&page=' . $this->preg_index($num_toks + 1);
1159
1160                                 // Not matching a permalink so this is a lot simpler.
1161                                 } else {
1162                                         // Close the match and finalise the query.
1163                                         $match .= '?$';
1164                                         $query = $index . '?' . $query;
1165                                 }
1166
1167                                 /*
1168                                  * Create the final array for this dir by joining the $rewrite array (which currently
1169                                  * only contains rules/queries for trackback, pages etc) to the main regex/query for
1170                                  * this dir
1171                                  */
1172                                 $rewrite = array_merge($rewrite, array($match => $query));
1173
1174                                 // If we're matching a permalink, add those extras (attachments etc) on.
1175                                 if ( $post ) {
1176                                         // Add trackback.
1177                                         $rewrite = array_merge(array($trackbackmatch => $trackbackquery), $rewrite);
1178
1179                                         // Add embed.
1180                                         $rewrite = array_merge( array( $embedmatch => $embedquery ), $rewrite );
1181
1182                                         // Add regexes/queries for attachments, attachment trackbacks and so on.
1183                                         if ( ! $page ) {
1184                                                 // Require <permalink>/attachment/stuff form for pages because of confusion with subpages.
1185                                                 $rewrite = array_merge( $rewrite, array(
1186                                                         $sub1        => $subquery,
1187                                                         $sub1tb      => $subtbquery,
1188                                                         $sub1feed    => $subfeedquery,
1189                                                         $sub1feed2   => $subfeedquery,
1190                                                         $sub1comment => $subcommentquery,
1191                                                         $sub1embed   => $subembedquery
1192                                                 ) );
1193                                         }
1194
1195                                         $rewrite = array_merge( array( $sub2 => $subquery, $sub2tb => $subtbquery, $sub2feed => $subfeedquery, $sub2feed2 => $subfeedquery, $sub2comment => $subcommentquery, $sub2embed => $subembedquery ), $rewrite );
1196                                 }
1197                         }
1198                         // Add the rules for this dir to the accumulating $post_rewrite.
1199                         $post_rewrite = array_merge($rewrite, $post_rewrite);
1200                 }
1201
1202                 // The finished rules. phew!
1203                 return $post_rewrite;
1204         }
1205
1206         /**
1207          * Generates rewrite rules with permalink structure and walking directory only.
1208          *
1209          * Shorten version of WP_Rewrite::generate_rewrite_rules() that allows for shorter
1210          * list of parameters. See the method for longer description of what generating
1211          * rewrite rules does.
1212          *
1213          * @since 1.5.0
1214          * @access public
1215          *
1216          * @see WP_Rewrite::generate_rewrite_rules() See for long description and rest of parameters.
1217          *
1218          * @param string $permalink_structure The permalink structure to generate rules.
1219          * @param bool   $walk_dirs           Optional, default is false. Whether to create list of directories to walk over.
1220          * @return array
1221          */
1222         public function generate_rewrite_rule($permalink_structure, $walk_dirs = false) {
1223                 return $this->generate_rewrite_rules($permalink_structure, EP_NONE, false, false, false, $walk_dirs);
1224         }
1225
1226         /**
1227          * Constructs rewrite matches and queries from permalink structure.
1228          *
1229          * Runs the action 'generate_rewrite_rules' with the parameter that is an
1230          * reference to the current WP_Rewrite instance to further manipulate the
1231          * permalink structures and rewrite rules. Runs the 'rewrite_rules_array'
1232          * filter on the full rewrite rule array.
1233          *
1234          * There are two ways to manipulate the rewrite rules, one by hooking into
1235          * the 'generate_rewrite_rules' action and gaining full control of the
1236          * object or just manipulating the rewrite rule array before it is passed
1237          * from the function.
1238          *
1239          * @since 1.5.0
1240          * @access public
1241          *
1242          * @return array An associate array of matches and queries.
1243          */
1244         public function rewrite_rules() {
1245                 $rewrite = array();
1246
1247                 if ( empty($this->permalink_structure) )
1248                         return $rewrite;
1249
1250                 // robots.txt -only if installed at the root
1251                 $home_path = parse_url( home_url() );
1252                 $robots_rewrite = ( empty( $home_path['path'] ) || '/' == $home_path['path'] ) ? array( 'robots\.txt$' => $this->index . '?robots=1' ) : array();
1253
1254                 // Old feed and service files.
1255                 $deprecated_files = array(
1256                         '.*wp-(atom|rdf|rss|rss2|feed|commentsrss2)\.php$' => $this->index . '?feed=old',
1257                         '.*wp-app\.php(/.*)?$' => $this->index . '?error=403',
1258                 );
1259
1260                 // Registration rules.
1261                 $registration_pages = array();
1262                 if ( is_multisite() && is_main_site() ) {
1263                         $registration_pages['.*wp-signup.php$'] = $this->index . '?signup=true';
1264                         $registration_pages['.*wp-activate.php$'] = $this->index . '?activate=true';
1265                 }
1266
1267                 // Deprecated.
1268                 $registration_pages['.*wp-register.php$'] = $this->index . '?register=true';
1269
1270                 // Post rewrite rules.
1271                 $post_rewrite = $this->generate_rewrite_rules( $this->permalink_structure, EP_PERMALINK );
1272
1273                 /**
1274                  * Filter rewrite rules used for "post" archives.
1275                  *
1276                  * @since 1.5.0
1277                  *
1278                  * @param array $post_rewrite The rewrite rules for posts.
1279                  */
1280                 $post_rewrite = apply_filters( 'post_rewrite_rules', $post_rewrite );
1281
1282                 // Date rewrite rules.
1283                 $date_rewrite = $this->generate_rewrite_rules($this->get_date_permastruct(), EP_DATE);
1284
1285                 /**
1286                  * Filter rewrite rules used for date archives.
1287                  *
1288                  * Likely date archives would include /yyyy/, /yyyy/mm/, and /yyyy/mm/dd/.
1289                  *
1290                  * @since 1.5.0
1291                  *
1292                  * @param array $date_rewrite The rewrite rules for date archives.
1293                  */
1294                 $date_rewrite = apply_filters( 'date_rewrite_rules', $date_rewrite );
1295
1296                 // Root-level rewrite rules.
1297                 $root_rewrite = $this->generate_rewrite_rules($this->root . '/', EP_ROOT);
1298
1299                 /**
1300                  * Filter rewrite rules used for root-level archives.
1301                  *
1302                  * Likely root-level archives would include pagination rules for the homepage
1303                  * as well as site-wide post feeds (e.g. /feed/, and /feed/atom/).
1304                  *
1305                  * @since 1.5.0
1306                  *
1307                  * @param array $root_rewrite The root-level rewrite rules.
1308                  */
1309                 $root_rewrite = apply_filters( 'root_rewrite_rules', $root_rewrite );
1310
1311                 // Comments rewrite rules.
1312                 $comments_rewrite = $this->generate_rewrite_rules($this->root . $this->comments_base, EP_COMMENTS, false, true, true, false);
1313
1314                 /**
1315                  * Filter rewrite rules used for comment feed archives.
1316                  *
1317                  * Likely comments feed archives include /comments/feed/, and /comments/feed/atom/.
1318                  *
1319                  * @since 1.5.0
1320                  *
1321                  * @param array $comments_rewrite The rewrite rules for the site-wide comments feeds.
1322                  */
1323                 $comments_rewrite = apply_filters( 'comments_rewrite_rules', $comments_rewrite );
1324
1325                 // Search rewrite rules.
1326                 $search_structure = $this->get_search_permastruct();
1327                 $search_rewrite = $this->generate_rewrite_rules($search_structure, EP_SEARCH);
1328
1329                 /**
1330                  * Filter rewrite rules used for search archives.
1331                  *
1332                  * Likely search-related archives include /search/search+query/ as well as
1333                  * pagination and feed paths for a search.
1334                  *
1335                  * @since 1.5.0
1336                  *
1337                  * @param array $search_rewrite The rewrite rules for search queries.
1338                  */
1339                 $search_rewrite = apply_filters( 'search_rewrite_rules', $search_rewrite );
1340
1341                 // Author rewrite rules.
1342                 $author_rewrite = $this->generate_rewrite_rules($this->get_author_permastruct(), EP_AUTHORS);
1343
1344                 /**
1345                  * Filter rewrite rules used for author archives.
1346                  *
1347                  * Likely author archives would include /author/author-name/, as well as
1348                  * pagination and feed paths for author archives.
1349                  *
1350                  * @since 1.5.0
1351                  *
1352                  * @param array $author_rewrite The rewrite rules for author archives.
1353                  */
1354                 $author_rewrite = apply_filters( 'author_rewrite_rules', $author_rewrite );
1355
1356                 // Pages rewrite rules.
1357                 $page_rewrite = $this->page_rewrite_rules();
1358
1359                 /**
1360                  * Filter rewrite rules used for "page" post type archives.
1361                  *
1362                  * @since 1.5.0
1363                  *
1364                  * @param array $page_rewrite The rewrite rules for the "page" post type.
1365                  */
1366                 $page_rewrite = apply_filters( 'page_rewrite_rules', $page_rewrite );
1367
1368                 // Extra permastructs.
1369                 foreach ( $this->extra_permastructs as $permastructname => $struct ) {
1370                         if ( is_array( $struct ) ) {
1371                                 if ( count( $struct ) == 2 )
1372                                         $rules = $this->generate_rewrite_rules( $struct[0], $struct[1] );
1373                                 else
1374                                         $rules = $this->generate_rewrite_rules( $struct['struct'], $struct['ep_mask'], $struct['paged'], $struct['feed'], $struct['forcomments'], $struct['walk_dirs'], $struct['endpoints'] );
1375                         } else {
1376                                 $rules = $this->generate_rewrite_rules( $struct );
1377                         }
1378
1379                         /**
1380                          * Filter rewrite rules used for individual permastructs.
1381                          *
1382                          * The dynamic portion of the hook name, `$permastructname`, refers
1383                          * to the name of the registered permastruct, e.g. 'post_tag' (tags),
1384                          * 'category' (categories), etc.
1385                          *
1386                          * @since 3.1.0
1387                          *
1388                          * @param array $rules The rewrite rules generated for the current permastruct.
1389                          */
1390                         $rules = apply_filters( $permastructname . '_rewrite_rules', $rules );
1391                         if ( 'post_tag' == $permastructname ) {
1392
1393                                 /**
1394                                  * Filter rewrite rules used specifically for Tags.
1395                                  *
1396                                  * @since 2.3.0
1397                                  * @deprecated 3.1.0 Use 'post_tag_rewrite_rules' instead
1398                                  *
1399                                  * @param array $rules The rewrite rules generated for tags.
1400                                  */
1401                                 $rules = apply_filters( 'tag_rewrite_rules', $rules );
1402                         }
1403
1404                         $this->extra_rules_top = array_merge($this->extra_rules_top, $rules);
1405                 }
1406
1407                 // Put them together.
1408                 if ( $this->use_verbose_page_rules )
1409                         $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);
1410                 else
1411                         $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);
1412
1413                 /**
1414                  * Fires after the rewrite rules are generated.
1415                  *
1416                  * @since 1.5.0
1417                  *
1418                  * @param WP_Rewrite $this Current WP_Rewrite instance, passed by reference.
1419                  */
1420                 do_action_ref_array( 'generate_rewrite_rules', array( &$this ) );
1421
1422                 /**
1423                  * Filter the full set of generated rewrite rules.
1424                  *
1425                  * @since 1.5.0
1426                  *
1427                  * @param array $this->rules The compiled array of rewrite rules.
1428                  */
1429                 $this->rules = apply_filters( 'rewrite_rules_array', $this->rules );
1430
1431                 return $this->rules;
1432         }
1433
1434         /**
1435          * Retrieves the rewrite rules.
1436          *
1437          * The difference between this method and WP_Rewrite::rewrite_rules() is that
1438          * this method stores the rewrite rules in the 'rewrite_rules' option and retrieves
1439          * it. This prevents having to process all of the permalinks to get the rewrite rules
1440          * in the form of caching.
1441          *
1442          * @since 1.5.0
1443          * @access public
1444          *
1445          * @return array Rewrite rules.
1446          */
1447         public function wp_rewrite_rules() {
1448                 $this->rules = get_option('rewrite_rules');
1449                 if ( empty($this->rules) ) {
1450                         $this->matches = 'matches';
1451                         $this->rewrite_rules();
1452                         update_option('rewrite_rules', $this->rules);
1453                 }
1454
1455                 return $this->rules;
1456         }
1457
1458         /**
1459          * Retrieves mod_rewrite-formatted rewrite rules to write to .htaccess.
1460          *
1461          * Does not actually write to the .htaccess file, but creates the rules for
1462          * the process that will.
1463          *
1464          * Will add the non_wp_rules property rules to the .htaccess file before
1465          * the WordPress rewrite rules one.
1466          *
1467          * @since 1.5.0
1468          * @access public
1469          *
1470          * @return string
1471          */
1472         public function mod_rewrite_rules() {
1473                 if ( ! $this->using_permalinks() )
1474                         return '';
1475
1476                 $site_root = parse_url( site_url() );
1477                 if ( isset( $site_root['path'] ) )
1478                         $site_root = trailingslashit($site_root['path']);
1479
1480                 $home_root = parse_url(home_url());
1481                 if ( isset( $home_root['path'] ) )
1482                         $home_root = trailingslashit($home_root['path']);
1483                 else
1484                         $home_root = '/';
1485
1486                 $rules = "<IfModule mod_rewrite.c>\n";
1487                 $rules .= "RewriteEngine On\n";
1488                 $rules .= "RewriteBase $home_root\n";
1489
1490                 // Prevent -f checks on index.php.
1491                 $rules .= "RewriteRule ^index\.php$ - [L]\n";
1492
1493                 // Add in the rules that don't redirect to WP's index.php (and thus shouldn't be handled by WP at all).
1494                 foreach ( (array) $this->non_wp_rules as $match => $query) {
1495                         // Apache 1.3 does not support the reluctant (non-greedy) modifier.
1496                         $match = str_replace('.+?', '.+', $match);
1497
1498                         $rules .= 'RewriteRule ^' . $match . ' ' . $home_root . $query . " [QSA,L]\n";
1499                 }
1500
1501                 if ( $this->use_verbose_rules ) {
1502                         $this->matches = '';
1503                         $rewrite = $this->rewrite_rules();
1504                         $num_rules = count($rewrite);
1505                         $rules .= "RewriteCond %{REQUEST_FILENAME} -f [OR]\n" .
1506                                 "RewriteCond %{REQUEST_FILENAME} -d\n" .
1507                                 "RewriteRule ^.*$ - [S=$num_rules]\n";
1508
1509                         foreach ( (array) $rewrite as $match => $query) {
1510                                 // Apache 1.3 does not support the reluctant (non-greedy) modifier.
1511                                 $match = str_replace('.+?', '.+', $match);
1512
1513                                 if ( strpos($query, $this->index) !== false )
1514                                         $rules .= 'RewriteRule ^' . $match . ' ' . $home_root . $query . " [QSA,L]\n";
1515                                 else
1516                                         $rules .= 'RewriteRule ^' . $match . ' ' . $site_root . $query . " [QSA,L]\n";
1517                         }
1518                 } else {
1519                         $rules .= "RewriteCond %{REQUEST_FILENAME} !-f\n" .
1520                                 "RewriteCond %{REQUEST_FILENAME} !-d\n" .
1521                                 "RewriteRule . {$home_root}{$this->index} [L]\n";
1522                 }
1523
1524                 $rules .= "</IfModule>\n";
1525
1526                 /**
1527                  * Filter the list of rewrite rules formatted for output to an .htaccess file.
1528                  *
1529                  * @since 1.5.0
1530                  *
1531                  * @param string $rules mod_rewrite Rewrite rules formatted for .htaccess.
1532                  */
1533                 $rules = apply_filters( 'mod_rewrite_rules', $rules );
1534
1535                 /**
1536                  * Filter the list of rewrite rules formatted for output to an .htaccess file.
1537                  *
1538                  * @since 1.5.0
1539                  * @deprecated 1.5.0 Use the mod_rewrite_rules filter instead.
1540                  *
1541                  * @param string $rules mod_rewrite Rewrite rules formatted for .htaccess.
1542                  */
1543                 return apply_filters( 'rewrite_rules', $rules );
1544         }
1545
1546         /**
1547          * Retrieves IIS7 URL Rewrite formatted rewrite rules to write to web.config file.
1548          *
1549          * Does not actually write to the web.config file, but creates the rules for
1550          * the process that will.
1551          *
1552          * @since 2.8.0
1553          * @access public
1554          *
1555          * @return string
1556          */
1557         public function iis7_url_rewrite_rules( $add_parent_tags = false ) {
1558                 if ( ! $this->using_permalinks() )
1559                         return '';
1560                 $rules = '';
1561                 if ( $add_parent_tags ) {
1562                         $rules .= '<configuration>
1563         <system.webServer>
1564                 <rewrite>
1565                         <rules>';
1566                 }
1567
1568                 $rules .= '
1569                         <rule name="wordpress" patternSyntax="Wildcard">
1570                                 <match url="*" />
1571                                         <conditions>
1572                                                 <add input="{REQUEST_FILENAME}" matchType="IsFile" negate="true" />
1573                                                 <add input="{REQUEST_FILENAME}" matchType="IsDirectory" negate="true" />
1574                                         </conditions>
1575                                 <action type="Rewrite" url="index.php" />
1576                         </rule>';
1577
1578                 if ( $add_parent_tags ) {
1579                         $rules .= '
1580                         </rules>
1581                 </rewrite>
1582         </system.webServer>
1583 </configuration>';
1584                 }
1585
1586                 /**
1587                  * Filter the list of rewrite rules formatted for output to a web.config.
1588                  *
1589                  * @since 2.8.0
1590                  *
1591                  * @param string $rules Rewrite rules formatted for IIS web.config.
1592                  */
1593                 return apply_filters( 'iis7_url_rewrite_rules', $rules );
1594         }
1595
1596         /**
1597          * Adds a rewrite rule that transforms a URL structure to a set of query vars.
1598          *
1599          * Any value in the $after parameter that isn't 'bottom' will result in the rule
1600          * being placed at the top of the rewrite rules.
1601          *
1602          * @since 2.1.0
1603          * @since 4.4.0 Array support was added to the `$query` parameter.
1604          * @access public
1605          *
1606          * @param string       $regex Regular expression to match request against.
1607          * @param string|array $query The corresponding query vars for this rewrite rule.
1608          * @param string       $after Optional. Priority of the new rule. Accepts 'top'
1609          *                            or 'bottom'. Default 'bottom'.
1610          */
1611         public function add_rule( $regex, $query, $after = 'bottom' ) {
1612                 if ( is_array( $query ) ) {
1613                         $external = false;
1614                         $query = add_query_arg( $query, 'index.php' );
1615                 } else {
1616                         $index = false === strpos( $query, '?' ) ? strlen( $query ) : strpos( $query, '?' );
1617                         $front = substr( $query, 0, $index );
1618
1619                         $external = $front != $this->index;
1620                 }
1621
1622                 // "external" = it doesn't correspond to index.php.
1623                 if ( $external ) {
1624                         $this->add_external_rule( $regex, $query );
1625                 } else {
1626                         if ( 'bottom' == $after ) {
1627                                 $this->extra_rules = array_merge( $this->extra_rules, array( $regex => $query ) );
1628                         } else {
1629                                 $this->extra_rules_top = array_merge( $this->extra_rules_top, array( $regex => $query ) );
1630                         }
1631                 }
1632         }
1633
1634         /**
1635          * Adds a rewrite rule that doesn't correspond to index.php.
1636          *
1637          * @since 2.1.0
1638          * @access public
1639          *
1640          * @param string $regex Regular expression to match request against.
1641          * @param string $query The corresponding query vars for this rewrite rule.
1642          */
1643         public function add_external_rule( $regex, $query ) {
1644                 $this->non_wp_rules[ $regex ] = $query;
1645         }
1646
1647         /**
1648          * Adds an endpoint, like /trackback/.
1649          *
1650          * @since 2.1.0
1651          * @since 3.9.0 $query_var parameter added.
1652          * @since 4.3.0 Added support for skipping query var registration by passing `false` to `$query_var`.
1653          * @access public
1654          *
1655          * @see add_rewrite_endpoint() for full documentation.
1656          * @global WP $wp
1657          *
1658          * @param string      $name      Name of the endpoint.
1659          * @param int         $places    Endpoint mask describing the places the endpoint should be added.
1660          * @param string|bool $query_var Optional. Name of the corresponding query variable. Pass `false` to
1661          *                               skip registering a query_var for this endpoint. Defaults to the
1662          *                               value of `$name`.
1663          */
1664         public function add_endpoint( $name, $places, $query_var = true ) {
1665                 global $wp;
1666
1667                 // For backward compatibility, if null has explicitly been passed as `$query_var`, assume `true`.
1668                 if ( true === $query_var || null === func_get_arg( 2 ) ) {
1669                         $query_var = $name;
1670                 }
1671                 $this->endpoints[] = array( $places, $name, $query_var );
1672
1673                 if ( $query_var ) {
1674                         $wp->add_query_var( $query_var );
1675                 }
1676         }
1677
1678         /**
1679          * Adds a new permalink structure.
1680          *
1681          * A permalink structure (permastruct) is an abstract definition of a set of rewrite rules;
1682          * it is an easy way of expressing a set of regular expressions that rewrite to a set of
1683          * query strings. The new permastruct is added to the WP_Rewrite::$extra_permastructs array.
1684          *
1685          * When the rewrite rules are built by WP_Rewrite::rewrite_rules(), all of these extra
1686          * permastructs are passed to WP_Rewrite::generate_rewrite_rules() which transforms them
1687          * into the regular expressions that many love to hate.
1688          *
1689          * The `$args` parameter gives you control over how WP_Rewrite::generate_rewrite_rules()
1690          * works on the new permastruct.
1691          *
1692          * @since 2.5.0
1693          * @access public
1694          *
1695          * @param string $name   Name for permalink structure.
1696          * @param string $struct Permalink structure (e.g. category/%category%)
1697          * @param array  $args   {
1698          *     Optional. Arguments for building rewrite rules based on the permalink structure.
1699          *     Default empty array.
1700          *
1701          *     @type bool $with_front  Whether the structure should be prepended with `WP_Rewrite::$front`.
1702          *                             Default true.
1703          *     @type int  $ep_mask     The endpoint mask defining which endpoints are added to the structure.
1704          *                             Accepts `EP_NONE`, `EP_PERMALINK`, `EP_ATTACHMENT`, `EP_DATE`, `EP_YEAR`,
1705          *                             `EP_MONTH`, `EP_DAY`, `EP_ROOT`, `EP_COMMENTS`, `EP_SEARCH`, `EP_CATEGORIES`,
1706          *                             `EP_TAGS`, `EP_AUTHORS`, `EP_PAGES`, `EP_ALL_ARCHIVES`, and `EP_ALL`.
1707          *                             Default `EP_NONE`.
1708          *     @type bool $paged       Whether archive pagination rules should be added for the structure.
1709          *                             Default true.
1710          *     @type bool $feed        Whether feed rewrite rules should be added for the structure. Default true.
1711          *     @type bool $forcomments Whether the feed rules should be a query for a comments feed. Default false.
1712          *     @type bool $walk_dirs   Whether the 'directories' making up the structure should be walked over
1713          *                             and rewrite rules built for each in-turn. Default true.
1714          *     @type bool $endpoints   Whether endpoints should be applied to the generated rules. Default true.
1715          * }
1716          */
1717         public function add_permastruct( $name, $struct, $args = array() ) {
1718                 // Backwards compatibility for the old parameters: $with_front and $ep_mask.
1719                 if ( ! is_array( $args ) )
1720                         $args = array( 'with_front' => $args );
1721                 if ( func_num_args() == 4 )
1722                         $args['ep_mask'] = func_get_arg( 3 );
1723
1724                 $defaults = array(
1725                         'with_front' => true,
1726                         'ep_mask' => EP_NONE,
1727                         'paged' => true,
1728                         'feed' => true,
1729                         'forcomments' => false,
1730                         'walk_dirs' => true,
1731                         'endpoints' => true,
1732                 );
1733                 $args = array_intersect_key( $args, $defaults );
1734                 $args = wp_parse_args( $args, $defaults );
1735
1736                 if ( $args['with_front'] )
1737                         $struct = $this->front . $struct;
1738                 else
1739                         $struct = $this->root . $struct;
1740                 $args['struct'] = $struct;
1741
1742                 $this->extra_permastructs[ $name ] = $args;
1743         }
1744
1745         /**
1746          * Removes rewrite rules and then recreate rewrite rules.
1747          *
1748          * Calls WP_Rewrite::wp_rewrite_rules() after removing the 'rewrite_rules' option.
1749          * If the function named 'save_mod_rewrite_rules' exists, it will be called.
1750          *
1751          * @since 2.0.1
1752          * @access public
1753          *
1754          * @staticvar bool $do_hard_later
1755          *
1756          * @param bool $hard Whether to update .htaccess (hard flush) or just update rewrite_rules option (soft flush). Default is true (hard).
1757          */
1758         public function flush_rules( $hard = true ) {
1759                 static $do_hard_later = null;
1760
1761                 // Prevent this action from running before everyone has registered their rewrites.
1762                 if ( ! did_action( 'wp_loaded' ) ) {
1763                         add_action( 'wp_loaded', array( $this, 'flush_rules' ) );
1764                         $do_hard_later = ( isset( $do_hard_later ) ) ? $do_hard_later || $hard : $hard;
1765                         return;
1766                 }
1767
1768                 if ( isset( $do_hard_later ) ) {
1769                         $hard = $do_hard_later;
1770                         unset( $do_hard_later );
1771                 }
1772
1773                 delete_option('rewrite_rules');
1774                 $this->wp_rewrite_rules();
1775
1776                 /**
1777                  * Filter whether a "hard" rewrite rule flush should be performed when requested.
1778                  *
1779                  * A "hard" flush updates .htaccess (Apache) or web.config (IIS).
1780                  *
1781                  * @since 3.7.0
1782                  *
1783                  * @param bool $hard Whether to flush rewrite rules "hard". Default true.
1784                  */
1785                 if ( ! $hard || ! apply_filters( 'flush_rewrite_rules_hard', true ) ) {
1786                         return;
1787                 }
1788                 if ( function_exists( 'save_mod_rewrite_rules' ) )
1789                         save_mod_rewrite_rules();
1790                 if ( function_exists( 'iis7_save_url_rewrite_rules' ) )
1791                         iis7_save_url_rewrite_rules();
1792         }
1793
1794         /**
1795          * Sets up the object's properties.
1796          *
1797          * The 'use_verbose_page_rules' object property will be set to true if the
1798          * permalink structure begins with one of the following: '%postname%', '%category%',
1799          * '%tag%', or '%author%'.
1800          *
1801          * @since 1.5.0
1802          * @access public
1803          */
1804         public function init() {
1805                 $this->extra_rules = $this->non_wp_rules = $this->endpoints = array();
1806                 $this->permalink_structure = get_option('permalink_structure');
1807                 $this->front = substr($this->permalink_structure, 0, strpos($this->permalink_structure, '%'));
1808                 $this->root = '';
1809
1810                 if ( $this->using_index_permalinks() )
1811                         $this->root = $this->index . '/';
1812
1813                 unset($this->author_structure);
1814                 unset($this->date_structure);
1815                 unset($this->page_structure);
1816                 unset($this->search_structure);
1817                 unset($this->feed_structure);
1818                 unset($this->comment_feed_structure);
1819                 $this->use_trailing_slashes = ( '/' == substr($this->permalink_structure, -1, 1) );
1820
1821                 // Enable generic rules for pages if permalink structure doesn't begin with a wildcard.
1822                 if ( preg_match("/^[^%]*%(?:postname|category|tag|author)%/", $this->permalink_structure) )
1823                          $this->use_verbose_page_rules = true;
1824                 else
1825                         $this->use_verbose_page_rules = false;
1826         }
1827
1828         /**
1829          * Sets the main permalink structure for the site.
1830          *
1831          * Will update the 'permalink_structure' option, if there is a difference
1832          * between the current permalink structure and the parameter value. Calls
1833          * WP_Rewrite::init() after the option is updated.
1834          *
1835          * Fires the 'permalink_structure_changed' action once the init call has
1836          * processed passing the old and new values
1837          *
1838          * @since 1.5.0
1839          * @access public
1840          *
1841          * @param string $permalink_structure Permalink structure.
1842          */
1843         public function set_permalink_structure($permalink_structure) {
1844                 if ( $permalink_structure != $this->permalink_structure ) {
1845                         $old_permalink_structure = $this->permalink_structure;
1846                         update_option('permalink_structure', $permalink_structure);
1847
1848                         $this->init();
1849
1850                         /**
1851                          * Fires after the permalink structure is updated.
1852                          *
1853                          * @since 2.8.0
1854                          *
1855                          * @param string $old_permalink_structure The previous permalink structure.
1856                          * @param string $permalink_structure     The new permalink structure.
1857                          */
1858                         do_action( 'permalink_structure_changed', $old_permalink_structure, $permalink_structure );
1859                 }
1860         }
1861
1862         /**
1863          * Sets the category base for the category permalink.
1864          *
1865          * Will update the 'category_base' option, if there is a difference between
1866          * the current category base and the parameter value. Calls WP_Rewrite::init()
1867          * after the option is updated.
1868          *
1869          * @since 1.5.0
1870          * @access public
1871          *
1872          * @param string $category_base Category permalink structure base.
1873          */
1874         public function set_category_base($category_base) {
1875                 if ( $category_base != get_option('category_base') ) {
1876                         update_option('category_base', $category_base);
1877                         $this->init();
1878                 }
1879         }
1880
1881         /**
1882          * Sets the tag base for the tag permalink.
1883          *
1884          * Will update the 'tag_base' option, if there is a difference between the
1885          * current tag base and the parameter value. Calls WP_Rewrite::init() after
1886          * the option is updated.
1887          *
1888          * @since 2.3.0
1889          * @access public
1890          *
1891          * @param string $tag_base Tag permalink structure base.
1892          */
1893         public function set_tag_base( $tag_base ) {
1894                 if ( $tag_base != get_option( 'tag_base') ) {
1895                         update_option( 'tag_base', $tag_base );
1896                         $this->init();
1897                 }
1898         }
1899
1900         /**
1901          * Constructor - Calls init(), which runs setup.
1902          *
1903          * @since 1.5.0
1904          * @access public
1905          *
1906          */
1907         public function __construct() {
1908                 $this->init();
1909         }
1910 }