WordPress 3.8.3

[autoinstalls/wordpress.git] / wp-includes / class-wp.php

diff --git a/wp-includes/class-wp.php b/wp-includes/class-wp.php
index 05fd43ef6b530f4b75da0c2e976d410f11154f94..2fe76fc8b7e09fea40d3218017ddd195327d01a9 100644 (file)
--- a/wp-includes/class-wp.php
+++ b/wp-includes/class-wp.php
@@ -120,6 +120,15 @@ class WP {
        function parse_request($extra_query_vars = '') {
                global $wp_rewrite;
 
+               /**
+                * Filter whether to parse the request.
+                *
+                * @since 3.5.0
+                *
+                * @param bool         $bool             Whether or not to parse the request. Default true.
+                * @param WP           $this             Current WordPress environment instance.
+                * @param array|string $extra_query_vars Extra passed query variables.
+                */
                if ( ! apply_filters( 'do_parse_request', true, $this, $extra_query_vars ) )
                        return;
 
@@ -236,7 +245,18 @@ class WP {
                        }
                }
 
-               $this->public_query_vars = apply_filters('query_vars', $this->public_query_vars);
+               /**
+                * Filter the query variables whitelist before processing.
+                *
+                * Allows (publicly allowed) query vars to be added, removed, or changed prior
+                * to executing the query. Needed to allow custom rewrite rules using your own arguments
+                * to work, or any other custom query variables you want to be publicly available.
+                *
+                * @since 1.5.0
+                *
+                * @param array $public_query_vars The array of whitelisted query variables.
+                */
+               $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 )
@@ -294,9 +314,23 @@ class WP {
                if ( isset($error) )
                        $this->query_vars['error'] = $error;
 
-               $this->query_vars = apply_filters('request', $this->query_vars);
-
-               do_action_ref_array('parse_request', array(&$this));
+               /**
+                * Filter the array of parsed query variables.
+                *
+                * @since 2.1.0
+                *
+                * @param array $query_vars The array of requested query variables.
+                */
+               $this->query_vars = apply_filters( 'request', $this->query_vars );
+
+               /**
+                * Fires once all query variables for the current request have been parsed.
+                *
+                * @since 2.1.0
+                *
+                * @param WP &$this Current WordPress environment instance (passed by reference).
+                */
+               do_action_ref_array( 'parse_request', array( &$this ) );
        }
 
        /**
@@ -366,7 +400,15 @@ class WP {
                        }
                }
 
-               $headers = apply_filters('wp_headers', $headers, $this);
+               /**
+                * Filter the HTTP headers before they're sent to the browser.
+                *
+                * @since 2.8.0
+                *
+                * @param array $headers The list of headers to be sent.
+                * @param WP    $this    Current WordPress environment instance.
+                */
+               $headers = apply_filters( 'wp_headers', $headers, $this );
 
                if ( ! empty( $status ) )
                        status_header( $status );
@@ -396,7 +438,14 @@ class WP {
                if ( $exit_required )
                        exit();
 
-               do_action_ref_array('send_headers', array(&$this));
+               /**
+                * Fires once the requested HTTP headers for caching, content type, etc. have been sent.
+                *
+                * @since 2.1.0
+                *
+                * @param WP &$this Current WordPress environment instance (passed by reference).
+                */
+               do_action_ref_array( 'send_headers', array( &$this ) );
        }
 
        /**
@@ -418,9 +467,16 @@ class WP {
                        }
                }
 
-               // query_string filter deprecated. Use request filter instead.
-               if ( has_filter('query_string') ) {  // Don't bother filtering and parsing if no plugins are hooked in.
-                       $this->query_string = apply_filters('query_string', $this->query_string);
+               if ( has_filter( 'query_string' ) ) {  // Don't bother filtering and parsing if no plugins are hooked in.
+                       /**
+                        * Filter the query string before parsing.
+                        *
+                        * @since 1.5.0
+                        * @deprecated 2.1.0 Use 'query_vars' or 'request' filters instead.
+                        *
+                        * @param string $query_string The query string to modify.
+                        */
+                       $this->query_string = apply_filters( 'query_string', $this->query_string );
                        parse_str($this->query_string, $this->query_vars);
                }
        }
@@ -549,7 +605,15 @@ class WP {
                $this->query_posts();
                $this->handle_404();
                $this->register_globals();
-               do_action_ref_array('wp', array(&$this));
+
+               /**
+                * Fires once the WordPress environment has been set up.
+                *
+                * @since 2.1.0
+                *
+                * @param WP &$this Current WordPress environment instance (passed by reference).
+                */
+               do_action_ref_array( 'wp', array( &$this ) );
        }
 
 }