X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/596d585e1dc1eb25bccd3781e37210a4e2504179..53f4633144ed68c8b8fb5861f992b5489894a940:/wp-includes/rewrite.php diff --git a/wp-includes/rewrite.php b/wp-includes/rewrite.php index 740ffebb..a2ddc590 100644 --- a/wp-includes/rewrite.php +++ b/wp-includes/rewrite.php @@ -9,12 +9,13 @@ /** * Add a straight rewrite rule. * - * @see WP_Rewrite::add_rule() for long description. * @since 2.1.0 * - * @param string $regex Regular Expression to match request against. + * @global WP_Rewrite $wp_rewrite + * + * @param string $regex Regular Expression to match request against. * @param string $redirect Page to redirect to. - * @param string $after Optional, default is 'bottom'. Where to add rule, can also be 'top'. + * @param string $after Optional, default is 'bottom'. Where to add rule, can also be 'top'. */ function add_rewrite_rule($regex, $redirect, $after = 'bottom') { global $wp_rewrite; @@ -28,10 +29,12 @@ function add_rewrite_rule($regex, $redirect, $after = 'bottom') { * you call this on, or before, the 'init' hook. This is because $query defaults * to "$tag=", and for this to work a new query var has to be added. * - * @see WP_Rewrite::add_rewrite_tag() * @since 2.1.0 * - * @param string $tag Name of the new rewrite tag. + * @global WP_Rewrite $wp_rewrite + * @global WP $wp + * + * @param string $tag Name of the new rewrite tag. * @param string $regex Regular expression to substitute the tag for in rewrite rules. * @param string $query String to append to the rewritten query. Must end in '='. Optional. */ @@ -54,13 +57,14 @@ function add_rewrite_tag( $tag, $regex, $query = '' ) { /** * Add permalink structure. * - * @see WP_Rewrite::add_permastruct() * @since 3.0.0 * - * @param string $name Name for permalink structure. + * @global WP_Rewrite $wp_rewrite + * + * @param string $name Name for permalink structure. * @param string $struct Permalink structure. - * @param array $args Optional configuration for building the rules from the permalink structure, - * see {@link WP_Rewrite::add_permastruct()} for full details. + * @param array $args Optional configuration for building the rules from the permalink structure, + * see {@link WP_Rewrite::add_permastruct()} for full details. */ function add_permastruct( $name, $struct, $args = array() ) { global $wp_rewrite; @@ -71,7 +75,7 @@ function add_permastruct( $name, $struct, $args = array() ) { if ( func_num_args() == 4 ) $args['ep_mask'] = func_get_arg( 3 ); - return $wp_rewrite->add_permastruct( $name, $struct, $args ); + $wp_rewrite->add_permastruct( $name, $struct, $args ); } /** @@ -79,7 +83,9 @@ function add_permastruct( $name, $struct, $args = array() ) { * * @since 2.1.0 * - * @param string $feedname + * @global WP_Rewrite $wp_rewrite + * + * @param string $feedname * @param callback $function Callback to run on feed display. * @return string Feed action name. */ @@ -89,7 +95,7 @@ function add_feed($feedname, $function) { $wp_rewrite->feeds[] = $feedname; $hook = 'do_feed_' . $feedname; // Remove default function hook - remove_action($hook, $hook, 10, 1); + remove_action($hook, $hook); add_action($hook, $function, 10, 1); return $hook; } @@ -97,11 +103,12 @@ function add_feed($feedname, $function) { /** * Remove rewrite rules and then recreate rewrite rules. * - * @see WP_Rewrite::flush_rules() * @since 3.0.0 * + * @global WP_Rewrite $wp_rewrite + * * @param bool $hard Whether to update .htaccess (hard flush) or just update - * rewrite_rules transient (soft flush). Default is true (hard). + * rewrite_rules transient (soft flush). Default is true (hard). */ function flush_rewrite_rules( $hard = true ) { global $wp_rewrite; @@ -206,12 +213,19 @@ define('EP_AUTHORS', 2048); */ define('EP_PAGES', 4096); +/** + * Endpoint Mask for all archive views. + * + * @since 3.7.0 + */ +define( 'EP_ALL_ARCHIVES', EP_DATE | EP_YEAR | EP_MONTH | EP_DAY | EP_CATEGORIES | EP_TAGS | EP_AUTHORS ); + /** * Endpoint Mask for everything. * * @since 2.1.0 */ -define('EP_ALL', 8191); +define( 'EP_ALL', EP_PERMALINK | EP_ATTACHMENT | EP_ROOT | EP_COMMENTS | EP_SEARCH | EP_PAGES | EP_ALL_ARCHIVES ); /** * Add an endpoint, like /trackback/. @@ -219,34 +233,35 @@ define('EP_ALL', 8191); * Adding an endpoint creates extra rewrite rules for each of the matching * places specified by the provided bitmask. For example: * - * - * add_rewrite_endpoint( 'json', EP_PERMALINK | EP_PAGES ); - * + * add_rewrite_endpoint( 'json', EP_PERMALINK | EP_PAGES ); * * will add a new rewrite rule ending with "json(/(.*))?/?$" for every permastruct * that describes a permalink (post) or page. This is rewritten to "json=$match" * where $match is the part of the URL matched by the endpoint regex (e.g. "foo" in - * "/json/foo/"). + * "[permalink]/json/foo/"). * * A new query var with the same name as the endpoint will also be created. * * When specifying $places ensure that you are using the EP_* constants (or a * combination of them using the bitwise OR operator) as their values are not - * guaranteed to remain static (especially EP_ALL). + * guaranteed to remain static (especially `EP_ALL`). * - * Be sure to flush the rewrite rules - flush_rewrite_rules() - when your plugin gets + * Be sure to flush the rewrite rules - see flush_rewrite_rules() - when your plugin gets * activated and deactivated. * * @since 2.1.0 - * @see WP_Rewrite::add_endpoint() - * @global object $wp_rewrite + * @since 4.3.0 Added support for skipping query var registration by passing `false` to `$query_var`. + * + * @global WP_Rewrite $wp_rewrite * - * @param string $name Name of the endpoint. - * @param int $places Endpoint mask describing the places the endpoint should be added. + * @param string $name Name of the endpoint. + * @param int $places Endpoint mask describing the places the endpoint should be added. + * @param string|bool $query_var Name of the corresponding query variable. Pass `false` to skip registering a query_var + * for this endpoint. Defaults to the value of `$name`. */ -function add_rewrite_endpoint( $name, $places ) { +function add_rewrite_endpoint( $name, $places, $query_var = true ) { global $wp_rewrite; - $wp_rewrite->add_endpoint( $name, $places ); + $wp_rewrite->add_endpoint( $name, $places, $query_var ); } /** @@ -268,6 +283,121 @@ function _wp_filter_taxonomy_base( $base ) { return $base; } + +/** + * Resolve numeric slugs that collide with date permalinks. + * + * Permalinks of posts with numeric slugs can sometimes look to WP_Query::parse_query() + * like a date archive, as when your permalink structure is `/%year%/%postname%/` and + * a post with post_name '05' has the URL `/2015/05/`. + * + * This function detects conflicts of this type and resolves them in favor of the + * post permalink. + * + * Note that, since 4.3.0, wp_unique_post_slug() prevents the creation of post slugs + * that would result in a date archive conflict. The resolution performed in this + * function is primarily for legacy content, as well as cases when the admin has changed + * the site's permalink structure in a way that introduces URL conflicts. + * + * @since 4.3.0 + * + * @param array $query_vars Optional. Query variables for setting up the loop, as determined in + * WP::parse_request(). Default empty array. + * @return array Returns the original array of query vars, with date/post conflicts resolved. + */ +function wp_resolve_numeric_slug_conflicts( $query_vars = array() ) { + if ( ! isset( $query_vars['year'] ) && ! isset( $query_vars['monthnum'] ) && ! isset( $query_vars['day'] ) ) { + return $query_vars; + } + + // Identify the 'postname' position in the permastruct array. + $permastructs = array_values( array_filter( explode( '/', get_option( 'permalink_structure' ) ) ) ); + $postname_index = array_search( '%postname%', $permastructs ); + + if ( false === $postname_index ) { + return $query_vars; + } + + /* + * A numeric slug could be confused with a year, month, or day, depending on position. To account for + * the possibility of post pagination (eg 2015/2 for the second page of a post called '2015'), our + * `is_*` checks are generous: check for year-slug clashes when `is_year` *or* `is_month`, and check + * for month-slug clashes when `is_month` *or* `is_day`. + */ + $compare = ''; + if ( 0 === $postname_index && ( isset( $query_vars['year'] ) || isset( $query_vars['monthnum'] ) ) ) { + $compare = 'year'; + } elseif ( '%year%' === $permastructs[ $postname_index - 1 ] && ( isset( $query_vars['monthnum'] ) || isset( $query_vars['day'] ) ) ) { + $compare = 'monthnum'; + } elseif ( '%monthnum%' === $permastructs[ $postname_index - 1 ] && isset( $query_vars['day'] ) ) { + $compare = 'day'; + } + + if ( ! $compare ) { + return $query_vars; + } + + // This is the potentially clashing slug. + $value = $query_vars[ $compare ]; + + $post = get_page_by_path( $value, OBJECT, 'post' ); + if ( ! ( $post instanceof WP_Post ) ) { + return $query_vars; + } + + // If the date of the post doesn't match the date specified in the URL, resolve to the date archive. + if ( preg_match( '/^([0-9]{4})\-([0-9]{2})/', $post->post_date, $matches ) && isset( $query_vars['year'] ) && ( 'monthnum' === $compare || 'day' === $compare ) ) { + // $matches[1] is the year the post was published. + if ( intval( $query_vars['year'] ) !== intval( $matches[1] ) ) { + return $query_vars; + } + + // $matches[2] is the month the post was published. + if ( 'day' === $compare && isset( $query_vars['monthnum'] ) && intval( $query_vars['monthnum'] ) !== intval( $matches[2] ) ) { + return $query_vars; + } + } + + /* + * If the located post contains nextpage pagination, then the URL chunk following postname may be + * intended as the page number. Verify that it's a valid page before resolving to it. + */ + $maybe_page = ''; + if ( 'year' === $compare && isset( $query_vars['monthnum'] ) ) { + $maybe_page = $query_vars['monthnum']; + } elseif ( 'monthnum' === $compare && isset( $query_vars['day'] ) ) { + $maybe_page = $query_vars['day']; + } + + $post_page_count = substr_count( $post->post_content, '' ) + 1; + + // If the post doesn't have multiple pages, but a 'page' candidate is found, resolve to the date archive. + if ( 1 === $post_page_count && $maybe_page ) { + return $query_vars; + } + + // If the post has multiple pages and the 'page' number isn't valid, resolve to the date archive. + if ( $post_page_count > 1 && $maybe_page > $post_page_count ) { + return $query_vars; + } + + // If we've gotten to this point, we have a slug/date clash. First, adjust for nextpage. + if ( '' !== $maybe_page ) { + $query_vars['page'] = intval( $maybe_page ); + } + + // Next, unset autodetected date-related query vars. + unset( $query_vars['year'] ); + unset( $query_vars['monthnum'] ); + unset( $query_vars['day'] ); + + // Then, set the identified post. + $query_vars['name'] = $post->post_name; + + // Finally, return the modified query vars. + return $query_vars; +} + /** * Examine a url and try to determine the post ID it represents. * @@ -275,13 +405,23 @@ function _wp_filter_taxonomy_base( $base ) { * * @since 1.0.0 * + * @global WP_Rewrite $wp_rewrite + * @global WP $wp + * * @param string $url Permalink to check. * @return int Post ID, or 0 on failure. */ -function url_to_postid($url) { +function url_to_postid( $url ) { global $wp_rewrite; - $url = apply_filters('url_to_postid', $url); + /** + * Filter the URL to derive the post ID from. + * + * @since 2.2.0 + * + * @param string $url The URL to derive the post ID from. + */ + $url = apply_filters( 'url_to_postid', $url ); // First, check to see if there is a 'p=N' or 'page_id=N' to match against if ( preg_match('#[?&](p|page_id|attachment_id)=(\d+)#', $url, $values) ) { @@ -315,22 +455,28 @@ function url_to_postid($url) { // Strip 'index.php/' if we're not using path info permalinks if ( !$wp_rewrite->using_index_permalinks() ) - $url = str_replace('index.php/', '', $url); + $url = str_replace( $wp_rewrite->index . '/', '', $url ); - if ( false !== strpos($url, home_url()) ) { - // Chop off http://domain.com + if ( false !== strpos( trailingslashit( $url ), home_url( '/' ) ) ) { + // Chop off http://domain.com/[path] $url = str_replace(home_url(), '', $url); } else { // Chop off /path/to/blog - $home_path = parse_url(home_url()); + $home_path = parse_url( home_url( '/' ) ); $home_path = isset( $home_path['path'] ) ? $home_path['path'] : '' ; - $url = str_replace($home_path, '', $url); + $url = preg_replace( sprintf( '#^%s#', preg_quote( $home_path ) ), '', trailingslashit( $url ) ); } // Trim leading and lagging slashes $url = trim($url, '/'); $request = $url; + $post_type_query_vars = array(); + + foreach ( get_post_types( array() , 'objects' ) as $post_type => $t ) { + if ( ! empty( $t->query_var ) ) + $post_type_query_vars[ $t->query_var ] = $post_type; + } // Look for matches. $request_match = $request; @@ -341,10 +487,10 @@ function url_to_postid($url) { if ( !empty($url) && ($url != $request) && (strpos($match, $url) === 0) ) $request_match = $url . '/' . $request; - if ( preg_match("!^$match!", $request_match, $matches) ) { + if ( preg_match("#^$match#", $request_match, $matches) ) { if ( $wp_rewrite->use_verbose_page_rules && preg_match( '/pagename=\$matches\[([0-9]+)\]/', $query, $varmatch ) ) { - // this is a verbose page match, lets check to be sure about it + // This is a verbose page match, let's check to be sure about it. if ( ! get_page_by_path( $matches[ $varmatch[1] ] ) ) continue; } @@ -358,16 +504,24 @@ function url_to_postid($url) { // Filter out non-public query vars global $wp; - parse_str($query, $query_vars); + parse_str( $query, $query_vars ); $query = array(); foreach ( (array) $query_vars as $key => $value ) { - if ( in_array($key, $wp->public_query_vars) ) + if ( in_array( $key, $wp->public_query_vars ) ){ $query[$key] = $value; + if ( isset( $post_type_query_vars[$key] ) ) { + $query['post_type'] = $post_type_query_vars[$key]; + $query['name'] = $value; + } + } } + // Resolve conflicts between posts with numeric slugs and date archive queries. + $query = wp_resolve_numeric_slug_conflicts( $query ); + // Do the query - $query = new WP_Query($query); - if ( !empty($query->posts) && $query->is_singular ) + $query = new WP_Query( $query ); + if ( ! empty( $query->posts ) && $query->is_singular ) return $query->post->ID; else return 0; @@ -396,19 +550,17 @@ class WP_Rewrite { * Permalink structure for posts. * * @since 1.5.0 - * @access private * @var string */ - var $permalink_structure; + public $permalink_structure; /** * Whether to add trailing slashes. * * @since 2.2.0 - * @access private * @var bool */ - var $use_trailing_slashes; + public $use_trailing_slashes; /** * Base for the author permalink structure (example.com/$author_base/authorname). @@ -477,10 +629,18 @@ class WP_Rewrite { * Pagination permalink base. * * @since 3.1.0 + * @var string + */ + public $pagination_base = 'page'; + + /** + * Comments pagination permalink base. + * + * @since 4.2.0 * @access private * @var string */ - var $pagination_base = 'page'; + var $comments_pagination_base = 'comment-page'; /** * Feed permalink base. @@ -498,7 +658,7 @@ class WP_Rewrite { * @access private * @var string */ - var $comments_feed_structure; + var $comment_feed_structure; /** * Feed request permalink structure. @@ -518,10 +678,9 @@ class WP_Rewrite { * * @see WP_Rewrite::init() * @since 1.5.0 - * @access private * @var string */ - var $front; + public $front; /** * The prefix for all permalink structures. @@ -533,10 +692,9 @@ class WP_Rewrite { * @see WP_Rewrite::init() * @see WP_Rewrite::using_index_permalinks() * @since 1.5.0 - * @access private * @var string */ - var $root = ''; + public $root = ''; /** * The name of the index file which is the entry point to all requests. @@ -545,7 +703,7 @@ class WP_Rewrite { * @access public * @var string */ - var $index = 'index.php'; + public $index = 'index.php'; /** * Variable name to use for regex matches in the rewritten query. @@ -628,7 +786,7 @@ class WP_Rewrite { * @access public * @var bool */ - var $use_verbose_rules = false; + public $use_verbose_rules = false; /** * Could post permalinks be confused with those of pages? @@ -640,13 +798,13 @@ class WP_Rewrite { * Now it tells {@link WP::parse_request()} to check if a URL matching the * page permastruct is actually a page before accepting it. * - * @link http://core.trac.wordpress.org/ticket/16687 + * @link https://core.trac.wordpress.org/ticket/16687 * @see WP_Rewrite::init() * @since 2.5.0 * @access public * @var bool */ - var $use_verbose_page_rules = true; + public $use_verbose_page_rules = true; /** * Rewrite tags that can be used in permalink structures. @@ -722,10 +880,9 @@ class WP_Rewrite { * Supported default feeds. * * @since 1.5.0 - * @access private * @var array */ - var $feeds = array( 'feed', 'rdf', 'rss', 'rss2', 'atom' ); + public $feeds = array( 'feed', 'rdf', 'rss', 'rss2', 'atom' ); /** * Whether permalinks are being used. @@ -737,7 +894,7 @@ class WP_Rewrite { * * @return bool True, if permalinks are enabled. */ - function using_permalinks() { + public function using_permalinks() { return ! empty($this->permalink_structure); } @@ -751,15 +908,12 @@ class WP_Rewrite { * * @return bool */ - function using_index_permalinks() { - if ( empty($this->permalink_structure) ) + public function using_index_permalinks() { + if ( empty( $this->permalink_structure ) ) { return false; - + } // If the index is not in the permalink, we're using mod_rewrite. - if ( preg_match('#^/*' . $this->index . '#', $this->permalink_structure) ) - return true; - - return false; + return preg_match( '#^/*' . $this->index . '#', $this->permalink_structure ); } /** @@ -772,11 +926,8 @@ class WP_Rewrite { * * @return bool */ - function using_mod_rewrite_permalinks() { - if ( $this->using_permalinks() && ! $this->using_index_permalinks() ) - return true; - else - return false; + public function using_mod_rewrite_permalinks() { + return $this->using_permalinks() && ! $this->using_index_permalinks(); } /** @@ -795,7 +946,7 @@ class WP_Rewrite { * @param int $number Index number. * @return string */ - function preg_index($number) { + public function preg_index($number) { $match_prefix = '$'; $match_suffix = ''; @@ -816,13 +967,16 @@ class WP_Rewrite { * @since 2.5.0 * @access public * + * @global wpdb $wpdb + * * @return array Array of page URIs as first element and attachment URIs as second element. */ - function page_uri_index() { + public function page_uri_index() { global $wpdb; //get pages in order of hierarchy, i.e. children after parents - $posts = get_page_hierarchy( $wpdb->get_results("SELECT ID, post_name, post_parent FROM $wpdb->posts WHERE post_type = 'page' AND post_status != 'auto-draft'") ); + $pages = $wpdb->get_results("SELECT ID, post_name, post_parent FROM $wpdb->posts WHERE post_type = 'page' AND post_status != 'auto-draft'"); + $posts = get_page_hierarchy( $pages ); // If we have no pages get out quick if ( !$posts ) @@ -859,7 +1013,7 @@ class WP_Rewrite { * * @return array */ - function page_rewrite_rules() { + public function page_rewrite_rules() { // the extra .? at the beginning prevents clashes with other regular expressions in the rules array $this->add_rewrite_tag( '%pagename%', '(.?.+?)', 'pagename=' ); @@ -884,9 +1038,9 @@ class WP_Rewrite { * @since 1.5.0 * @access public * - * @return bool|string False on no permalink structure. Date permalink structure. + * @return string|false False on no permalink structure. Date permalink structure. */ - function get_date_permastruct() { + public function get_date_permastruct() { if ( isset($this->date_structure) ) return $this->date_structure; @@ -938,9 +1092,9 @@ class WP_Rewrite { * @since 1.5.0 * @access public * - * @return bool|string False on failure. Year structure on success. + * @return false|string False on failure. Year structure on success. */ - function get_year_permastruct() { + public function get_year_permastruct() { $structure = $this->get_date_permastruct(); if ( empty($structure) ) @@ -948,7 +1102,6 @@ class WP_Rewrite { $structure = str_replace('%monthnum%', '', $structure); $structure = str_replace('%day%', '', $structure); - $structure = preg_replace('#/+#', '/', $structure); return $structure; @@ -963,16 +1116,15 @@ class WP_Rewrite { * @since 1.5.0 * @access public * - * @return bool|string False on failure. Year/Month structure on success. + * @return false|string False on failure. Year/Month structure on success. */ - function get_month_permastruct() { + public function get_month_permastruct() { $structure = $this->get_date_permastruct(); if ( empty($structure) ) return false; $structure = str_replace('%day%', '', $structure); - $structure = preg_replace('#/+#', '/', $structure); return $structure; @@ -986,9 +1138,9 @@ class WP_Rewrite { * @since 1.5.0 * @access public * - * @return bool|string False on failure. Year/Month/Day structure on success. + * @return string|false False on failure. Year/Month/Day structure on success. */ - function get_day_permastruct() { + public function get_day_permastruct() { return $this->get_date_permastruct(); } @@ -1003,9 +1155,9 @@ class WP_Rewrite { * @since 1.5.0 * @access public * - * @return bool|string False on failure. Category permalink structure. + * @return string|false False on failure. Category permalink structure. */ - function get_category_permastruct() { + public function get_category_permastruct() { return $this->get_extra_permastruct('category'); } @@ -1020,9 +1172,9 @@ class WP_Rewrite { * @since 2.3.0 * @access public * - * @return bool|string False on failure. Tag permalink structure. + * @return string|false False on failure. Tag permalink structure. */ - function get_tag_permastruct() { + public function get_tag_permastruct() { return $this->get_extra_permastruct('post_tag'); } @@ -1033,9 +1185,9 @@ class WP_Rewrite { * @access public * * @param string $name Permalink structure name. - * @return string|bool False if not found. Permalink structure string. + * @return string|false False if not found. Permalink structure string. */ - function get_extra_permastruct($name) { + public function get_extra_permastruct($name) { if ( empty($this->permalink_structure) ) return false; @@ -1055,9 +1207,9 @@ class WP_Rewrite { * @since 1.5.0 * @access public * - * @return string|bool False if not found. Permalink structure string. + * @return string|false False if not found. Permalink structure string. */ - function get_author_permastruct() { + public function get_author_permastruct() { if ( isset($this->author_structure) ) return $this->author_structure; @@ -1081,9 +1233,9 @@ class WP_Rewrite { * @since 1.5.0 * @access public * - * @return string|bool False if not found. Permalink structure string. + * @return string|false False if not found. Permalink structure string. */ - function get_search_permastruct() { + public function get_search_permastruct() { if ( isset($this->search_structure) ) return $this->search_structure; @@ -1107,9 +1259,9 @@ class WP_Rewrite { * @since 1.5.0 * @access public * - * @return string|bool False if not found. Permalink structure string. + * @return string|false False if not found. Permalink structure string. */ - function get_page_permastruct() { + public function get_page_permastruct() { if ( isset($this->page_structure) ) return $this->page_structure; @@ -1133,9 +1285,9 @@ class WP_Rewrite { * @since 1.5.0 * @access public * - * @return string|bool False if not found. Permalink structure string. + * @return string|false False if not found. Permalink structure string. */ - function get_feed_permastruct() { + public function get_feed_permastruct() { if ( isset($this->feed_structure) ) return $this->feed_structure; @@ -1159,9 +1311,9 @@ class WP_Rewrite { * @since 1.5.0 * @access public * - * @return string|bool False if not found. Permalink structure string. + * @return string|false False if not found. Permalink structure string. */ - function get_comment_feed_permastruct() { + public function get_comment_feed_permastruct() { if ( isset($this->comment_feed_structure) ) return $this->comment_feed_structure; @@ -1187,11 +1339,11 @@ class WP_Rewrite { * @since 1.5.0 * @access public * - * @param string $tag Name of the rewrite tag to add or update. + * @param string $tag Name of the rewrite tag to add or update. * @param string $regex Regular expression to substitute the tag for in rewrite rules. * @param string $query String to append to the rewritten query. Must end in '='. */ - function add_rewrite_tag( $tag, $regex, $query ) { + public function add_rewrite_tag( $tag, $regex, $query ) { $position = array_search( $tag, $this->rewritecode ); if ( false !== $position && null !== $position ) { $this->rewritereplace[ $position ] = $regex; @@ -1214,16 +1366,16 @@ class WP_Rewrite { * @access public * * @param string $permalink_structure The permalink structure. - * @param int $ep_mask Endpoint mask defining what endpoints are added to the structure. Default is EP_NONE. - * @param bool $paged Should archive pagination rules be added for the structure? Default is true. - * @param bool $feed Should feed rewrite rules be added for the structure? Default is true. - * @param bool $forcomments Should the feed rules be a query for a comments feed? Default is false. - * @param bool $walk_dirs Should the 'directories' making up the structure be walked over and rewrite rules - * built for each in turn? Default is true. - * @param bool $endpoints Should endpoints be applied to the generated rewrite rules? Default is true. + * @param int $ep_mask Endpoint mask defining what endpoints are added to the structure. Default is EP_NONE. + * @param bool $paged Should archive pagination rules be added for the structure? Default is true. + * @param bool $feed Should feed rewrite rules be added for the structure? Default is true. + * @param bool $forcomments Should the feed rules be a query for a comments feed? Default is false. + * @param bool $walk_dirs Should the 'directories' making up the structure be walked over and rewrite rules + * built for each in turn? Default is true. + * @param bool $endpoints Should endpoints be applied to the generated rewrite rules? Default is true. * @return array Rewrite rule list. */ - function generate_rewrite_rules($permalink_structure, $ep_mask = EP_NONE, $paged = true, $feed = true, $forcomments = false, $walk_dirs = true, $endpoints = true) { + public function generate_rewrite_rules($permalink_structure, $ep_mask = EP_NONE, $paged = true, $feed = true, $forcomments = false, $walk_dirs = true, $endpoints = true) { //build a regex to match the feed section of URLs, something like (feed|atom|rss|rss2)/? $feedregex2 = ''; foreach ( (array) $this->feeds as $feed_name) @@ -1237,7 +1389,7 @@ class WP_Rewrite { //build a regex to match the trackback and page/xx parts of URLs $trackbackregex = 'trackback/?$'; $pageregex = $this->pagination_base . '/?([0-9]{1,})/?$'; - $commentregex = 'comment-page-([0-9]{1,})/?$'; + $commentregex = $this->comments_pagination_base . '-([0-9]{1,})/?$'; //build up an array of endpoint regexes to append => queries to append if ( $endpoints ) { @@ -1246,7 +1398,7 @@ class WP_Rewrite { //match everything after the endpoint name, but allow for nothing to appear there $epmatch = $endpoint[1] . '(/(.*))?/?$'; //this will be appended on to the rest of the query for each dir - $epquery = '&' . $endpoint[1] . '='; + $epquery = '&' . $endpoint[2] . '='; $ep_query_append[$epmatch] = array ( $endpoint[0], $epquery ); } } @@ -1263,6 +1415,7 @@ class WP_Rewrite { $trackbackindex = $index; //build a list from the rewritecode and queryreplace arrays, that will look something like //tagname=$matches[i] where i is the current $i + $queries = array(); for ( $i = 0; $i < $num_tokens; ++$i ) { if ( 0 < $i ) $queries[$i] = $queries[$i - 1] . '&'; @@ -1303,7 +1456,7 @@ class WP_Rewrite { $num_toks = preg_match_all('/%.+?%/', $struct, $toks); //get the 'tagname=$matches[i]' - $query = ( isset($queries) && is_array($queries) && !empty($num_toks) ) ? $queries[$num_toks - 1] : ''; + $query = ( ! empty( $num_toks ) && isset( $queries[$num_toks - 1] ) ) ? $queries[$num_toks - 1] : ''; //set up $ep_mask_specific which is used to match more specific URL types switch ( $dirs[$j] ) { @@ -1356,11 +1509,11 @@ class WP_Rewrite { $rewrite = array_merge($rewrite, array($pagematch => $pagequery)); //only on pages with comments add ../comment-page-xx/ - if ( EP_PAGES & $ep_mask || EP_PERMALINK & $ep_mask ) + if ( EP_PAGES & $ep_mask || EP_PERMALINK & $ep_mask ) { $rewrite = array_merge($rewrite, array($commentmatch => $commentquery)); - else if ( EP_ROOT & $ep_mask && get_option('page_on_front') ) + } elseif ( EP_ROOT & $ep_mask && get_option('page_on_front') ) { $rewrite = array_merge($rewrite, array($rootcommentmatch => $rootcommentquery)); - + } //do endpoints if ( $endpoints ) { foreach ( (array) $ep_query_append as $regex => $ep) { @@ -1435,8 +1588,8 @@ class WP_Rewrite { if ( !empty($endpoints) ) { foreach ( (array) $ep_query_append as $regex => $ep ) { if ( $ep[0] & EP_ATTACHMENT ) { - $rewrite[$sub1 . $regex] = $subquery . $ep[1] . $this->preg_index(2); - $rewrite[$sub2 . $regex] = $subquery . $ep[1] . $this->preg_index(2); + $rewrite[$sub1 . $regex] = $subquery . $ep[1] . $this->preg_index(3); + $rewrite[$sub2 . $regex] = $subquery . $ep[1] . $this->preg_index(3); } } } @@ -1490,10 +1643,10 @@ class WP_Rewrite { * @access public * * @param string $permalink_structure The permalink structure to generate rules. - * @param bool $walk_dirs Optional, default is false. Whether to create list of directories to walk over. + * @param bool $walk_dirs Optional, default is false. Whether to create list of directories to walk over. * @return array */ - function generate_rewrite_rule($permalink_structure, $walk_dirs = false) { + public function generate_rewrite_rule($permalink_structure, $walk_dirs = false) { return $this->generate_rewrite_rules($permalink_structure, EP_NONE, false, false, false, $walk_dirs); } @@ -1515,7 +1668,7 @@ class WP_Rewrite { * * @return array An associate array of matches and queries. */ - function rewrite_rules() { + public function rewrite_rules() { $rewrite = array(); if ( empty($this->permalink_structure) ) @@ -1525,8 +1678,11 @@ class WP_Rewrite { $home_path = parse_url( home_url() ); $robots_rewrite = ( empty( $home_path['path'] ) || '/' == $home_path['path'] ) ? array( 'robots\.txt$' => $this->index . '?robots=1' ) : array(); - // Old feed files - $old_feed_files = array( '.*wp-(atom|rdf|rss|rss2|feed|commentsrss2)\.php$' => $this->index . '?feed=old' ); + // Old feed and service files + $deprecated_files = array( + '.*wp-(atom|rdf|rss|rss2|feed|commentsrss2)\.php$' => $this->index . '?feed=old', + '.*wp-app\.php(/.*)?$' => $this->index . '?error=403', + ); // Registration rules $registration_pages = array(); @@ -1536,36 +1692,105 @@ class WP_Rewrite { } $registration_pages['.*wp-register.php$'] = $this->index . '?register=true'; // Deprecated - // Post + // Post rewrite rules. $post_rewrite = $this->generate_rewrite_rules( $this->permalink_structure, EP_PERMALINK ); - $post_rewrite = apply_filters('post_rewrite_rules', $post_rewrite); - // Date + /** + * Filter rewrite rules used for "post" archives. + * + * @since 1.5.0 + * + * @param array $post_rewrite The rewrite rules for posts. + */ + $post_rewrite = apply_filters( 'post_rewrite_rules', $post_rewrite ); + + // Date rewrite rules. $date_rewrite = $this->generate_rewrite_rules($this->get_date_permastruct(), EP_DATE); - $date_rewrite = apply_filters('date_rewrite_rules', $date_rewrite); - // Root + /** + * Filter rewrite rules used for date archives. + * + * Likely date archives would include /yyyy/, /yyyy/mm/, and /yyyy/mm/dd/. + * + * @since 1.5.0 + * + * @param array $date_rewrite The rewrite rules for date archives. + */ + $date_rewrite = apply_filters( 'date_rewrite_rules', $date_rewrite ); + + // Root-level rewrite rules. $root_rewrite = $this->generate_rewrite_rules($this->root . '/', EP_ROOT); - $root_rewrite = apply_filters('root_rewrite_rules', $root_rewrite); - // Comments - $comments_rewrite = $this->generate_rewrite_rules($this->root . $this->comments_base, EP_COMMENTS, true, true, true, false); - $comments_rewrite = apply_filters('comments_rewrite_rules', $comments_rewrite); - - // Search + /** + * Filter rewrite rules used for root-level archives. + * + * Likely root-level archives would include pagination rules for the homepage + * as well as site-wide post feeds (e.g. /feed/, and /feed/atom/). + * + * @since 1.5.0 + * + * @param array $root_rewrite The root-level rewrite rules. + */ + $root_rewrite = apply_filters( 'root_rewrite_rules', $root_rewrite ); + + // Comments rewrite rules. + $comments_rewrite = $this->generate_rewrite_rules($this->root . $this->comments_base, EP_COMMENTS, false, true, true, false); + + /** + * Filter rewrite rules used for comment feed archives. + * + * Likely comments feed archives include /comments/feed/, and /comments/feed/atom/. + * + * @since 1.5.0 + * + * @param array $comments_rewrite The rewrite rules for the site-wide comments feeds. + */ + $comments_rewrite = apply_filters( 'comments_rewrite_rules', $comments_rewrite ); + + // Search rewrite rules. $search_structure = $this->get_search_permastruct(); $search_rewrite = $this->generate_rewrite_rules($search_structure, EP_SEARCH); - $search_rewrite = apply_filters('search_rewrite_rules', $search_rewrite); - // Authors + /** + * Filter rewrite rules used for search archives. + * + * Likely search-related archives include /search/search+query/ as well as + * pagination and feed paths for a search. + * + * @since 1.5.0 + * + * @param array $search_rewrite The rewrite rules for search queries. + */ + $search_rewrite = apply_filters( 'search_rewrite_rules', $search_rewrite ); + + // Author rewrite rules. $author_rewrite = $this->generate_rewrite_rules($this->get_author_permastruct(), EP_AUTHORS); - $author_rewrite = apply_filters('author_rewrite_rules', $author_rewrite); - // Pages + /** + * Filter rewrite rules used for author archives. + * + * Likely author archives would include /author/author-name/, as well as + * pagination and feed paths for author archives. + * + * @since 1.5.0 + * + * @param array $author_rewrite The rewrite rules for author archives. + */ + $author_rewrite = apply_filters( 'author_rewrite_rules', $author_rewrite ); + + // Pages rewrite rules. $page_rewrite = $this->page_rewrite_rules(); - $page_rewrite = apply_filters('page_rewrite_rules', $page_rewrite); - // Extra permastructs + /** + * Filter rewrite rules used for "page" post type archives. + * + * @since 1.5.0 + * + * @param array $page_rewrite The rewrite rules for the "page" post type. + */ + $page_rewrite = apply_filters( 'page_rewrite_rules', $page_rewrite ); + + // Extra permastructs. foreach ( $this->extra_permastructs as $permastructname => $struct ) { if ( is_array( $struct ) ) { if ( count( $struct ) == 2 ) @@ -1576,21 +1801,57 @@ class WP_Rewrite { $rules = $this->generate_rewrite_rules( $struct ); } - $rules = apply_filters($permastructname . '_rewrite_rules', $rules); - if ( 'post_tag' == $permastructname ) - $rules = apply_filters('tag_rewrite_rules', $rules); + /** + * Filter rewrite rules used for individual permastructs. + * + * The dynamic portion of the hook name, `$permastructname`, refers + * to the name of the registered permastruct, e.g. 'post_tag' (tags), + * 'category' (categories), etc. + * + * @since 3.1.0 + * + * @param array $rules The rewrite rules generated for the current permastruct. + */ + $rules = apply_filters( $permastructname . '_rewrite_rules', $rules ); + if ( 'post_tag' == $permastructname ) { + + /** + * Filter rewrite rules used specifically for Tags. + * + * @since 2.3.0 + * @deprecated 3.1.0 Use 'post_tag_rewrite_rules' instead + * + * @param array $rules The rewrite rules generated for tags. + */ + $rules = apply_filters( 'tag_rewrite_rules', $rules ); + } $this->extra_rules_top = array_merge($this->extra_rules_top, $rules); } // Put them together. if ( $this->use_verbose_page_rules ) - $this->rules = array_merge($this->extra_rules_top, $robots_rewrite, $old_feed_files, $registration_pages, $root_rewrite, $comments_rewrite, $search_rewrite, $author_rewrite, $date_rewrite, $page_rewrite, $post_rewrite, $this->extra_rules); + $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); else - $this->rules = array_merge($this->extra_rules_top, $robots_rewrite, $old_feed_files, $registration_pages, $root_rewrite, $comments_rewrite, $search_rewrite, $author_rewrite, $date_rewrite, $post_rewrite, $page_rewrite, $this->extra_rules); - - do_action_ref_array('generate_rewrite_rules', array(&$this)); - $this->rules = apply_filters('rewrite_rules_array', $this->rules); + $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); + + /** + * Fires after the rewrite rules are generated. + * + * @since 1.5.0 + * + * @param WP_Rewrite $this Current WP_Rewrite instance, passed by reference. + */ + do_action_ref_array( 'generate_rewrite_rules', array( &$this ) ); + + /** + * Filter the full set of generated rewrite rules. + * + * @since 1.5.0 + * + * @param array $this->rules The compiled array of rewrite rules. + */ + $this->rules = apply_filters( 'rewrite_rules_array', $this->rules ); return $this->rules; } @@ -1609,7 +1870,7 @@ class WP_Rewrite { * * @return array Rewrite rules. */ - function wp_rewrite_rules() { + public function wp_rewrite_rules() { $this->rules = get_option('rewrite_rules'); if ( empty($this->rules) ) { $this->matches = 'matches'; @@ -1634,11 +1895,11 @@ class WP_Rewrite { * * @return string */ - function mod_rewrite_rules() { + public function mod_rewrite_rules() { if ( ! $this->using_permalinks() ) return ''; - $site_root = parse_url(get_option('siteurl')); + $site_root = parse_url( site_url() ); if ( isset( $site_root['path'] ) ) $site_root = trailingslashit($site_root['path']); @@ -1698,10 +1959,25 @@ class WP_Rewrite { $rules .= "\n"; - $rules = apply_filters('mod_rewrite_rules', $rules); - $rules = apply_filters('rewrite_rules', $rules); // Deprecated - - return $rules; + /** + * + * Filter the list of rewrite rules formatted for output to an .htaccess file. + * + * @since 1.5.0 + * + * @param string $rules mod_rewrite Rewrite rules formatted for .htaccess. + */ + $rules = apply_filters( 'mod_rewrite_rules', $rules ); + + /** + * Filter the list of rewrite rules formatted for output to an .htaccess file. + * + * @since 1.5.0 + * @deprecated 1.5.0 Use the mod_rewrite_rules filter instead. + * + * @param string $rules mod_rewrite Rewrite rules formatted for .htaccess. + */ + return apply_filters( 'rewrite_rules', $rules ); } /** @@ -1715,8 +1991,7 @@ class WP_Rewrite { * * @return string */ - function iis7_url_rewrite_rules( $add_parent_tags = false ) { - + public function iis7_url_rewrite_rules( $add_parent_tags = false ) { if ( ! $this->using_permalinks() ) return ''; $rules = ''; @@ -1726,75 +2001,17 @@ class WP_Rewrite { '; } - if ( !is_multisite() ) { - $rules .= ' - - - - - - - - '; - } else { - if (is_subdomain_install()) { - $rules .= ' - - - - - - - - - - - - - - - - - - - - '; - } else { - $rules .= ' - - - - - - - - - - - - - - - - - + + $rules .= ' + + + + + - - - - - - - - - - - - - - '; - } - } + + '; + if ( $add_parent_tags ) { $rules .= ' @@ -1803,9 +2020,14 @@ class WP_Rewrite { '; } - $rules = apply_filters('iis7_url_rewrite_rules', $rules); - - return $rules; + /** + * Filter the list of rewrite rules formatted for output to a web.config. + * + * @since 2.8.0 + * + * @param string $rules Rewrite rules formatted for IIS web.config. + */ + return apply_filters( 'iis7_url_rewrite_rules', $rules ); } /** @@ -1817,13 +2039,13 @@ class WP_Rewrite { * @since 2.1.0 * @access public * - * @param string $regex Regular expression to match against request. + * @param string $regex Regular expression to match against request. * @param string $redirect URL regex redirects to when regex matches request. - * @param string $after Optional, default is bottom. Location to place rule. + * @param string $after Optional, default is bottom. Location to place rule. */ - function add_rule($regex, $redirect, $after = 'bottom') { + public function add_rule($regex, $redirect, $after = 'bottom') { //get everything up to the first ? - $index = (strpos($redirect, '?') == false ? strlen($redirect) : strpos($redirect, '?')); + $index = (strpos($redirect, '?') === false ? strlen($redirect) : strpos($redirect, '?')); $front = substr($redirect, 0, $index); if ( $front != $this->index ) { //it doesn't redirect to WP's index.php $this->add_external_rule($regex, $redirect); @@ -1844,30 +2066,43 @@ class WP_Rewrite { * @since 2.1.0 * @access public * - * @param string $regex Regular expression to match against request. + * @param string $regex Regular expression to match against request. * @param string $redirect URL regex redirects to when regex matches request. */ - function add_external_rule($regex, $redirect) { + public function add_external_rule($regex, $redirect) { $this->non_wp_rules[$regex] = $redirect; } /** * Add an endpoint, like /trackback/. * - * See {@link add_rewrite_endpoint()} for full documentation. - * - * @see add_rewrite_endpoint() * @since 2.1.0 + * @since 3.9.0 $query_var parameter added. + * @since 4.3.0 Added support for skipping query var registration by passing `false` to `$query_var`. * @access public - * @uses WP::add_query_var() * - * @param string $name Name of the endpoint. - * @param int $places Endpoint mask describing the places the endpoint should be added. + * @see add_rewrite_endpoint() for full documentation. + * + * @global WP $wp + * + * @param string $name Name of the endpoint. + * @param int $places Endpoint mask describing the places the endpoint should be added. + * @param string|bool $query_var Optional. Name of the corresponding query variable. Pass `false` to + * skip registering a query_var for this endpoint. Defaults to the + * value of `$name`. */ - function add_endpoint($name, $places) { + public function add_endpoint( $name, $places, $query_var = true ) { global $wp; - $this->endpoints[] = array ( $places, $name ); - $wp->add_query_var($name); + + // For backward compatibility, if `null` has explicitly been passed as `$query_var`, assume `true`. + if ( true === $query_var || null === func_get_arg( 2 ) ) { + $query_var = $name; + } + $this->endpoints[] = array( $places, $name, $query_var ); + + if ( $query_var ) { + $wp->add_query_var( $query_var ); + } } /** @@ -1886,9 +2121,9 @@ class WP_Rewrite { * @since 2.5.0 * @access public * - * @param string $name Name for permalink structure. + * @param string $name Name for permalink structure. * @param string $struct Permalink structure (e.g. category/%category%) - * @param array $args Optional configuration for building the rules from the permalink structure: + * @param array $args Optional configuration for building the rules from the permalink structure: * - with_front (bool) - Should the structure be prepended with WP_Rewrite::$front? Default is true. * - ep_mask (int) - Endpoint mask defining what endpoints are added to the structure. Default is EP_NONE. * - paged (bool) - Should archive pagination rules be added for the structure? Default is true. @@ -1898,7 +2133,7 @@ class WP_Rewrite { * rules built for each in turn? Default is true. * - endpoints (bool) - Should endpoints be applied to the generated rewrite rules? Default is true. */ - function add_permastruct( $name, $struct, $args = array() ) { + public function add_permastruct( $name, $struct, $args = array() ) { // backwards compatibility for the old parameters: $with_front and $ep_mask if ( ! is_array( $args ) ) $args = array( 'with_front' => $args ); @@ -1935,14 +2170,43 @@ class WP_Rewrite { * * @since 2.0.1 * @access public + * + * @staticvar bool $do_hard_later + * * @param bool $hard Whether to update .htaccess (hard flush) or just update rewrite_rules option (soft flush). Default is true (hard). */ - function flush_rules($hard = true) { + public function flush_rules( $hard = true ) { + static $do_hard_later = null; + + // Prevent this action from running before everyone has registered their rewrites + if ( ! did_action( 'wp_loaded' ) ) { + add_action( 'wp_loaded', array( $this, 'flush_rules' ) ); + $do_hard_later = ( isset( $do_hard_later ) ) ? $do_hard_later || $hard : $hard; + return; + } + + if ( isset( $do_hard_later ) ) { + $hard = $do_hard_later; + unset( $do_hard_later ); + } + delete_option('rewrite_rules'); $this->wp_rewrite_rules(); - if ( $hard && function_exists('save_mod_rewrite_rules') ) + /** + * Filter whether a "hard" rewrite rule flush should be performed when requested. + * + * A "hard" flush updates .htaccess (Apache) or web.config (IIS). + * + * @since 3.7.0 + * + * @param bool $hard Whether to flush rewrite rules "hard". Default true. + */ + if ( ! $hard || ! apply_filters( 'flush_rewrite_rules_hard', true ) ) { + return; + } + if ( function_exists( 'save_mod_rewrite_rules' ) ) save_mod_rewrite_rules(); - if ( $hard && function_exists('iis7_save_url_rewrite_rules') ) + if ( function_exists( 'iis7_save_url_rewrite_rules' ) ) iis7_save_url_rewrite_rules(); } @@ -1956,7 +2220,7 @@ class WP_Rewrite { * @since 1.5.0 * @access public */ - function init() { + public function init() { $this->extra_rules = $this->non_wp_rules = $this->endpoints = array(); $this->permalink_structure = get_option('permalink_structure'); $this->front = substr($this->permalink_structure, 0, strpos($this->permalink_structure, '%')); @@ -1993,11 +2257,21 @@ class WP_Rewrite { * * @param string $permalink_structure Permalink structure. */ - function set_permalink_structure($permalink_structure) { + public function set_permalink_structure($permalink_structure) { if ( $permalink_structure != $this->permalink_structure ) { + $old_permalink_structure = $this->permalink_structure; update_option('permalink_structure', $permalink_structure); $this->init(); - do_action('permalink_structure_changed', $this->permalink_structure, $permalink_structure); + + /** + * Fires after the permalink structure is updated. + * + * @since 2.8.0 + * + * @param string $old_permalink_structure The previous permalink structure. + * @param string $permalink_structure The new permalink structure. + */ + do_action( 'permalink_structure_changed', $old_permalink_structure, $permalink_structure ); } } @@ -2013,7 +2287,7 @@ class WP_Rewrite { * * @param string $category_base Category permalink structure base. */ - function set_category_base($category_base) { + public function set_category_base($category_base) { if ( $category_base != get_option('category_base') ) { update_option('category_base', $category_base); $this->init(); @@ -2032,7 +2306,7 @@ class WP_Rewrite { * * @param string $tag_base Tag permalink structure base. */ - function set_tag_base( $tag_base ) { + public function set_tag_base( $tag_base ) { if ( $tag_base != get_option( 'tag_base') ) { update_option( 'tag_base', $tag_base ); $this->init(); @@ -2045,9 +2319,8 @@ class WP_Rewrite { * @since 1.5.0 * @access public * - * @return WP_Rewrite */ - function __construct() { + public function __construct() { $this->init(); } }