3 * WordPress environment setup class.
10 * Public query variables.
12 * Long list of public query variables.
18 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');
21 * Private query variables.
23 * Long list of private query variables.
28 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' );
31 * Extra query variables set by the user.
36 var $extra_query_vars = array();
39 * Query variables for setting up the WordPress Query Loop.
47 * String parsed to set the query variables.
55 * Permalink or requested URI.
63 * Rewrite rule the request matched.
71 * Rewrite query the request matched.
79 * Whether already did the permalink.
84 var $did_permalink = false;
87 * Add name to list of public query variables.
91 * @param string $qv Query variable name.
93 function add_query_var($qv) {
94 if ( !in_array($qv, $this->public_query_vars) )
95 $this->public_query_vars[] = $qv;
99 * Set the value of a query variable.
103 * @param string $key Query variable name.
104 * @param mixed $value Query variable value.
106 function set_query_var($key, $value) {
107 $this->query_vars[$key] = $value;
111 * Parse request to find correct WordPress query.
113 * Sets up the query variables based on the request. There are also many
114 * filters and actions that can be used to further manipulate the result.
118 * @param array|string $extra_query_vars Set the extra query variables.
120 function parse_request($extra_query_vars = '') {
123 if ( ! apply_filters( 'do_parse_request', true, $this, $extra_query_vars ) )
126 $this->query_vars = array();
127 $post_type_query_vars = array();
129 if ( is_array($extra_query_vars) )
130 $this->extra_query_vars = & $extra_query_vars;
131 else if (! empty($extra_query_vars))
132 parse_str($extra_query_vars, $this->extra_query_vars);
134 // Process PATH_INFO, REQUEST_URI, and 404 for permalinks.
136 // Fetch the rewrite rules.
137 $rewrite = $wp_rewrite->wp_rewrite_rules();
139 if ( ! empty($rewrite) ) {
140 // If we match a rewrite rule, this will be cleared.
142 $this->did_permalink = true;
144 $pathinfo = isset( $_SERVER['PATH_INFO'] ) ? $_SERVER['PATH_INFO'] : '';
145 list( $pathinfo ) = explode( '?', $pathinfo );
146 $pathinfo = str_replace( "%", "%25", $pathinfo );
148 list( $req_uri ) = explode( '?', $_SERVER['REQUEST_URI'] );
149 $self = $_SERVER['PHP_SELF'];
150 $home_path = trim( parse_url( home_url(), PHP_URL_PATH ), '/' );
152 // Trim path info from the end and the leading home path from the
153 // front. For path info requests, this leaves us with the requesting
154 // filename, if any. For 404 requests, this leaves us with the
155 // requested permalink.
156 $req_uri = str_replace($pathinfo, '', $req_uri);
157 $req_uri = trim($req_uri, '/');
158 $req_uri = preg_replace("|^$home_path|i", '', $req_uri);
159 $req_uri = trim($req_uri, '/');
160 $pathinfo = trim($pathinfo, '/');
161 $pathinfo = preg_replace("|^$home_path|i", '', $pathinfo);
162 $pathinfo = trim($pathinfo, '/');
163 $self = trim($self, '/');
164 $self = preg_replace("|^$home_path|i", '', $self);
165 $self = trim($self, '/');
167 // The requested permalink is in $pathinfo for path info requests and
168 // $req_uri for other requests.
169 if ( ! empty($pathinfo) && !preg_match('|^.*' . $wp_rewrite->index . '$|', $pathinfo) ) {
170 $request = $pathinfo;
172 // If the request uri is the index, blank it out so that we don't try to match it against a rule.
173 if ( $req_uri == $wp_rewrite->index )
178 $this->request = $request;
181 $request_match = $request;
182 if ( empty( $request_match ) ) {
183 // An empty request could only match against ^$ regex
184 if ( isset( $rewrite['$'] ) ) {
185 $this->matched_rule = '$';
186 $query = $rewrite['$'];
187 $matches = array('');
190 foreach ( (array) $rewrite as $match => $query ) {
191 // If the requesting file is the anchor of the match, prepend it to the path info.
192 if ( ! empty($req_uri) && strpos($match, $req_uri) === 0 && $req_uri != $request )
193 $request_match = $req_uri . '/' . $request;
195 if ( preg_match("#^$match#", $request_match, $matches) ||
196 preg_match("#^$match#", urldecode($request_match), $matches) ) {
198 if ( $wp_rewrite->use_verbose_page_rules && preg_match( '/pagename=\$matches\[([0-9]+)\]/', $query, $varmatch ) ) {
199 // this is a verbose page match, lets check to be sure about it
200 if ( ! get_page_by_path( $matches[ $varmatch[1] ] ) )
205 $this->matched_rule = $match;
211 if ( isset( $this->matched_rule ) ) {
212 // Trim the query of everything up to the '?'.
213 $query = preg_replace("!^.+\?!", '', $query);
215 // Substitute the substring matches into the query.
216 $query = addslashes(WP_MatchesMapRegex::apply($query, $matches));
218 $this->matched_query = $query;
221 parse_str($query, $perma_query_vars);
223 // If we're processing a 404 request, clear the error var since we found something.
224 if ( '404' == $error )
225 unset( $error, $_GET['error'] );
228 // If req_uri is empty or if it is a request for ourself, unset error.
229 if ( empty($request) || $req_uri == $self || strpos($_SERVER['PHP_SELF'], 'wp-admin/') !== false ) {
230 unset( $error, $_GET['error'] );
232 if ( isset($perma_query_vars) && strpos($_SERVER['PHP_SELF'], 'wp-admin/') !== false )
233 unset( $perma_query_vars );
235 $this->did_permalink = false;
239 $this->public_query_vars = apply_filters('query_vars', $this->public_query_vars);
241 foreach ( get_post_types( array(), 'objects' ) as $post_type => $t )
243 $post_type_query_vars[$t->query_var] = $post_type;
245 foreach ( $this->public_query_vars as $wpvar ) {
246 if ( isset( $this->extra_query_vars[$wpvar] ) )
247 $this->query_vars[$wpvar] = $this->extra_query_vars[$wpvar];
248 elseif ( isset( $_POST[$wpvar] ) )
249 $this->query_vars[$wpvar] = $_POST[$wpvar];
250 elseif ( isset( $_GET[$wpvar] ) )
251 $this->query_vars[$wpvar] = $_GET[$wpvar];
252 elseif ( isset( $perma_query_vars[$wpvar] ) )
253 $this->query_vars[$wpvar] = $perma_query_vars[$wpvar];
255 if ( !empty( $this->query_vars[$wpvar] ) ) {
256 if ( ! is_array( $this->query_vars[$wpvar] ) ) {
257 $this->query_vars[$wpvar] = (string) $this->query_vars[$wpvar];
259 foreach ( $this->query_vars[$wpvar] as $vkey => $v ) {
260 if ( !is_object( $v ) ) {
261 $this->query_vars[$wpvar][$vkey] = (string) $v;
266 if ( isset($post_type_query_vars[$wpvar] ) ) {
267 $this->query_vars['post_type'] = $post_type_query_vars[$wpvar];
268 $this->query_vars['name'] = $this->query_vars[$wpvar];
273 // Convert urldecoded spaces back into +
274 foreach ( get_taxonomies( array() , 'objects' ) as $taxonomy => $t )
275 if ( $t->query_var && isset( $this->query_vars[$t->query_var] ) )
276 $this->query_vars[$t->query_var] = str_replace( ' ', '+', $this->query_vars[$t->query_var] );
278 // Limit publicly queried post_types to those that are publicly_queryable
279 if ( isset( $this->query_vars['post_type']) ) {
280 $queryable_post_types = get_post_types( array('publicly_queryable' => true) );
281 if ( ! is_array( $this->query_vars['post_type'] ) ) {
282 if ( ! in_array( $this->query_vars['post_type'], $queryable_post_types ) )
283 unset( $this->query_vars['post_type'] );
285 $this->query_vars['post_type'] = array_intersect( $this->query_vars['post_type'], $queryable_post_types );
289 foreach ( (array) $this->private_query_vars as $var) {
290 if ( isset($this->extra_query_vars[$var]) )
291 $this->query_vars[$var] = $this->extra_query_vars[$var];
295 $this->query_vars['error'] = $error;
297 $this->query_vars = apply_filters('request', $this->query_vars);
299 do_action_ref_array('parse_request', array(&$this));
303 * Send additional HTTP headers for caching, content type, etc.
305 * Sets the X-Pingback header, 404 status (if 404), Content-type. If showing
306 * a feed, it will also send last-modified, etag, and 304 status if needed.
310 function send_headers() {
311 $headers = array('X-Pingback' => get_bloginfo('pingback_url'));
313 $exit_required = false;
315 if ( is_user_logged_in() )
316 $headers = array_merge($headers, wp_get_nocache_headers());
317 if ( ! empty( $this->query_vars['error'] ) ) {
318 $status = (int) $this->query_vars['error'];
319 if ( 404 === $status ) {
320 if ( ! is_user_logged_in() )
321 $headers = array_merge($headers, wp_get_nocache_headers());
322 $headers['Content-Type'] = get_option('html_type') . '; charset=' . get_option('blog_charset');
323 } elseif ( in_array( $status, array( 403, 500, 502, 503 ) ) ) {
324 $exit_required = true;
326 } else if ( empty($this->query_vars['feed']) ) {
327 $headers['Content-Type'] = get_option('html_type') . '; charset=' . get_option('blog_charset');
329 // We're showing a feed, so WP is indeed the only thing that last changed
330 if ( !empty($this->query_vars['withcomments'])
331 || false !== strpos( $this->query_vars['feed'], 'comments-' )
332 || ( empty($this->query_vars['withoutcomments'])
333 && ( !empty($this->query_vars['p'])
334 || !empty($this->query_vars['name'])
335 || !empty($this->query_vars['page_id'])
336 || !empty($this->query_vars['pagename'])
337 || !empty($this->query_vars['attachment'])
338 || !empty($this->query_vars['attachment_id'])
342 $wp_last_modified = mysql2date('D, d M Y H:i:s', get_lastcommentmodified('GMT'), 0).' GMT';
344 $wp_last_modified = mysql2date('D, d M Y H:i:s', get_lastpostmodified('GMT'), 0).' GMT';
345 $wp_etag = '"' . md5($wp_last_modified) . '"';
346 $headers['Last-Modified'] = $wp_last_modified;
347 $headers['ETag'] = $wp_etag;
349 // Support for Conditional GET
350 if (isset($_SERVER['HTTP_IF_NONE_MATCH']))
351 $client_etag = wp_unslash( $_SERVER['HTTP_IF_NONE_MATCH'] );
352 else $client_etag = false;
354 $client_last_modified = empty($_SERVER['HTTP_IF_MODIFIED_SINCE']) ? '' : trim($_SERVER['HTTP_IF_MODIFIED_SINCE']);
355 // If string is empty, return 0. If not, attempt to parse into a timestamp
356 $client_modified_timestamp = $client_last_modified ? strtotime($client_last_modified) : 0;
358 // Make a timestamp for our most recent modification...
359 $wp_modified_timestamp = strtotime($wp_last_modified);
361 if ( ($client_last_modified && $client_etag) ?
362 (($client_modified_timestamp >= $wp_modified_timestamp) && ($client_etag == $wp_etag)) :
363 (($client_modified_timestamp >= $wp_modified_timestamp) || ($client_etag == $wp_etag)) ) {
365 $exit_required = true;
369 $headers = apply_filters('wp_headers', $headers, $this);
371 if ( ! empty( $status ) )
372 status_header( $status );
374 // If Last-Modified is set to false, it should not be sent (no-cache situation).
375 if ( isset( $headers['Last-Modified'] ) && false === $headers['Last-Modified'] ) {
376 unset( $headers['Last-Modified'] );
378 // In PHP 5.3+, make sure we are not sending a Last-Modified header.
379 if ( function_exists( 'header_remove' ) ) {
380 @header_remove( 'Last-Modified' );
382 // In PHP 5.2, send an empty Last-Modified header, but only as a
383 // last resort to override a header already sent. #WP23021
384 foreach ( headers_list() as $header ) {
385 if ( 0 === stripos( $header, 'Last-Modified' ) ) {
386 $headers['Last-Modified'] = '';
393 foreach( (array) $headers as $name => $field_value )
394 @header("{$name}: {$field_value}");
396 if ( $exit_required )
399 do_action_ref_array('send_headers', array(&$this));
403 * Sets the query string property based off of the query variable property.
405 * The 'query_string' filter is deprecated, but still works. Plugins should
406 * use the 'request' filter instead.
410 function build_query_string() {
411 $this->query_string = '';
412 foreach ( (array) array_keys($this->query_vars) as $wpvar) {
413 if ( '' != $this->query_vars[$wpvar] ) {
414 $this->query_string .= (strlen($this->query_string) < 1) ? '' : '&';
415 if ( !is_scalar($this->query_vars[$wpvar]) ) // Discard non-scalars.
417 $this->query_string .= $wpvar . '=' . rawurlencode($this->query_vars[$wpvar]);
421 // query_string filter deprecated. Use request filter instead.
422 if ( has_filter('query_string') ) { // Don't bother filtering and parsing if no plugins are hooked in.
423 $this->query_string = apply_filters('query_string', $this->query_string);
424 parse_str($this->query_string, $this->query_vars);
429 * Set up the WordPress Globals.
431 * The query_vars property will be extracted to the GLOBALS. So care should
432 * be taken when naming global variables that might interfere with the
433 * WordPress environment.
435 * @global string $query_string Query string for the loop.
436 * @global array $posts The found posts.
437 * @global WP_Post|null $post The current post, if available.
438 * @global string $request The SQL statement for the request.
439 * @global int $more Only set, if single page or post.
440 * @global int $single If single page or post. Only set, if single page or post.
441 * @global WP_User $authordata Only set, if author archive.
445 function register_globals() {
448 // Extract updated query vars back into global namespace.
449 foreach ( (array) $wp_query->query_vars as $key => $value ) {
450 $GLOBALS[ $key ] = $value;
453 $GLOBALS['query_string'] = $this->query_string;
454 $GLOBALS['posts'] = & $wp_query->posts;
455 $GLOBALS['post'] = isset( $wp_query->post ) ? $wp_query->post : null;
456 $GLOBALS['request'] = $wp_query->request;
458 if ( $wp_query->is_single() || $wp_query->is_page() ) {
459 $GLOBALS['more'] = 1;
460 $GLOBALS['single'] = 1;
463 if ( $wp_query->is_author() && isset( $wp_query->post ) )
464 $GLOBALS['authordata'] = get_userdata( $wp_query->post->post_author );
468 * Set up the current user.
473 wp_get_current_user();
477 * Set up the Loop based on the query variables.
479 * @uses WP::$query_vars
482 function query_posts() {
483 global $wp_the_query;
484 $this->build_query_string();
485 $wp_the_query->query($this->query_vars);
489 * Set the Headers for 404, if nothing is found for requested URL.
491 * Issue a 404 if a request doesn't match any posts and doesn't match
492 * any object (e.g. an existing-but-empty category, tag, author) and a 404 was not already
493 * issued, and if the request was not a search or the homepage.
495 * Otherwise, issue a 200.
499 function handle_404() {
502 // If we've already issued a 404, bail.
506 // Never 404 for the admin, robots, or if we found posts.
507 if ( is_admin() || is_robots() || $wp_query->posts ) {
508 status_header( 200 );
512 // We will 404 for paged queries, as no posts were found.
513 if ( ! is_paged() ) {
515 // Don't 404 for these queries if they matched an object.
516 if ( ( is_tag() || is_category() || is_tax() || is_author() || is_post_type_archive() ) && $wp_query->get_queried_object() ) {
517 status_header( 200 );
521 // Don't 404 for these queries either.
522 if ( is_home() || is_search() ) {
523 status_header( 200 );
528 // Guess it's time to 404.
529 $wp_query->set_404();
530 status_header( 404 );
535 * Sets up all of the variables required by the WordPress environment.
537 * The action 'wp' has one parameter that references the WP object. It
538 * allows for accessing the properties and methods to further manipulate the
543 * @param string|array $query_args Passed to {@link parse_request()}
545 function main($query_args = '') {
547 $this->parse_request($query_args);
548 $this->send_headers();
549 $this->query_posts();
551 $this->register_globals();
552 do_action_ref_array('wp', array(&$this));
558 * Helper class to remove the need to use eval to replace $matches[] in query strings.
562 class WP_MatchesMapRegex {
572 * store for mapping result
580 * subject to perform mapping on (query string containing $matches[] references
588 * regexp pattern to match $matches[] references
592 var $_pattern = '(\$matches\[[1-9]+[0-9]*\])'; // magic number
597 * @param string $subject subject if regex
598 * @param array $matches data to use in map
601 function WP_MatchesMapRegex($subject, $matches) {
602 $this->_subject = $subject;
603 $this->_matches = $matches;
604 $this->output = $this->_map();
608 * Substitute substring matches in subject.
610 * static helper function to ease use
613 * @param string $subject subject
614 * @param array $matches data used for substitution
617 public static function apply($subject, $matches) {
618 $oSelf = new WP_MatchesMapRegex($subject, $matches);
619 return $oSelf->output;
623 * do the actual mapping
629 $callback = array($this, 'callback');
630 return preg_replace_callback($this->_pattern, $callback, $this->_subject);
634 * preg_replace_callback hook
637 * @param array $matches preg_replace regexp matches
640 function callback($matches) {
641 $index = intval(substr($matches[0], 9, -1));
642 return ( isset( $this->_matches[$index] ) ? urlencode($this->_matches[$index]) : '' );