3 * WordPress Rewrite API
10 * Add a straight rewrite rule.
12 * @see WP_Rewrite::add_rule() for long description.
15 * @param string $regex Regular Expression to match request against.
16 * @param string $redirect Page to redirect to.
17 * @param string $after Optional, default is 'bottom'. Where to add rule, can also be 'top'.
19 function add_rewrite_rule($regex, $redirect, $after = 'bottom') {
21 $wp_rewrite->add_rule($regex, $redirect, $after);
25 * Add a new tag (like %postname%).
27 * Warning: you must call this on init or earlier, otherwise the query var
28 * addition stuff won't work.
32 * @param string $tagname
33 * @param string $regex
35 function add_rewrite_tag($tagname, $regex) {
37 if (strlen($tagname) < 3 || $tagname{0} != '%' || $tagname{strlen($tagname)-1} != '%') {
41 $qv = trim($tagname, '%');
43 global $wp_rewrite, $wp;
44 $wp->add_query_var($qv);
45 $wp_rewrite->add_rewrite_tag($tagname, $regex, $qv . '=');
49 * Add a new feed type like /atom1/.
53 * @param string $feedname
54 * @param callback $function Callback to run on feed display.
55 * @return string Feed action name.
57 function add_feed($feedname, $function) {
59 if (!in_array($feedname, $wp_rewrite->feeds)) { //override the file if it is
60 $wp_rewrite->feeds[] = $feedname;
62 $hook = 'do_feed_' . $feedname;
63 // Remove default function hook
64 remove_action($hook, $hook, 10, 1);
65 add_action($hook, $function, 10, 1);
70 * Endpoint Mask for Permalink.
74 define('EP_PERMALINK', 1);
77 * Endpoint Mask for Attachment.
81 define('EP_ATTACHMENT', 2);
84 * Endpoint Mask for date.
91 * Endpoint Mask for year
98 * Endpoint Mask for month.
102 define('EP_MONTH', 16);
105 * Endpoint Mask for day.
109 define('EP_DAY', 32);
112 * Endpoint Mask for root.
116 define('EP_ROOT', 64);
119 * Endpoint Mask for comments.
123 define('EP_COMMENTS', 128);
126 * Endpoint Mask for searches.
130 define('EP_SEARCH', 256);
133 * Endpoint Mask for categories.
137 define('EP_CATEGORIES', 512);
140 * Endpoint Mask for tags.
144 define('EP_TAGS', 1024);
147 * Endpoint Mask for authors.
151 define('EP_AUTHORS', 2048);
154 * Endpoint Mask for pages.
158 define('EP_PAGES', 4096);
162 * Endpoint Mask for default, which is nothing.
166 define('EP_NONE', 0);
169 * Endpoint Mask for everything.
173 define('EP_ALL', 8191);
176 * Add an endpoint, like /trackback/.
178 * The endpoints are added to the end of the request. So a request matching
179 * "/2008/10/14/my_post/myep/", the endpoint will be "/myep/".
182 * @see WP_Rewrite::add_endpoint() Parameters and more description.
185 * @param unknown_type $name
186 * @param unknown_type $places
188 function add_rewrite_endpoint($name, $places) {
190 $wp_rewrite->add_endpoint($name, $places);
194 * Filter the URL base for taxonomies.
196 * To remove any manually prepended /index.php/.
200 * @author Mark Jaquith
202 * @param string $base The taxonomy base that we're going to filter
205 function _wp_filter_taxonomy_base( $base ) {
206 if ( !empty( $base ) ) {
207 $base = preg_replace( '|^/index\.php/|', '', $base );
208 $base = trim( $base, '/' );
214 * Examine a url and try to determine the post ID it represents.
216 * Checks are supposedly from the hosted site blog.
220 * @param string $url Permalink to check.
221 * @return int Post ID, or 0 on failure.
223 function url_to_postid($url) {
226 $url = apply_filters('url_to_postid', $url);
228 // First, check to see if there is a 'p=N' or 'page_id=N' to match against
229 if ( preg_match('#[?&](p|page_id|attachment_id)=(\d+)#', $url, $values) ) {
230 $id = absint($values[2]);
235 // Check to see if we are using rewrite rules
236 $rewrite = $wp_rewrite->wp_rewrite_rules();
238 // Not using rewrite rules, and 'p=N' and 'page_id=N' methods failed, so we're out of options
239 if ( empty($rewrite) )
242 // $url cleanup by Mark Jaquith
243 // This fixes things like #anchors, ?query=strings, missing 'www.',
244 // added 'www.', or added 'index.php/' that will mess up our WP_Query
245 // and return a false negative
247 // Get rid of the #anchor
248 $url_split = explode('#', $url);
249 $url = $url_split[0];
251 // Get rid of URL ?query=string
252 $url_split = explode('?', $url);
253 $url = $url_split[0];
255 // Add 'www.' if it is absent and should be there
256 if ( false !== strpos(get_option('home'), '://www.') && false === strpos($url, '://www.') )
257 $url = str_replace('://', '://www.', $url);
259 // Strip 'www.' if it is present and shouldn't be
260 if ( false === strpos(get_option('home'), '://www.') )
261 $url = str_replace('://www.', '://', $url);
263 // Strip 'index.php/' if we're not using path info permalinks
264 if ( !$wp_rewrite->using_index_permalinks() )
265 $url = str_replace('index.php/', '', $url);
267 if ( false !== strpos($url, get_option('home')) ) {
268 // Chop off http://domain.com
269 $url = str_replace(get_option('home'), '', $url);
271 // Chop off /path/to/blog
272 $home_path = parse_url(get_option('home'));
273 $home_path = $home_path['path'];
274 $url = str_replace($home_path, '', $url);
277 // Trim leading and lagging slashes
278 $url = trim($url, '/');
285 $request_match = $request;
286 foreach ($rewrite as $match => $query) {
287 // If the requesting file is the anchor of the match, prepend it
289 if ( (! empty($url)) && (strpos($match, $url) === 0) && ($url != $request)) {
290 $request_match = $url . '/' . $request;
293 if ( preg_match("!^$match!", $request_match, $matches) ) {
295 // Trim the query of everything up to the '?'.
296 $query = preg_replace("!^.+\?!", '', $query);
298 // Substitute the substring matches into the query.
299 eval("\$query = \"" . addslashes($query) . "\";");
300 // Filter out non-public query vars
302 parse_str($query, $query_vars);
304 foreach ( (array) $query_vars as $key => $value ) {
305 if ( in_array($key, $wp->public_query_vars) )
306 $query[$key] = $value;
309 $query = new WP_Query($query);
310 if ( $query->is_single || $query->is_page )
311 return $query->post->ID;
320 * WordPress Rewrite Component.
322 * The WordPress Rewrite class writes the rewrite module rules to the .htaccess
323 * file. It also handles parsing the request to get the correct setup for the
324 * WordPress Query class.
326 * The Rewrite along with WP class function as a front controller for WordPress.
327 * You can add rules to trigger your page view and processing using this
328 * component. The full functionality of a front controller does not exist,
329 * meaning you can't define how the template files load based on the rewrite
336 * Default permalink structure for WordPress.
342 var $permalink_structure;
345 * Whether to add trailing slashes.
351 var $use_trailing_slashes;
354 * Customized or default category permalink base ( example.com/xx/tagname ).
363 * Customized or default tag permalink base ( example.com/xx/tagname ).
372 * Permalink request structure for categories.
378 var $category_structure;
381 * Permalink request structure for tags.
390 * Permalink author request base ( example.com/author/authorname ).
396 var $author_base = 'author';
399 * Permalink request structure for author pages.
405 var $author_structure;
408 * Permalink request structure for dates.
417 * Permalink request structure for pages.
426 * Search permalink base ( example.com/search/query ).
432 var $search_base = 'search';
435 * Permalink request structure for searches.
441 var $search_structure;
444 * Comments permalink base.
450 var $comments_base = 'comments';
453 * Feed permalink base.
459 var $feed_base = 'feed';
462 * Comments feed request structure permalink.
468 var $comments_feed_structure;
471 * Feed request structure permalink.
482 * The difference between the root property is that WordPress might be
483 * located at example/WordPress/index.php, if permalinks are turned off. The
484 * WordPress/index.php will be the front portion. If permalinks are turned
485 * on, this will most likely be empty or not set.
494 * Root URL path to WordPress (without domain).
496 * The difference between front property is that WordPress might be located
497 * at example.com/WordPress/. The root is the 'WordPress/' portion.
506 * Permalink to the home page.
512 var $index = 'index.php';
515 * Request match string.
524 * Rewrite rules to match against the request to find the redirect or query.
533 * Additional rules added external to the rewrite class.
535 * Those not generated by the class, see add_rewrite_rule().
541 var $extra_rules = array(); //
544 * Additional rules that belong at the beginning to match first.
546 * Those not generated by the class, see add_rewrite_rule().
552 var $extra_rules_top = array(); //
555 * Rules that don't redirect to WP's index.php.
557 * These rules are written to the mod_rewrite portion of the .htaccess.
563 var $non_wp_rules = array(); //
566 * Extra permalink structures.
572 var $extra_permastructs = array();
575 * Endpoints permalinks
584 * Whether to write every mod_rewrite rule for WordPress.
586 * This is off by default, turning it on might print a lot of rewrite rules
587 * to the .htaccess file.
593 var $use_verbose_rules = false;
596 * Whether to write every mod_rewrite rule for WordPress pages.
602 var $use_verbose_page_rules = true;
605 * Permalink structure search for preg_replace.
629 * Preg_replace values for the search, see {@link WP_Rewrite::$rewritecode}.
635 var $rewritereplace =
653 * Search for the query to look for replacing.
677 * Supported default feeds.
683 var $feeds = array ( 'feed', 'rdf', 'rss', 'rss2', 'atom' );
686 * Whether permalinks are being used.
688 * This can be either rewrite module or permalink in the HTTP query string.
693 * @return bool True, if permalinks are enabled.
695 function using_permalinks() {
696 if (empty($this->permalink_structure))
703 * Whether permalinks are being used and rewrite module is not enabled.
705 * Means that permalink links are enabled and index.php is in the URL.
712 function using_index_permalinks() {
713 if (empty($this->permalink_structure)) {
717 // If the index is not in the permalink, we're using mod_rewrite.
718 if (preg_match('#^/*' . $this->index . '#', $this->permalink_structure)) {
726 * Whether permalinks are being used and rewrite module is enabled.
728 * Using permalinks and index.php is not in the URL.
735 function using_mod_rewrite_permalinks() {
736 if ( $this->using_permalinks() && ! $this->using_index_permalinks())
743 * Index for matches for usage in preg_*() functions.
745 * The format of the string is, with empty matches property value, '$NUM'.
746 * The 'NUM' will be replaced with the value in the $number parameter. With
747 * the matches property not empty, the value of the returned string will
748 * contain that value of the matches property. The format then will be
749 * '$MATCHES[NUM]', with MATCHES as the value in the property and NUM the
750 * value of the $number parameter.
755 * @param int $number Index number.
758 function preg_index($number) {
762 if ( ! empty($this->matches) ) {
763 $match_prefix = '$' . $this->matches . '[';
767 return "$match_prefix$number$match_suffix";
771 * Retrieve all page and attachments for pages URIs.
773 * The attachments are for those that have pages as parents and will be
779 * @return array Array of page URIs as first element and attachment URIs as second element.
781 function page_uri_index() {
784 //get pages in order of hierarchy, i.e. children after parents
785 $posts = get_page_hierarchy($wpdb->get_results("SELECT ID, post_name, post_parent FROM $wpdb->posts WHERE post_type = 'page'"));
786 //now reverse it, because we need parents after children for rewrite rules to work properly
787 $posts = array_reverse($posts, true);
789 $page_uris = array();
790 $page_attachment_uris = array();
793 return array( array(), array() );
795 foreach ($posts as $id => $post) {
797 $uri = get_page_uri($id);
798 $attachments = $wpdb->get_results( $wpdb->prepare( "SELECT ID, post_name, post_parent FROM $wpdb->posts WHERE post_type = 'attachment' AND post_parent = %d", $id ));
799 if ( $attachments ) {
800 foreach ( $attachments as $attachment ) {
801 $attach_uri = get_page_uri($attachment->ID);
802 $page_attachment_uris[$attach_uri] = $attachment->ID;
806 $page_uris[$uri] = $id;
809 return array( $page_uris, $page_attachment_uris );
813 * Retrieve all of the rewrite rules for pages.
815 * If the 'use_verbose_page_rules' property is false, then there will only
816 * be a single rewrite rule for pages for those matching '%pagename%'. With
817 * the property set to true, the attachments and the pages will be added for
818 * each individual attachment URI and page URI, respectively.
825 function page_rewrite_rules() {
826 $rewrite_rules = array();
827 $page_structure = $this->get_page_permastruct();
829 if ( ! $this->use_verbose_page_rules ) {
830 $this->add_rewrite_tag('%pagename%', "(.+?)", 'pagename=');
831 $rewrite_rules = array_merge($rewrite_rules, $this->generate_rewrite_rules($page_structure, EP_PAGES));
832 return $rewrite_rules;
835 $page_uris = $this->page_uri_index();
836 $uris = $page_uris[0];
837 $attachment_uris = $page_uris[1];
839 if( is_array( $attachment_uris ) ) {
840 foreach ($attachment_uris as $uri => $pagename) {
841 $this->add_rewrite_tag('%pagename%', "($uri)", 'attachment=');
842 $rewrite_rules = array_merge($rewrite_rules, $this->generate_rewrite_rules($page_structure, EP_PAGES));
845 if( is_array( $uris ) ) {
846 foreach ($uris as $uri => $pagename) {
847 $this->add_rewrite_tag('%pagename%', "($uri)", 'pagename=');
848 $rewrite_rules = array_merge($rewrite_rules, $this->generate_rewrite_rules($page_structure, EP_PAGES));
852 return $rewrite_rules;
856 * Retrieve date permalink structure, with year, month, and day.
858 * The permalink structure for the date, if not set already depends on the
859 * permalink structure. It can be one of three formats. The first is year,
860 * month, day; the second is day, month, year; and the last format is month,
861 * day, year. These are matched against the permalink structure for which
862 * one is used. If none matches, then the default will be used, which is
865 * Prevents post ID and date permalinks from overlapping. In the case of
866 * post_id, the date permalink will be prepended with front permalink with
867 * 'date/' before the actual permalink to form the complete date permalink
873 * @return bool|string False on no permalink structure. Date permalink structure.
875 function get_date_permastruct() {
876 if (isset($this->date_structure)) {
877 return $this->date_structure;
880 if (empty($this->permalink_structure)) {
881 $this->date_structure = '';
885 // The date permalink must have year, month, and day separated by slashes.
886 $endians = array('%year%/%monthnum%/%day%', '%day%/%monthnum%/%year%', '%monthnum%/%day%/%year%');
888 $this->date_structure = '';
891 foreach ($endians as $endian) {
892 if (false !== strpos($this->permalink_structure, $endian)) {
893 $date_endian= $endian;
898 if ( empty($date_endian) )
899 $date_endian = '%year%/%monthnum%/%day%';
901 // Do not allow the date tags and %post_id% to overlap in the permalink
902 // structure. If they do, move the date tags to $front/date/.
903 $front = $this->front;
904 preg_match_all('/%.+?%/', $this->permalink_structure, $tokens);
906 foreach ( (array) $tokens[0] as $token) {
907 if ( ($token == '%post_id%') && ($tok_index <= 3) ) {
908 $front = $front . 'date/';
914 $this->date_structure = $front . $date_endian;
916 return $this->date_structure;
920 * Retrieve the year permalink structure without month and day.
922 * Gets the date permalink structure and strips out the month and day
923 * permalink structures.
928 * @return bool|string False on failure. Year structure on success.
930 function get_year_permastruct() {
931 $structure = $this->get_date_permastruct($this->permalink_structure);
933 if (empty($structure)) {
937 $structure = str_replace('%monthnum%', '', $structure);
938 $structure = str_replace('%day%', '', $structure);
940 $structure = preg_replace('#/+#', '/', $structure);
946 * Retrieve the month permalink structure without day and with year.
948 * Gets the date permalink structure and strips out the day permalink
949 * structures. Keeps the year permalink structure.
954 * @return bool|string False on failure. Year/Month structure on success.
956 function get_month_permastruct() {
957 $structure = $this->get_date_permastruct($this->permalink_structure);
959 if (empty($structure)) {
963 $structure = str_replace('%day%', '', $structure);
965 $structure = preg_replace('#/+#', '/', $structure);
971 * Retrieve the day permalink structure with month and year.
973 * Keeps date permalink structure with all year, month, and day.
978 * @return bool|string False on failure. Year/Month/Day structure on success.
980 function get_day_permastruct() {
981 return $this->get_date_permastruct($this->permalink_structure);
985 * Retrieve the permalink structure for categories.
987 * If the category_base property has no value, then the category structure
988 * will have the front property value, followed by 'category', and finally
989 * '%category%'. If it does, then the root property will be used, along with
990 * the category_base property value.
995 * @return bool|string False on failure. Category permalink structure.
997 function get_category_permastruct() {
998 if (isset($this->category_structure)) {
999 return $this->category_structure;
1002 if (empty($this->permalink_structure)) {
1003 $this->category_structure = '';
1007 if (empty($this->category_base))
1008 $this->category_structure = trailingslashit( $this->front . 'category' );
1010 $this->category_structure = trailingslashit( '/' . $this->root . $this->category_base );
1012 $this->category_structure .= '%category%';
1014 return $this->category_structure;
1018 * Retrieve the permalink structure for tags.
1020 * If the tag_base property has no value, then the tag structure will have
1021 * the front property value, followed by 'tag', and finally '%tag%'. If it
1022 * does, then the root property will be used, along with the tag_base
1028 * @return bool|string False on failure. Tag permalink structure.
1030 function get_tag_permastruct() {
1031 if (isset($this->tag_structure)) {
1032 return $this->tag_structure;
1035 if (empty($this->permalink_structure)) {
1036 $this->tag_structure = '';
1040 if (empty($this->tag_base))
1041 $this->tag_structure = trailingslashit( $this->front . 'tag' );
1043 $this->tag_structure = trailingslashit( '/' . $this->root . $this->tag_base );
1045 $this->tag_structure .= '%tag%';
1047 return $this->tag_structure;
1051 * Retrieve extra permalink structure by name.
1056 * @param string $name Permalink structure name.
1057 * @return string|bool False if not found. Permalink structure string.
1059 function get_extra_permastruct($name) {
1060 if ( isset($this->extra_permastructs[$name]) )
1061 return $this->extra_permastructs[$name];
1066 * Retrieve the author permalink structure.
1068 * The permalink structure is front property, author base, and finally
1069 * '/%author%'. Will set the author_structure property and then return it
1070 * without attempting to set the value again.
1075 * @return string|bool False if not found. Permalink structure string.
1077 function get_author_permastruct() {
1078 if (isset($this->author_structure)) {
1079 return $this->author_structure;
1082 if (empty($this->permalink_structure)) {
1083 $this->author_structure = '';
1087 $this->author_structure = $this->front . $this->author_base . '/%author%';
1089 return $this->author_structure;
1093 * Retrieve the search permalink structure.
1095 * The permalink structure is root property, search base, and finally
1096 * '/%search%'. Will set the search_structure property and then return it
1097 * without attempting to set the value again.
1102 * @return string|bool False if not found. Permalink structure string.
1104 function get_search_permastruct() {
1105 if (isset($this->search_structure)) {
1106 return $this->search_structure;
1109 if (empty($this->permalink_structure)) {
1110 $this->search_structure = '';
1114 $this->search_structure = $this->root . $this->search_base . '/%search%';
1116 return $this->search_structure;
1120 * Retrieve the page permalink structure.
1122 * The permalink structure is root property, and '%pagename%'. Will set the
1123 * page_structure property and then return it without attempting to set the
1129 * @return string|bool False if not found. Permalink structure string.
1131 function get_page_permastruct() {
1132 if (isset($this->page_structure)) {
1133 return $this->page_structure;
1136 if (empty($this->permalink_structure)) {
1137 $this->page_structure = '';
1141 $this->page_structure = $this->root . '%pagename%';
1143 return $this->page_structure;
1147 * Retrieve the feed permalink structure.
1149 * The permalink structure is root property, feed base, and finally
1150 * '/%feed%'. Will set the feed_structure property and then return it
1151 * without attempting to set the value again.
1156 * @return string|bool False if not found. Permalink structure string.
1158 function get_feed_permastruct() {
1159 if (isset($this->feed_structure)) {
1160 return $this->feed_structure;
1163 if (empty($this->permalink_structure)) {
1164 $this->feed_structure = '';
1168 $this->feed_structure = $this->root . $this->feed_base . '/%feed%';
1170 return $this->feed_structure;
1174 * Retrieve the comment feed permalink structure.
1176 * The permalink structure is root property, comment base property, feed
1177 * base and finally '/%feed%'. Will set the comment_feed_structure property
1178 * and then return it without attempting to set the value again.
1183 * @return string|bool False if not found. Permalink structure string.
1185 function get_comment_feed_permastruct() {
1186 if (isset($this->comment_feed_structure)) {
1187 return $this->comment_feed_structure;
1190 if (empty($this->permalink_structure)) {
1191 $this->comment_feed_structure = '';
1195 $this->comment_feed_structure = $this->root . $this->comments_base . '/' . $this->feed_base . '/%feed%';
1197 return $this->comment_feed_structure;
1201 * Append or update tag, pattern, and query for replacement.
1203 * If the tag already exists, replace the existing pattern and query for
1204 * that tag, otherwise add the new tag, pattern, and query to the end of the
1207 * @internal What is the purpose of this function again? Need to finish long
1213 * @param string $tag Append tag to rewritecode property array.
1214 * @param string $pattern Append pattern to rewritereplace property array.
1215 * @param string $query Append query to queryreplace property array.
1217 function add_rewrite_tag($tag, $pattern, $query) {
1218 $position = array_search($tag, $this->rewritecode);
1219 if ( false !== $position && null !== $position ) {
1220 $this->rewritereplace[$position] = $pattern;
1221 $this->queryreplace[$position] = $query;
1223 $this->rewritecode[] = $tag;
1224 $this->rewritereplace[] = $pattern;
1225 $this->queryreplace[] = $query;
1230 * Generate the rules from permalink structure.
1232 * The main WP_Rewrite function for building the rewrite rule list. The
1233 * contents of the function is a mix of black magic and regular expressions,
1234 * so best just ignore the contents and move to the parameters.
1239 * @param string $permalink_structure The permalink structure.
1240 * @param int $ep_mask Optional, default is EP_NONE. Endpoint constant, see EP_* constants.
1241 * @param bool $paged Optional, default is true. Whether permalink request is paged.
1242 * @param bool $feed Optional, default is true. Whether for feed.
1243 * @param bool $forcomments Optional, default is false. Whether for comments.
1244 * @param bool $walk_dirs Optional, default is true. Whether to create list of directories to walk over.
1245 * @param bool $endpoints Optional, default is true. Whether endpoints are enabled.
1246 * @return array Rewrite rule list.
1248 function generate_rewrite_rules($permalink_structure, $ep_mask = EP_NONE, $paged = true, $feed = true, $forcomments = false, $walk_dirs = true, $endpoints = true) {
1249 //build a regex to match the feed section of URLs, something like (feed|atom|rss|rss2)/?
1251 foreach ( (array) $this->feeds as $feed_name) {
1252 $feedregex2 .= $feed_name . '|';
1254 $feedregex2 = '(' . trim($feedregex2, '|') . ')/?$';
1255 //$feedregex is identical but with /feed/ added on as well, so URLs like <permalink>/feed/atom
1256 //and <permalink>/atom are both possible
1257 $feedregex = $this->feed_base . '/' . $feedregex2;
1259 //build a regex to match the trackback and page/xx parts of URLs
1260 $trackbackregex = 'trackback/?$';
1261 $pageregex = 'page/?([0-9]{1,})/?$';
1262 $commentregex = 'comment-page-([0-9]{1,})/?$';
1264 //build up an array of endpoint regexes to append => queries to append
1266 $ep_query_append = array ();
1267 foreach ( (array) $this->endpoints as $endpoint) {
1268 //match everything after the endpoint name, but allow for nothing to appear there
1269 $epmatch = $endpoint[1] . '(/(.*))?/?$';
1270 //this will be appended on to the rest of the query for each dir
1271 $epquery = '&' . $endpoint[1] . '=';
1272 $ep_query_append[$epmatch] = array ( $endpoint[0], $epquery );
1276 //get everything up to the first rewrite tag
1277 $front = substr($permalink_structure, 0, strpos($permalink_structure, '%'));
1278 //build an array of the tags (note that said array ends up being in $tokens[0])
1279 preg_match_all('/%.+?%/', $permalink_structure, $tokens);
1281 $num_tokens = count($tokens[0]);
1283 $index = $this->index; //probably 'index.php'
1284 $feedindex = $index;
1285 $trackbackindex = $index;
1286 //build a list from the rewritecode and queryreplace arrays, that will look something like
1287 //tagname=$matches[i] where i is the current $i
1288 for ($i = 0; $i < $num_tokens; ++$i) {
1290 $queries[$i] = $queries[$i - 1] . '&';
1295 $query_token = str_replace($this->rewritecode, $this->queryreplace, $tokens[0][$i]) . $this->preg_index($i+1);
1296 $queries[$i] .= $query_token;
1299 //get the structure, minus any cruft (stuff that isn't tags) at the front
1300 $structure = $permalink_structure;
1301 if ($front != '/') {
1302 $structure = str_replace($front, '', $structure);
1304 //create a list of dirs to walk over, making rewrite rules for each level
1305 //so for example, a $structure of /%year%/%month%/%postname% would create
1306 //rewrite rules for /%year%/, /%year%/%month%/ and /%year%/%month%/%postname%
1307 $structure = trim($structure, '/');
1309 $dirs = explode('/', $structure);
1311 $dirs[] = $structure;
1313 $num_dirs = count($dirs);
1315 //strip slashes from the front of $front
1316 $front = preg_replace('|^/+|', '', $front);
1318 //the main workhorse loop
1319 $post_rewrite = array();
1321 for ($j = 0; $j < $num_dirs; ++$j) {
1322 //get the struct for this dir, and trim slashes off the front
1323 $struct .= $dirs[$j] . '/'; //accumulate. see comment near explode('/', $structure) above
1324 $struct = ltrim($struct, '/');
1325 //replace tags with regexes
1326 $match = str_replace($this->rewritecode, $this->rewritereplace, $struct);
1327 //make a list of tags, and store how many there are in $num_toks
1328 $num_toks = preg_match_all('/%.+?%/', $struct, $toks);
1329 //get the 'tagname=$matches[i]'
1330 $query = ( isset($queries) && is_array($queries) ) ? $queries[$num_toks - 1] : '';
1332 //set up $ep_mask_specific which is used to match more specific URL types
1333 switch ($dirs[$j]) {
1334 case '%year%': $ep_mask_specific = EP_YEAR; break;
1335 case '%monthnum%': $ep_mask_specific = EP_MONTH; break;
1336 case '%day%': $ep_mask_specific = EP_DAY; break;
1339 //create query for /page/xx
1340 $pagematch = $match . $pageregex;
1341 $pagequery = $index . '?' . $query . '&paged=' . $this->preg_index($num_toks + 1);
1343 //create query for /comment-page-xx
1344 $commentmatch = $match . $commentregex;
1345 $commentquery = $index . '?' . $query . '&cpage=' . $this->preg_index($num_toks + 1);
1347 //create query for /feed/(feed|atom|rss|rss2|rdf)
1348 $feedmatch = $match . $feedregex;
1349 $feedquery = $feedindex . '?' . $query . '&feed=' . $this->preg_index($num_toks + 1);
1351 //create query for /(feed|atom|rss|rss2|rdf) (see comment near creation of $feedregex)
1352 $feedmatch2 = $match . $feedregex2;
1353 $feedquery2 = $feedindex . '?' . $query . '&feed=' . $this->preg_index($num_toks + 1);
1355 //if asked to, turn the feed queries into comment feed ones
1357 $feedquery .= '&withcomments=1';
1358 $feedquery2 .= '&withcomments=1';
1361 //start creating the array of rewrites for this dir
1363 if ($feed) //...adding on /feed/ regexes => queries
1364 $rewrite = array($feedmatch => $feedquery, $feedmatch2 => $feedquery2);
1365 if ($paged) //...and /page/xx ones
1366 $rewrite = array_merge($rewrite, array($pagematch => $pagequery));
1368 //only on pages with comments add ../comment-page-xx/
1369 if ( EP_PAGES & $ep_mask || EP_PERMALINK & $ep_mask || EP_NONE & $ep_mask )
1370 $rewrite = array_merge($rewrite, array($commentmatch => $commentquery));
1374 foreach ( (array) $ep_query_append as $regex => $ep) {
1375 //add the endpoints on if the mask fits
1376 if ($ep[0] & $ep_mask || $ep[0] & $ep_mask_specific) {
1377 $rewrite[$match . $regex] = $index . '?' . $query . $ep[1] . $this->preg_index($num_toks + 2);
1382 //if we've got some tags in this dir
1387 //check to see if this dir is permalink-level: i.e. the structure specifies an
1388 //individual post. Do this by checking it contains at least one of 1) post name,
1389 //2) post ID, 3) page name, 4) timestamp (year, month, day, hour, second and
1390 //minute all present). Set these flags now as we need them for the endpoints.
1391 if (strpos($struct, '%postname%') !== false || strpos($struct, '%post_id%') !== false
1392 || strpos($struct, '%pagename%') !== false
1393 || (strpos($struct, '%year%') !== false && strpos($struct, '%monthnum%') !== false && strpos($struct, '%day%') !== false && strpos($struct, '%hour%') !== false && strpos($struct, '%minute%') !== false && strpos($struct, '%second%') !== false)) {
1395 if (strpos($struct, '%pagename%') !== false)
1399 //if we're creating rules for a permalink, do all the endpoints like attachments etc
1402 //create query and regex for trackback
1403 $trackbackmatch = $match . $trackbackregex;
1404 $trackbackquery = $trackbackindex . '?' . $query . '&tb=1';
1405 //trim slashes from the end of the regex for this dir
1406 $match = rtrim($match, '/');
1407 //get rid of brackets
1408 $submatchbase = str_replace(array('(',')'),'',$match);
1410 //add a rule for at attachments, which take the form of <permalink>/some-text
1411 $sub1 = $submatchbase . '/([^/]+)/';
1412 $sub1tb = $sub1 . $trackbackregex; //add trackback regex <permalink>/trackback/...
1413 $sub1feed = $sub1 . $feedregex; //and <permalink>/feed/(atom|...)
1414 $sub1feed2 = $sub1 . $feedregex2; //and <permalink>/(feed|atom...)
1415 $sub1comment = $sub1 . $commentregex; //and <permalink>/comment-page-xx
1416 //add an ? as we don't have to match that last slash, and finally a $ so we
1417 //match to the end of the URL
1419 //add another rule to match attachments in the explicit form:
1420 //<permalink>/attachment/some-text
1421 $sub2 = $submatchbase . '/attachment/([^/]+)/';
1422 $sub2tb = $sub2 . $trackbackregex; //and add trackbacks <permalink>/attachment/trackback
1423 $sub2feed = $sub2 . $feedregex; //feeds, <permalink>/attachment/feed/(atom|...)
1424 $sub2feed2 = $sub2 . $feedregex2; //and feeds again on to this <permalink>/attachment/(feed|atom...)
1425 $sub2comment = $sub2 . $commentregex; //and <permalink>/comment-page-xx
1427 //create queries for these extra tag-ons we've just dealt with
1428 $subquery = $index . '?attachment=' . $this->preg_index(1);
1429 $subtbquery = $subquery . '&tb=1';
1430 $subfeedquery = $subquery . '&feed=' . $this->preg_index(2);
1431 $subcommentquery = $subquery . '&cpage=' . $this->preg_index(2);
1433 //do endpoints for attachments
1434 if ( !empty($endpoint) ) { foreach ( (array) $ep_query_append as $regex => $ep ) {
1435 if ($ep[0] & EP_ATTACHMENT) {
1436 $rewrite[$sub1 . $regex] = $subquery . '?' . $ep[1] . $this->preg_index(2);
1437 $rewrite[$sub2 . $regex] = $subquery . '?' . $ep[1] . $this->preg_index(2);
1441 //now we've finished with endpoints, finish off the $sub1 and $sub2 matches
1445 //allow URLs like <permalink>/2 for <permalink>/page/2
1446 $match = $match . '(/[0-9]+)?/?$';
1447 $query = $index . '?' . $query . '&page=' . $this->preg_index($num_toks + 1);
1448 } else { //not matching a permalink so this is a lot simpler
1449 //close the match and finalise the query
1451 $query = $index . '?' . $query;
1454 //create the final array for this dir by joining the $rewrite array (which currently
1455 //only contains rules/queries for trackback, pages etc) to the main regex/query for
1457 $rewrite = array_merge($rewrite, array($match => $query));
1459 //if we're matching a permalink, add those extras (attachments etc) on
1462 $rewrite = array_merge(array($trackbackmatch => $trackbackquery), $rewrite);
1464 //add regexes/queries for attachments, attachment trackbacks and so on
1465 if ( ! $page ) //require <permalink>/attachment/stuff form for pages because of confusion with subpages
1466 $rewrite = array_merge($rewrite, array($sub1 => $subquery, $sub1tb => $subtbquery, $sub1feed => $subfeedquery, $sub1feed2 => $subfeedquery, $sub1comment => $subcommentquery));
1467 $rewrite = array_merge(array($sub2 => $subquery, $sub2tb => $subtbquery, $sub2feed => $subfeedquery, $sub2feed2 => $subfeedquery, $sub2comment => $subcommentquery), $rewrite);
1470 //add the rules for this dir to the accumulating $post_rewrite
1471 $post_rewrite = array_merge($rewrite, $post_rewrite);
1473 return $post_rewrite; //the finished rules. phew!
1477 * Generate Rewrite rules with permalink structure and walking directory only.
1479 * Shorten version of {@link WP_Rewrite::generate_rewrite_rules()} that
1480 * allows for shorter list of parameters. See the method for longer
1481 * description of what generating rewrite rules does.
1483 * @uses WP_Rewrite::generate_rewrite_rules() See for long description and rest of parameters.
1487 * @param string $permalink_structure The permalink structure to generate rules.
1488 * @param bool $walk_dirs Optional, default is false. Whether to create list of directories to walk over.
1491 function generate_rewrite_rule($permalink_structure, $walk_dirs = false) {
1492 return $this->generate_rewrite_rules($permalink_structure, EP_NONE, false, false, false, $walk_dirs);
1496 * Construct rewrite matches and queries from permalink structure.
1498 * Runs the action 'generate_rewrite_rules' with the parameter that is an
1499 * reference to the current WP_Rewrite instance to further manipulate the
1500 * permalink structures and rewrite rules. Runs the 'rewrite_rules_array'
1501 * filter on the full rewrite rule array.
1503 * There are two ways to manipulate the rewrite rules, one by hooking into
1504 * the 'generate_rewrite_rules' action and gaining full control of the
1505 * object or just manipulating the rewrite rule array before it is passed
1506 * from the function.
1511 * @return array An associate array of matches and queries.
1513 function rewrite_rules() {
1516 if (empty($this->permalink_structure)) {
1521 $robots_rewrite = array('robots\.txt$' => $this->index . '?robots=1');
1523 //Default Feed rules - These are require to allow for the direct access files to work with permalink structure starting with %category%
1524 $default_feeds = array( '.*wp-atom.php$' => $this->index .'?feed=atom',
1525 '.*wp-rdf.php$' => $this->index .'?feed=rdf',
1526 '.*wp-rss.php$' => $this->index .'?feed=rss',
1527 '.*wp-rss2.php$' => $this->index .'?feed=rss2',
1528 '.*wp-feed.php$' => $this->index .'?feed=feed',
1529 '.*wp-commentsrss2.php$' => $this->index . '?feed=rss2&withcomments=1');
1532 $post_rewrite = $this->generate_rewrite_rules($this->permalink_structure, EP_PERMALINK);
1533 $post_rewrite = apply_filters('post_rewrite_rules', $post_rewrite);
1536 $date_rewrite = $this->generate_rewrite_rules($this->get_date_permastruct(), EP_DATE);
1537 $date_rewrite = apply_filters('date_rewrite_rules', $date_rewrite);
1540 $root_rewrite = $this->generate_rewrite_rules($this->root . '/', EP_ROOT);
1541 $root_rewrite = apply_filters('root_rewrite_rules', $root_rewrite);
1544 $comments_rewrite = $this->generate_rewrite_rules($this->root . $this->comments_base, EP_COMMENTS, true, true, true, false);
1545 $comments_rewrite = apply_filters('comments_rewrite_rules', $comments_rewrite);
1548 $search_structure = $this->get_search_permastruct();
1549 $search_rewrite = $this->generate_rewrite_rules($search_structure, EP_SEARCH);
1550 $search_rewrite = apply_filters('search_rewrite_rules', $search_rewrite);
1553 $category_rewrite = $this->generate_rewrite_rules($this->get_category_permastruct(), EP_CATEGORIES);
1554 $category_rewrite = apply_filters('category_rewrite_rules', $category_rewrite);
1557 $tag_rewrite = $this->generate_rewrite_rules($this->get_tag_permastruct(), EP_TAGS);
1558 $tag_rewrite = apply_filters('tag_rewrite_rules', $tag_rewrite);
1561 $author_rewrite = $this->generate_rewrite_rules($this->get_author_permastruct(), EP_AUTHORS);
1562 $author_rewrite = apply_filters('author_rewrite_rules', $author_rewrite);
1565 $page_rewrite = $this->page_rewrite_rules();
1566 $page_rewrite = apply_filters('page_rewrite_rules', $page_rewrite);
1568 // Extra permastructs
1569 foreach ( $this->extra_permastructs as $permastruct )
1570 $this->extra_rules_top = array_merge($this->extra_rules_top, $this->generate_rewrite_rules($permastruct, EP_NONE));
1572 // Put them together.
1573 if ( $this->use_verbose_page_rules )
1574 $this->rules = array_merge($this->extra_rules_top, $robots_rewrite, $default_feeds, $page_rewrite, $root_rewrite, $comments_rewrite, $search_rewrite, $category_rewrite, $tag_rewrite, $author_rewrite, $date_rewrite, $post_rewrite, $this->extra_rules);
1576 $this->rules = array_merge($this->extra_rules_top, $robots_rewrite, $default_feeds, $root_rewrite, $comments_rewrite, $search_rewrite, $category_rewrite, $tag_rewrite, $author_rewrite, $date_rewrite, $post_rewrite, $page_rewrite, $this->extra_rules);
1578 do_action_ref_array('generate_rewrite_rules', array(&$this));
1579 $this->rules = apply_filters('rewrite_rules_array', $this->rules);
1581 return $this->rules;
1585 * Retrieve the rewrite rules.
1587 * The difference between this method and {@link
1588 * WP_Rewrite::rewrite_rules()} is that this method stores the rewrite rules
1589 * in the 'rewrite_rules' option and retrieves it. This prevents having to
1590 * process all of the permalinks to get the rewrite rules in the form of
1596 * @return array Rewrite rules.
1598 function wp_rewrite_rules() {
1599 $this->rules = get_option('rewrite_rules');
1600 if ( empty($this->rules) ) {
1601 $this->matches = 'matches';
1602 $this->rewrite_rules();
1603 update_option('rewrite_rules', $this->rules);
1606 return $this->rules;
1610 * Retrieve mod_rewrite formatted rewrite rules to write to .htaccess.
1612 * Does not actually write to the .htaccess file, but creates the rules for
1613 * the process that will.
1615 * Will add the non_wp_rules property rules to the .htaccess file before
1616 * the WordPress rewrite rules one.
1623 function mod_rewrite_rules() {
1624 if ( ! $this->using_permalinks()) {
1628 $site_root = parse_url(get_option('siteurl'));
1629 if ( isset( $site_root['path'] ) ) {
1630 $site_root = trailingslashit($site_root['path']);
1633 $home_root = parse_url(get_option('home'));
1634 if ( isset( $home_root['path'] ) ) {
1635 $home_root = trailingslashit($home_root['path']);
1640 $rules = "<IfModule mod_rewrite.c>\n";
1641 $rules .= "RewriteEngine On\n";
1642 $rules .= "RewriteBase $home_root\n";
1644 //add in the rules that don't redirect to WP's index.php (and thus shouldn't be handled by WP at all)
1645 foreach ( (array) $this->non_wp_rules as $match => $query) {
1646 // Apache 1.3 does not support the reluctant (non-greedy) modifier.
1647 $match = str_replace('.+?', '.+', $match);
1649 // If the match is unanchored and greedy, prepend rewrite conditions
1650 // to avoid infinite redirects and eclipsing of real files.
1651 if ($match == '(.+)/?$' || $match == '([^/]+)/?$' ) {
1655 $rules .= 'RewriteRule ^' . $match . ' ' . $home_root . $query . " [QSA,L]\n";
1658 if ($this->use_verbose_rules) {
1659 $this->matches = '';
1660 $rewrite = $this->rewrite_rules();
1661 $num_rules = count($rewrite);
1662 $rules .= "RewriteCond %{REQUEST_FILENAME} -f [OR]\n" .
1663 "RewriteCond %{REQUEST_FILENAME} -d\n" .
1664 "RewriteRule ^.*$ - [S=$num_rules]\n";
1666 foreach ( (array) $rewrite as $match => $query) {
1667 // Apache 1.3 does not support the reluctant (non-greedy) modifier.
1668 $match = str_replace('.+?', '.+', $match);
1670 // If the match is unanchored and greedy, prepend rewrite conditions
1671 // to avoid infinite redirects and eclipsing of real files.
1672 if ($match == '(.+)/?$' || $match == '([^/]+)/?$' ) {
1676 if (strpos($query, $this->index) !== false) {
1677 $rules .= 'RewriteRule ^' . $match . ' ' . $home_root . $query . " [QSA,L]\n";
1679 $rules .= 'RewriteRule ^' . $match . ' ' . $site_root . $query . " [QSA,L]\n";
1683 $rules .= "RewriteCond %{REQUEST_FILENAME} !-f\n" .
1684 "RewriteCond %{REQUEST_FILENAME} !-d\n" .
1685 "RewriteRule . {$home_root}{$this->index} [L]\n";
1688 $rules .= "</IfModule>\n";
1690 $rules = apply_filters('mod_rewrite_rules', $rules);
1691 $rules = apply_filters('rewrite_rules', $rules); // Deprecated
1697 * Add a straight rewrite rule.
1699 * Any value in the $after parameter that isn't 'bottom' will be placed at
1700 * the top of the rules.
1705 * @param string $regex Regular expression to match against request.
1706 * @param string $redirect URL regex redirects to when regex matches request.
1707 * @param string $after Optional, default is bottom. Location to place rule.
1709 function add_rule($regex, $redirect, $after = 'bottom') {
1710 //get everything up to the first ?
1711 $index = (strpos($redirect, '?') == false ? strlen($redirect) : strpos($redirect, '?'));
1712 $front = substr($redirect, 0, $index);
1713 if ($front != $this->index) { //it doesn't redirect to WP's index.php
1714 $this->add_external_rule($regex, $redirect);
1716 if ( 'bottom' == $after)
1717 $this->extra_rules = array_merge($this->extra_rules, array($regex => $redirect));
1719 $this->extra_rules_top = array_merge($this->extra_rules_top, array($regex => $redirect));
1720 //$this->extra_rules[$regex] = $redirect;
1725 * Add a rule that doesn't redirect to index.php.
1727 * Can redirect to any place.
1732 * @param string $regex Regular expression to match against request.
1733 * @param string $redirect URL regex redirects to when regex matches request.
1735 function add_external_rule($regex, $redirect) {
1736 $this->non_wp_rules[$regex] = $redirect;
1740 * Add an endpoint, like /trackback/.
1742 * To be inserted after certain URL types (specified in $places).
1747 * @param string $name Name of endpoint.
1748 * @param array $places URL types that endpoint can be used.
1750 function add_endpoint($name, $places) {
1752 $this->endpoints[] = array ( $places, $name );
1753 $wp->add_query_var($name);
1757 * Add permalink structure.
1759 * These are added along with the extra rewrite rules that are merged to the
1765 * @param string $name Name for permalink structure.
1766 * @param string $struct Permalink structure.
1767 * @param bool $with_front Prepend front base to permalink structure.
1769 function add_permastruct($name, $struct, $with_front = true) {
1771 $struct = $this->front . $struct;
1772 $this->extra_permastructs[$name] = $struct;
1776 * Remove rewrite rules and then recreate rewrite rules.
1778 * Calls {@link WP_Rewrite::wp_rewrite_rules()} after removing the
1779 * 'rewrite_rules' option. If the function named 'save_mod_rewrite_rules'
1780 * exists, it will be called.
1785 function flush_rules() {
1786 delete_option('rewrite_rules');
1787 $this->wp_rewrite_rules();
1788 if ( function_exists('save_mod_rewrite_rules') )
1789 save_mod_rewrite_rules();
1793 * Sets up the object's properties.
1795 * The 'use_verbose_page_rules' object property will be turned on, if the
1796 * permalink structure includes the following: '%postname%', '%category%',
1797 * '%tag%', or '%author%'.
1803 $this->extra_rules = $this->non_wp_rules = $this->endpoints = array();
1804 $this->permalink_structure = get_option('permalink_structure');
1805 $this->front = substr($this->permalink_structure, 0, strpos($this->permalink_structure, '%'));
1807 if ($this->using_index_permalinks()) {
1808 $this->root = $this->index . '/';
1810 $this->category_base = get_option( 'category_base' );
1811 $this->tag_base = get_option( 'tag_base' );
1812 unset($this->category_structure);
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) == '/' ) ? true : false;
1821 // Enable generic rules for pages if permalink structure doesn't begin with a wildcard.
1822 $structure = ltrim($this->permalink_structure, '/');
1823 if ( $this->using_index_permalinks() )
1824 $structure = ltrim($this->permalink_structure, $this->index . '/');
1825 if ( 0 === strpos($structure, '%postname%') ||
1826 0 === strpos($structure, '%category%') ||
1827 0 === strpos($structure, '%tag%') ||
1828 0 === strpos($structure, '%author%') )
1829 $this->use_verbose_page_rules = true;
1831 $this->use_verbose_page_rules = false;
1835 * Set the main permalink structure for the blog.
1837 * Will update the 'permalink_structure' option, if there is a difference
1838 * between the current permalink structure and the parameter value. Calls
1839 * {@link WP_Rewrite::init()} after the option is updated.
1844 * @param string $permalink_structure Permalink structure.
1846 function set_permalink_structure($permalink_structure) {
1847 if ($permalink_structure != $this->permalink_structure) {
1848 update_option('permalink_structure', $permalink_structure);
1854 * Set the category base for the category permalink.
1856 * Will update the 'category_base' option, if there is a difference between
1857 * the current category base and the parameter value. Calls
1858 * {@link WP_Rewrite::init()} after the option is updated.
1863 * @param string $category_base Category permalink structure base.
1865 function set_category_base($category_base) {
1866 if ($category_base != $this->category_base) {
1867 update_option('category_base', $category_base);
1873 * Set the tag base for the tag permalink.
1875 * Will update the 'tag_base' option, if there is a difference between the
1876 * current tag base and the parameter value. Calls
1877 * {@link WP_Rewrite::init()} after the option is updated.
1882 * @param string $tag_base Tag permalink structure base.
1884 function set_tag_base( $tag_base ) {
1885 if ( $tag_base != $this->tag_base ) {
1886 update_option( 'tag_base', $tag_base );
1892 * PHP4 Constructor - Calls init(), which runs setup.
1897 * @return WP_Rewrite
1899 function WP_Rewrite() {