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', 'debug', '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');
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 $this->query_vars = array();
124 $post_type_query_vars = array();
126 if ( is_array($extra_query_vars) )
127 $this->extra_query_vars = & $extra_query_vars;
128 else if (! empty($extra_query_vars))
129 parse_str($extra_query_vars, $this->extra_query_vars);
131 // Process PATH_INFO, REQUEST_URI, and 404 for permalinks.
133 // Fetch the rewrite rules.
134 $rewrite = $wp_rewrite->wp_rewrite_rules();
136 if ( ! empty($rewrite) ) {
137 // If we match a rewrite rule, this will be cleared.
139 $this->did_permalink = true;
141 if ( isset($_SERVER['PATH_INFO']) )
142 $pathinfo = $_SERVER['PATH_INFO'];
145 $pathinfo_array = explode('?', $pathinfo);
146 $pathinfo = str_replace("%", "%25", $pathinfo_array[0]);
147 $req_uri = $_SERVER['REQUEST_URI'];
148 $req_uri_array = explode('?', $req_uri);
149 $req_uri = $req_uri_array[0];
150 $self = $_SERVER['PHP_SELF'];
151 $home_path = parse_url(home_url());
152 if ( isset($home_path['path']) )
153 $home_path = $home_path['path'];
156 $home_path = trim($home_path, '/');
158 // Trim path info from the end and the leading home path from the
159 // front. For path info requests, this leaves us with the requesting
160 // filename, if any. For 404 requests, this leaves us with the
161 // requested permalink.
162 $req_uri = str_replace($pathinfo, '', $req_uri);
163 $req_uri = trim($req_uri, '/');
164 $req_uri = preg_replace("|^$home_path|", '', $req_uri);
165 $req_uri = trim($req_uri, '/');
166 $pathinfo = trim($pathinfo, '/');
167 $pathinfo = preg_replace("|^$home_path|", '', $pathinfo);
168 $pathinfo = trim($pathinfo, '/');
169 $self = trim($self, '/');
170 $self = preg_replace("|^$home_path|", '', $self);
171 $self = trim($self, '/');
173 // The requested permalink is in $pathinfo for path info requests and
174 // $req_uri for other requests.
175 if ( ! empty($pathinfo) && !preg_match('|^.*' . $wp_rewrite->index . '$|', $pathinfo) ) {
176 $request = $pathinfo;
178 // If the request uri is the index, blank it out so that we don't try to match it against a rule.
179 if ( $req_uri == $wp_rewrite->index )
184 $this->request = $request;
187 $request_match = $request;
188 foreach ( (array) $rewrite as $match => $query) {
189 // Don't try to match against AtomPub calls
190 if ( $req_uri == 'wp-app.php' )
193 // If the requesting file is the anchor of the match, prepend it
195 if ( (! empty($req_uri)) && (strpos($match, $req_uri) === 0) && ($req_uri != $request) )
196 $request_match = $req_uri . '/' . $request;
198 if ( preg_match("#^$match#", $request_match, $matches) ||
199 preg_match("#^$match#", urldecode($request_match), $matches) ) {
201 $this->matched_rule = $match;
203 // Trim the query of everything up to the '?'.
204 $query = preg_replace("!^.+\?!", '', $query);
206 // Substitute the substring matches into the query.
207 $query = addslashes(WP_MatchesMapRegex::apply($query, $matches));
209 $this->matched_query = $query;
212 parse_str($query, $perma_query_vars);
214 // If we're processing a 404 request, clear the error var
215 // since we found something.
216 if ( isset($_GET['error']) )
217 unset($_GET['error']);
226 // If req_uri is empty or if it is a request for ourself, unset error.
227 if ( empty($request) || $req_uri == $self || strpos($_SERVER['PHP_SELF'], 'wp-admin/') !== false ) {
228 if ( isset($_GET['error']) )
229 unset($_GET['error']);
234 if ( isset($perma_query_vars) && strpos($_SERVER['PHP_SELF'], 'wp-admin/') !== false )
235 unset($perma_query_vars);
237 $this->did_permalink = false;
241 $this->public_query_vars = apply_filters('query_vars', $this->public_query_vars);
243 foreach ( $GLOBALS['wp_post_types'] as $post_type => $t )
245 $post_type_query_vars[$t->query_var] = $post_type;
247 foreach ( $this->public_query_vars as $wpvar ) {
248 if ( isset( $this->extra_query_vars[$wpvar] ) )
249 $this->query_vars[$wpvar] = $this->extra_query_vars[$wpvar];
250 elseif ( isset( $_POST[$wpvar] ) )
251 $this->query_vars[$wpvar] = $_POST[$wpvar];
252 elseif ( isset( $_GET[$wpvar] ) )
253 $this->query_vars[$wpvar] = $_GET[$wpvar];
254 elseif ( isset( $perma_query_vars[$wpvar] ) )
255 $this->query_vars[$wpvar] = $perma_query_vars[$wpvar];
257 if ( !empty( $this->query_vars[$wpvar] ) ) {
258 if ( ! is_array( $this->query_vars[$wpvar] ) ) {
259 $this->query_vars[$wpvar] = (string) $this->query_vars[$wpvar];
261 foreach ( $this->query_vars[$wpvar] as $vkey => $v ) {
262 if ( !is_object( $v ) ) {
263 $this->query_vars[$wpvar][$vkey] = (string) $v;
268 if ( isset($post_type_query_vars[$wpvar] ) ) {
269 $this->query_vars['post_type'] = $post_type_query_vars[$wpvar];
270 $this->query_vars['name'] = $this->query_vars[$wpvar];
275 // Convert urldecoded spaces back into +
276 foreach ( $GLOBALS['wp_taxonomies'] as $taxonomy => $t )
277 if ( $t->query_var && isset( $this->query_vars[$t->query_var] ) )
278 $this->query_vars[$t->query_var] = str_replace( ' ', '+', $this->query_vars[$t->query_var] );
280 // Limit publicly queried post_types to those that are publicly_queryable
281 if ( isset( $this->query_vars['post_type']) ) {
282 $queryable_post_types = get_post_types( array('publicly_queryable' => true) );
283 if ( ! is_array( $this->query_vars['post_type'] ) ) {
284 if ( ! in_array( $this->query_vars['post_type'], $queryable_post_types ) )
285 unset( $this->query_vars['post_type'] );
287 $this->query_vars['post_type'] = array_intersect( $this->query_vars['post_type'], $queryable_post_types );
291 foreach ( (array) $this->private_query_vars as $var) {
292 if ( isset($this->extra_query_vars[$var]) )
293 $this->query_vars[$var] = $this->extra_query_vars[$var];
297 $this->query_vars['error'] = $error;
299 $this->query_vars = apply_filters('request', $this->query_vars);
301 do_action_ref_array('parse_request', array(&$this));
305 * Send additional HTTP headers for caching, content type, etc.
307 * Sets the X-Pingback header, 404 status (if 404), Content-type. If showing
308 * a feed, it will also send last-modified, etag, and 304 status if needed.
312 function send_headers() {
313 $headers = array('X-Pingback' => get_bloginfo('pingback_url'));
315 $exit_required = false;
317 if ( is_user_logged_in() )
318 $headers = array_merge($headers, wp_get_nocache_headers());
319 if ( !empty($this->query_vars['error']) && '404' == $this->query_vars['error'] ) {
321 if ( !is_user_logged_in() )
322 $headers = array_merge($headers, wp_get_nocache_headers());
323 $headers['Content-Type'] = get_option('html_type') . '; charset=' . get_option('blog_charset');
324 } else if ( empty($this->query_vars['feed']) ) {
325 $headers['Content-Type'] = get_option('html_type') . '; charset=' . get_option('blog_charset');
327 // We're showing a feed, so WP is indeed the only thing that last changed
328 if ( !empty($this->query_vars['withcomments'])
329 || ( empty($this->query_vars['withoutcomments'])
330 && ( !empty($this->query_vars['p'])
331 || !empty($this->query_vars['name'])
332 || !empty($this->query_vars['page_id'])
333 || !empty($this->query_vars['pagename'])
334 || !empty($this->query_vars['attachment'])
335 || !empty($this->query_vars['attachment_id'])
339 $wp_last_modified = mysql2date('D, d M Y H:i:s', get_lastcommentmodified('GMT'), 0).' GMT';
341 $wp_last_modified = mysql2date('D, d M Y H:i:s', get_lastpostmodified('GMT'), 0).' GMT';
342 $wp_etag = '"' . md5($wp_last_modified) . '"';
343 $headers['Last-Modified'] = $wp_last_modified;
344 $headers['ETag'] = $wp_etag;
346 // Support for Conditional GET
347 if (isset($_SERVER['HTTP_IF_NONE_MATCH']))
348 $client_etag = stripslashes(stripslashes($_SERVER['HTTP_IF_NONE_MATCH']));
349 else $client_etag = false;
351 $client_last_modified = empty($_SERVER['HTTP_IF_MODIFIED_SINCE']) ? '' : trim($_SERVER['HTTP_IF_MODIFIED_SINCE']);
352 // If string is empty, return 0. If not, attempt to parse into a timestamp
353 $client_modified_timestamp = $client_last_modified ? strtotime($client_last_modified) : 0;
355 // Make a timestamp for our most recent modification...
356 $wp_modified_timestamp = strtotime($wp_last_modified);
358 if ( ($client_last_modified && $client_etag) ?
359 (($client_modified_timestamp >= $wp_modified_timestamp) && ($client_etag == $wp_etag)) :
360 (($client_modified_timestamp >= $wp_modified_timestamp) || ($client_etag == $wp_etag)) ) {
362 $exit_required = true;
366 $headers = apply_filters('wp_headers', $headers, $this);
368 if ( ! empty( $status ) )
369 status_header( $status );
370 foreach( (array) $headers as $name => $field_value )
371 @header("{$name}: {$field_value}");
373 if ( $exit_required )
376 do_action_ref_array('send_headers', array(&$this));
380 * Sets the query string property based off of the query variable property.
382 * The 'query_string' filter is deprecated, but still works. Plugins should
383 * use the 'request' filter instead.
387 function build_query_string() {
388 $this->query_string = '';
389 foreach ( (array) array_keys($this->query_vars) as $wpvar) {
390 if ( '' != $this->query_vars[$wpvar] ) {
391 $this->query_string .= (strlen($this->query_string) < 1) ? '' : '&';
392 if ( !is_scalar($this->query_vars[$wpvar]) ) // Discard non-scalars.
394 $this->query_string .= $wpvar . '=' . rawurlencode($this->query_vars[$wpvar]);
398 // query_string filter deprecated. Use request filter instead.
399 if ( has_filter('query_string') ) { // Don't bother filtering and parsing if no plugins are hooked in.
400 $this->query_string = apply_filters('query_string', $this->query_string);
401 parse_str($this->query_string, $this->query_vars);
406 * Set up the WordPress Globals.
408 * The query_vars property will be extracted to the GLOBALS. So care should
409 * be taken when naming global variables that might interfere with the
410 * WordPress environment.
412 * @global string $query_string Query string for the loop.
413 * @global int $more Only set, if single page or post.
414 * @global int $single If single page or post. Only set, if single page or post.
418 function register_globals() {
420 // Extract updated query vars back into global namespace.
421 foreach ( (array) $wp_query->query_vars as $key => $value) {
422 $GLOBALS[$key] = $value;
425 $GLOBALS['query_string'] = $this->query_string;
426 $GLOBALS['posts'] = & $wp_query->posts;
427 $GLOBALS['post'] = (isset($wp_query->post)) ? $wp_query->post : null;
428 $GLOBALS['request'] = $wp_query->request;
430 if ( is_single() || is_page() ) {
431 $GLOBALS['more'] = 1;
432 $GLOBALS['single'] = 1;
437 * Set up the current user.
442 wp_get_current_user();
446 * Set up the Loop based on the query variables.
448 * @uses WP::$query_vars
451 function query_posts() {
452 global $wp_the_query;
453 $this->build_query_string();
454 $wp_the_query->query($this->query_vars);
458 * Set the Headers for 404, if nothing is found for requested URL.
460 * Issue a 404 if a request doesn't match any posts and doesn't match
461 * any object (e.g. an existing-but-empty category, tag, author) and a 404 was not already
462 * issued, and if the request was not a search or the homepage.
464 * Otherwise, issue a 200.
468 function handle_404() {
471 if ( !is_admin() && ( 0 == count( $wp_query->posts ) ) && !is_404() && !is_robots() && !is_search() && !is_home() ) {
472 // Don't 404 for these queries if they matched an object.
473 if ( ( is_tag() || is_category() || is_tax() || is_author() ) && $wp_query->get_queried_object() && !is_paged() ) {
475 status_header( 200 );
478 $wp_query->set_404();
479 status_header( 404 );
481 } elseif ( !is_404() ) {
482 status_header( 200 );
487 * Sets up all of the variables required by the WordPress environment.
489 * The action 'wp' has one parameter that references the WP object. It
490 * allows for accessing the properties and methods to further manipulate the
495 * @param string|array $query_args Passed to {@link parse_request()}
497 function main($query_args = '') {
499 $this->parse_request($query_args);
500 $this->send_headers();
501 $this->query_posts();
503 $this->register_globals();
504 do_action_ref_array('wp', array(&$this));
508 * PHP4 Constructor - Does nothing.
510 * Call main() method when ready to run setup.
522 * Helper class to remove the need to use eval to replace $matches[] in query strings.
526 class WP_MatchesMapRegex {
536 * store for mapping result
544 * subject to perform mapping on (query string containing $matches[] references
552 * regexp pattern to match $matches[] references
556 var $_pattern = '(\$matches\[[1-9]+[0-9]*\])'; // magic number
561 * @param string $subject subject if regex
562 * @param array $matches data to use in map
565 function WP_MatchesMapRegex($subject, $matches) {
566 $this->_subject = $subject;
567 $this->_matches = $matches;
568 $this->output = $this->_map();
572 * Substitute substring matches in subject.
574 * static helper function to ease use
577 * @param string $subject subject
578 * @param array $matches data used for subsitution
581 function apply($subject, $matches) {
582 $oSelf =& new WP_MatchesMapRegex($subject, $matches);
583 return $oSelf->output;
587 * do the actual mapping
593 $callback = array(&$this, 'callback');
594 return preg_replace_callback($this->_pattern, $callback, $this->_subject);
598 * preg_replace_callback hook
601 * @param array $matches preg_replace regexp matches
604 function callback($matches) {
605 $index = intval(substr($matches[0], 9, -1));
606 return ( isset( $this->_matches[$index] ) ? urlencode($this->_matches[$index]) : '' );