Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-12-22 17:18:32 +01:00
Code Issues Projects Releases Wiki Activity

Inline documentation for hooks in wp-includes/class-wp.php.

Browse Source 
Props dougwollison.
Fixes #25495.

Built from https://develop.svn.wordpress.org/trunk@25940


git-svn-id: http://core.svn.wordpress.org/trunk@25899 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2013-10-26 21:03:09 +00:00
parent ceb16bc719
commit 75e0cad6af
1 changed files with 75 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
wp-includes/class-wp.php
View File

@ -120,6 +120,15 @@ class WP {
function parse_request($extra_query_vars = '') { function parse_request($extra_query_vars = '') {
global $wp_rewrite; 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 ) ) if ( ! apply_filters( 'do_parse_request', true, $this, $extra_query_vars ) )
return; return;
@ -236,7 +245,19 @@ class WP {
} }
} }
$this->public_query_vars = apply_filters('query_vars', $this->public_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.2
*
* @param array $public_query_vars The array of whitelisted query variables.
*/
$this->public_query_vars = apply_filters( 'query_vars', $public_query_vars );
foreach ( get_post_types( array(), 'objects' ) as $post_type => $t ) foreach ( get_post_types( array(), 'objects' ) as $post_type => $t )
if ( $t->query_var ) if ( $t->query_var )
@ -294,9 +315,24 @@ class WP {
if ( isset($error) ) if ( isset($error) )
$this->query_vars['error'] = $error; $this->query_vars['error'] = $error;
$this->query_vars = apply_filters('request', $this->query_vars); $query_vars = $this->query_vars;
/**
* 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', $query_vars );
do_action_ref_array('parse_request', array(&$this)); /**
* 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 +402,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 ) ) if ( ! empty( $status ) )
status_header( $status ); status_header( $status );
@ -396,7 +440,14 @@ class WP {
if ( $exit_required ) if ( $exit_required )
exit(); 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 +469,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.
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); * Filter the query string before parsing.
*
* @since 1.5.2
* @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); parse_str($this->query_string, $this->query_vars);
} }
} }
@ -549,7 +607,15 @@ class WP {
$this->query_posts(); $this->query_posts();
$this->handle_404(); $this->handle_404();
$this->register_globals(); $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 ) );
} }
} }