WordPress 4.5
[autoinstalls/wordpress.git] / wp-includes / class-wp.php
index 2fe76fc8b7e09fea40d3218017ddd195327d01a9..1217f1c370d499fc1d4ca1ac59faf3cebda4ca3c 100644 (file)
@@ -15,7 +15,7 @@ class WP {
         * @access public
         * @var array
         */
-       var $public_query_vars = array('m', 'p', 'posts', 'w', 'cat', 'withcomments', 'withoutcomments', 's', 'search', 'exact', 'sentence', 'calendar', 'page', 'paged', 'more', 'tb', 'pb', 'author', 'order', 'orderby', 'year', 'monthnum', 'day', 'hour', 'minute', 'second', 'name', 'category_name', 'tag', 'feed', 'author_name', 'static', 'pagename', 'page_id', 'error', 'comments_popup', 'attachment', 'attachment_id', 'subpost', 'subpost_id', 'preview', 'robots', 'taxonomy', 'term', 'cpage', 'post_type');
+       public $public_query_vars = array('m', 'p', 'posts', 'w', 'cat', 'withcomments', 'withoutcomments', 's', 'search', 'exact', 'sentence', 'calendar', 'page', 'paged', 'more', 'tb', 'pb', 'author', 'order', 'orderby', 'year', 'monthnum', 'day', 'hour', 'minute', 'second', 'name', 'category_name', 'tag', 'feed', 'author_name', 'static', 'pagename', 'page_id', 'error', 'attachment', 'attachment_id', 'subpost', 'subpost_id', 'preview', 'robots', 'taxonomy', 'term', 'cpage', 'post_type', 'embed' );
 
        /**
         * Private query variables.
@@ -23,87 +23,109 @@ class WP {
         * Long list of private query variables.
         *
         * @since 2.0.0
+        * @access public
         * @var array
         */
-       var $private_query_vars = array( 'offset', 'posts_per_page', 'posts_per_archive_page', 'showposts', 'nopaging', 'post_type', 'post_status', 'category__in', 'category__not_in', 'category__and', 'tag__in', 'tag__not_in', 'tag__and', 'tag_slug__in', 'tag_slug__and', 'tag_id', 'post_mime_type', 'perm', 'comments_per_page', 'post__in', 'post__not_in', 'post_parent__in', 'post_parent__not_in' );
+       public $private_query_vars = array( 'offset', 'posts_per_page', 'posts_per_archive_page', 'showposts', 'nopaging', 'post_type', 'post_status', 'category__in', 'category__not_in', 'category__and', 'tag__in', 'tag__not_in', 'tag__and', 'tag_slug__in', 'tag_slug__and', 'tag_id', 'post_mime_type', 'perm', 'comments_per_page', 'post__in', 'post__not_in', 'post_parent', 'post_parent__in', 'post_parent__not_in', 'title' );
 
        /**
         * Extra query variables set by the user.
         *
         * @since 2.1.0
+        * @access public
         * @var array
         */
-       var $extra_query_vars = array();
+       public $extra_query_vars = array();
 
        /**
         * Query variables for setting up the WordPress Query Loop.
         *
         * @since 2.0.0
+        * @access public
         * @var array
         */
-       var $query_vars;
+       public $query_vars;
 
        /**
         * String parsed to set the query variables.
         *
         * @since 2.0.0
+        * @access public
         * @var string
         */
-       var $query_string;
+       public $query_string;
 
        /**
         * Permalink or requested URI.
         *
         * @since 2.0.0
+        * @access public
         * @var string
         */
-       var $request;
+       public $request;
 
        /**
         * Rewrite rule the request matched.
         *
         * @since 2.0.0
+        * @access public
         * @var string
         */
-       var $matched_rule;
+       public $matched_rule;
 
        /**
         * Rewrite query the request matched.
         *
         * @since 2.0.0
+        * @access public
         * @var string
         */
-       var $matched_query;
+       public $matched_query;
 
        /**
         * Whether already did the permalink.
         *
         * @since 2.0.0
+        * @access public
         * @var bool
         */
-       var $did_permalink = false;
+       public $did_permalink = false;
 
        /**
         * Add name to list of public query variables.
         *
         * @since 2.1.0
+        * @access public
         *
         * @param string $qv Query variable name.
         */
-       function add_query_var($qv) {
+       public function add_query_var($qv) {
                if ( !in_array($qv, $this->public_query_vars) )
                        $this->public_query_vars[] = $qv;
        }
 
+       /**
+        * Removes a query variable from a list of public query variables.
+        *
+        * @since 4.5.0
+        * @access public
+        *
+        * @param string $name Query variable name.
+        */
+       public function remove_query_var( $name ) {
+               $this->public_query_vars = array_diff( $this->public_query_vars, array( $name ) );
+       }
+
        /**
         * Set the value of a query variable.
         *
         * @since 2.3.0
+        * @access public
         *
         * @param string $key Query variable name.
         * @param mixed $value Query variable value.
         */
-       function set_query_var($key, $value) {
+       public function set_query_var($key, $value) {
                $this->query_vars[$key] = $value;
        }
 
@@ -114,10 +136,13 @@ class WP {
         * filters and actions that can be used to further manipulate the result.
         *
         * @since 2.0.0
+        * @access public
+        *
+        * @global WP_Rewrite $wp_rewrite
         *
         * @param array|string $extra_query_vars Set the extra query variables.
         */
-       function parse_request($extra_query_vars = '') {
+       public function parse_request($extra_query_vars = '') {
                global $wp_rewrite;
 
                /**
@@ -135,11 +160,11 @@ class WP {
                $this->query_vars = array();
                $post_type_query_vars = array();
 
-               if ( is_array($extra_query_vars) )
+               if ( is_array( $extra_query_vars ) ) {
                        $this->extra_query_vars = & $extra_query_vars;
-               else if (! empty($extra_query_vars))
-                       parse_str($extra_query_vars, $this->extra_query_vars);
-
+               } elseif ( ! empty( $extra_query_vars ) ) {
+                       parse_str( $extra_query_vars, $this->extra_query_vars );
+               }
                // Process PATH_INFO, REQUEST_URI, and 404 for permalinks.
 
                // Fetch the rewrite rules.
@@ -157,6 +182,7 @@ class WP {
                        list( $req_uri ) = explode( '?', $_SERVER['REQUEST_URI'] );
                        $self = $_SERVER['PHP_SELF'];
                        $home_path = trim( parse_url( home_url(), PHP_URL_PATH ), '/' );
+                       $home_path_regex = sprintf( '|^%s|i', preg_quote( $home_path, '|' ) );
 
                        // Trim path info from the end and the leading home path from the
                        // front. For path info requests, this leaves us with the requesting
@@ -164,13 +190,13 @@ class WP {
                        // requested permalink.
                        $req_uri = str_replace($pathinfo, '', $req_uri);
                        $req_uri = trim($req_uri, '/');
-                       $req_uri = preg_replace("|^$home_path|i", '', $req_uri);
+                       $req_uri = preg_replace( $home_path_regex, '', $req_uri );
                        $req_uri = trim($req_uri, '/');
                        $pathinfo = trim($pathinfo, '/');
-                       $pathinfo = preg_replace("|^$home_path|i", '', $pathinfo);
+                       $pathinfo = preg_replace( $home_path_regex, '', $pathinfo );
                        $pathinfo = trim($pathinfo, '/');
                        $self = trim($self, '/');
-                       $self = preg_replace("|^$home_path|i", '', $self);
+                       $self = preg_replace( $home_path_regex, '', $self );
                        $self = trim($self, '/');
 
                        // The requested permalink is in $pathinfo for path info requests and
@@ -205,9 +231,17 @@ class WP {
                                                preg_match("#^$match#", urldecode($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
-                                                       if ( ! get_page_by_path( $matches[ $varmatch[1] ] ) )
+                                                       // This is a verbose page match, let's check to be sure about it.
+                                                       $page = get_page_by_path( $matches[ $varmatch[1] ] );
+                                                       if ( ! $page ) {
                                                                continue;
+                                                       }
+
+                                                       $post_status_obj = get_post_status_object( $page->post_status );
+                                                       if ( ! $post_status_obj->public && ! $post_status_obj->protected
+                                                               && ! $post_status_obj->private && $post_status_obj->exclude_from_search ) {
+                                                               continue;
+                                                       }
                                                }
 
                                                // Got a match.
@@ -258,9 +292,11 @@ class WP {
                 */
                $this->public_query_vars = apply_filters( 'query_vars', $this->public_query_vars );
 
-               foreach ( get_post_types( array(), 'objects' ) as $post_type => $t )
-                       if ( $t->query_var )
+               foreach ( get_post_types( array(), 'objects' ) as $post_type => $t ) {
+                       if ( is_post_type_viewable( $t ) && $t->query_var ) {
                                $post_type_query_vars[$t->query_var] = $post_type;
+                       }
+               }
 
                foreach ( $this->public_query_vars as $wpvar ) {
                        if ( isset( $this->extra_query_vars[$wpvar] ) )
@@ -295,6 +331,19 @@ class WP {
                        if ( $t->query_var && isset( $this->query_vars[$t->query_var] ) )
                                $this->query_vars[$t->query_var] = str_replace( ' ', '+', $this->query_vars[$t->query_var] );
 
+               // Don't allow non-publicly queryable taxonomies to be queried from the front end.
+               if ( ! is_admin() ) {
+                       foreach ( get_taxonomies( array( 'publicly_queryable' => false ), 'objects' ) as $taxonomy => $t ) {
+                               /*
+                                * Disallow when set to the 'taxonomy' query var.
+                                * Non-publicly queryable taxonomies cannot register custom query vars. See register_taxonomy().
+                                */
+                               if ( isset( $this->query_vars['taxonomy'] ) && $taxonomy === $this->query_vars['taxonomy'] ) {
+                                       unset( $this->query_vars['taxonomy'], $this->query_vars['term'] );
+                               }
+                       }
+               }
+
                // Limit publicly queried post_types to those that are publicly_queryable
                if ( isset( $this->query_vars['post_type']) ) {
                        $queryable_post_types = get_post_types( array('publicly_queryable' => true) );
@@ -306,6 +355,9 @@ class WP {
                        }
                }
 
+               // Resolve conflicts between posts with numeric slugs and date archive queries.
+               $this->query_vars = wp_resolve_numeric_slug_conflicts( $this->query_vars );
+
                foreach ( (array) $this->private_query_vars as $var) {
                        if ( isset($this->extra_query_vars[$var]) )
                                $this->query_vars[$var] = $this->extra_query_vars[$var];
@@ -334,15 +386,17 @@ class WP {
        }
 
        /**
-        * Send additional HTTP headers for caching, content type, etc.
+        * Sends additional HTTP headers for caching, content type, etc.
         *
-        * Sets the X-Pingback header, 404 status (if 404), Content-type. If showing
-        * a feed, it will also send last-modified, etag, and 304 status if needed.
+        * Sets the Content-Type header. Sets the 'error' status (if passed) and optionally exits.
+        * If showing a feed, it will also send Last-Modified, ETag, and 304 status if needed.
         *
         * @since 2.0.0
+        * @since 4.4.0 `X-Pingback` header is added conditionally after posts have been queried in handle_404().
+        * @access public
         */
-       function send_headers() {
-               $headers = array('X-Pingback' => get_bloginfo('pingback_url'));
+       public function send_headers() {
+               $headers = array();
                $status = null;
                $exit_required = false;
 
@@ -357,9 +411,16 @@ class WP {
                        } elseif ( in_array( $status, array( 403, 500, 502, 503 ) ) ) {
                                $exit_required = true;
                        }
-               } else if ( empty($this->query_vars['feed']) ) {
+               } elseif ( empty( $this->query_vars['feed'] ) ) {
                        $headers['Content-Type'] = get_option('html_type') . '; charset=' . get_option('blog_charset');
                } else {
+                       // Set the correct content type for feeds
+                       $type = $this->query_vars['feed'];
+                       if ( 'feed' == $this->query_vars['feed'] ) {
+                               $type = get_default_feed();
+                       }
+                       $headers['Content-Type'] = feed_content_type( $type ) . '; charset=' . get_option( 'blog_charset' );
+
                        // We're showing a feed, so WP is indeed the only thing that last changed
                        if ( !empty($this->query_vars['withcomments'])
                                || false !== strpos( $this->query_vars['feed'], 'comments-' )
@@ -432,7 +493,7 @@ class WP {
                        }
                }
 
-               foreach( (array) $headers as $name => $field_value )
+               foreach ( (array) $headers as $name => $field_value )
                        @header("{$name}: {$field_value}");
 
                if ( $exit_required )
@@ -455,8 +516,9 @@ class WP {
         * use the 'request' filter instead.
         *
         * @since 2.0.0
+        * @access public
         */
-       function build_query_string() {
+       public function build_query_string() {
                $this->query_string = '';
                foreach ( (array) array_keys($this->query_vars) as $wpvar) {
                        if ( '' != $this->query_vars[$wpvar] ) {
@@ -488,17 +550,19 @@ class WP {
         * be taken when naming global variables that might interfere with the
         * WordPress environment.
         *
-        * @global string $query_string Query string for the loop.
-        * @global array $posts The found posts.
-        * @global WP_Post|null $post The current post, if available.
-        * @global string $request The SQL statement for the request.
-        * @global int $more Only set, if single page or post.
-        * @global int $single If single page or post. Only set, if single page or post.
-        * @global WP_User $authordata Only set, if author archive.
-        *
         * @since 2.0.0
+        * @access public
+        *
+        * @global WP_Query     $wp_query
+        * @global string       $query_string Query string for the loop.
+        * @global array        $posts The found posts.
+        * @global WP_Post|null $post The current post, if available.
+        * @global string       $request The SQL statement for the request.
+        * @global int          $more Only set, if single page or post.
+        * @global int          $single If single page or post. Only set, if single page or post.
+        * @global WP_User      $authordata Only set, if author archive.
         */
-       function register_globals() {
+       public function register_globals() {
                global $wp_query;
 
                // Extract updated query vars back into global namespace.
@@ -524,25 +588,28 @@ class WP {
         * Set up the current user.
         *
         * @since 2.0.0
+        * @access public
         */
-       function init() {
+       public function init() {
                wp_get_current_user();
        }
 
        /**
         * Set up the Loop based on the query variables.
         *
-        * @uses WP::$query_vars
         * @since 2.0.0
+        * @access public
+        *
+        * @global WP_Query $wp_the_query
         */
-       function query_posts() {
+       public function query_posts() {
                global $wp_the_query;
                $this->build_query_string();
                $wp_the_query->query($this->query_vars);
        }
 
        /**
-        * Set the Headers for 404, if nothing is found for requested URL.
+        * Set the Headers for 404, if nothing is found for requested URL.
         *
         * Issue a 404 if a request doesn't match any posts and doesn't match
         * any object (e.g. an existing-but-empty category, tag, author) and a 404 was not already
@@ -550,32 +617,85 @@ class WP {
         *
         * Otherwise, issue a 200.
         *
+        * This sets headers after posts have been queried. handle_404() really means "handle status."
+        * By inspecting the result of querying posts, seemingly successful requests can be switched to
+        * a 404 so that canonical redirection logic can kick in.
+        *
         * @since 2.0.0
+     * @access public
+        *
+        * @global WP_Query $wp_query
         */
-       function handle_404() {
+       public function handle_404() {
                global $wp_query;
 
+               /**
+                * Filter whether to short-circuit default header status handling.
+                *
+                * Returning a non-false value from the filter will short-circuit the handling
+                * and return early.
+                *
+                * @since 4.5.0
+                *
+                * @param bool     $preempt  Whether to short-circuit default header status handling. Default false.
+                * @param WP_Query $wp_query WordPress Query object.
+                */
+               if ( false !== apply_filters( 'pre_handle_404', false, $wp_query ) ) {
+                       return;
+               }
+
                // If we've already issued a 404, bail.
                if ( is_404() )
                        return;
 
                // Never 404 for the admin, robots, or if we found posts.
                if ( is_admin() || is_robots() || $wp_query->posts ) {
-                       status_header( 200 );
-                       return;
+
+                       $success = true;
+                       if ( is_singular() ) {
+                               $p = false;
+
+                               if ( $wp_query->post instanceof WP_Post ) {
+                                       $p = clone $wp_query->post;
+                               }
+
+                               // Only set X-Pingback for single posts that allow pings.
+                               if ( $p && pings_open( $p ) ) {
+                                       @header( 'X-Pingback: ' . get_bloginfo( 'pingback_url' ) );
+                               }
+
+                               // check for paged content that exceeds the max number of pages
+                               $next = '<!--nextpage-->';
+                               if ( $p && false !== strpos( $p->post_content, $next ) && ! empty( $this->query_vars['page'] ) ) {
+                                       $page = trim( $this->query_vars['page'], '/' );
+                                       $success = (int) $page <= ( substr_count( $p->post_content, $next ) + 1 );
+                               }
+                       }
+
+                       if ( $success ) {
+                               status_header( 200 );
+                               return;
+                       }
                }
 
                // We will 404 for paged queries, as no posts were found.
                if ( ! is_paged() ) {
 
+                       // Don't 404 for authors without posts as long as they matched an author on this site.
+                       $author = get_query_var( 'author' );
+                       if ( is_author() && is_numeric( $author ) && $author > 0 && is_user_member_of_blog( $author ) ) {
+                               status_header( 200 );
+                               return;
+                       }
+
                        // Don't 404 for these queries if they matched an object.
-                       if ( ( is_tag() || is_category() || is_tax() || is_author() || is_post_type_archive() ) && $wp_query->get_queried_object() ) {
+                       if ( ( is_tag() || is_category() || is_tax() || is_post_type_archive() ) && get_queried_object() ) {
                                status_header( 200 );
                                return;
                        }
 
                        // Don't 404 for these queries either.
-                       if ( is_home() || is_search() ) {
+                       if ( is_home() || is_search() || is_feed() ) {
                                status_header( 200 );
                                return;
                        }
@@ -595,10 +715,11 @@ class WP {
         * object.
         *
         * @since 2.0.0
+        * @access public
         *
         * @param string|array $query_args Passed to {@link parse_request()}
         */
-       function main($query_args = '') {
+       public function main($query_args = '') {
                $this->init();
                $this->parse_request($query_args);
                $this->send_headers();
@@ -615,7 +736,6 @@ class WP {
                 */
                do_action_ref_array( 'wp', array( &$this ) );
        }
-
 }
 
 /**
@@ -630,7 +750,7 @@ class WP_MatchesMapRegex {
         * @access private
         * @var array
         */
-       var $_matches;
+       private $_matches;
 
        /**
         * store for mapping result
@@ -638,7 +758,7 @@ class WP_MatchesMapRegex {
         * @access public
         * @var string
         */
-       var $output;
+       public $output;
 
        /**
         * subject to perform mapping on (query string containing $matches[] references
@@ -646,23 +766,22 @@ class WP_MatchesMapRegex {
         * @access private
         * @var string
         */
-       var $_subject;
+       private $_subject;
 
        /**
         * regexp pattern to match $matches[] references
         *
         * @var string
         */
-       var $_pattern = '(\$matches\[[1-9]+[0-9]*\])'; // magic number
+       public $_pattern = '(\$matches\[[1-9]+[0-9]*\])'; // magic number
 
        /**
         * constructor
         *
         * @param string $subject subject if regex
         * @param array  $matches data to use in map
-        * @return self
         */
-       function WP_MatchesMapRegex($subject, $matches) {
+       public function __construct($subject, $matches) {
                $this->_subject = $subject;
                $this->_matches = $matches;
                $this->output = $this->_map();
@@ -673,7 +792,9 @@ class WP_MatchesMapRegex {
         *
         * static helper function to ease use
         *
+        * @static
         * @access public
+        *
         * @param string $subject subject
         * @param array  $matches data used for substitution
         * @return string
@@ -689,7 +810,7 @@ class WP_MatchesMapRegex {
         * @access private
         * @return string
         */
-       function _map() {
+       private function _map() {
                $callback = array($this, 'callback');
                return preg_replace_callback($this->_pattern, $callback, $this->_subject);
        }
@@ -701,9 +822,8 @@ class WP_MatchesMapRegex {
         * @param  array $matches preg_replace regexp matches
         * @return string
         */
-       function callback($matches) {
+       public function callback($matches) {
                $index = intval(substr($matches[0], 9, -1));
                return ( isset( $this->_matches[$index] ) ? urlencode($this->_matches[$index]) : '' );
        }
-
 }