WP::parse_request( array|string $extra_query_vars = '' ): bool

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$extra_query_varsarray|stringoptional

Set the extra query variables.Default: ''

Return value

bool

Whether the request was parsed.

Performance profile

How much work a call to WP::parse_request() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

79–182

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 486.

Plugin surface

4 hooks

Third-party callbacks on 'do_parse_request', 'query_vars', 'request' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• cacheobject cachewp_cache_get_last_changed()one call below WP::parse_request()
• querycontent queryget_post()one call below WP::parse_request()
• optionoption read or writeget_option()one call below WP::parse_request()

Further down the call graph this can also reach serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 12 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP::parse_request() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 4

4 hooks fire while WP::parse_request() runs, in this order:

1. 1
   apply_filters( do_parse_request )filterline 148 (+12 into the body)

   Filters whether to parse the request.

2. 2
   apply_filters( query_vars )filterline 311 (+175 into the body)

   Filters the query variables allowed before processing.

3. 3
   apply_filters( request )filterline 409 (+273 into the body)

   Filters the array of parsed query variables.

4. 4
   do_action( parse_request )actionline 418 (+282 into the body)

   Fires once all query variables for the current request have been parsed.

Uses · 15

• apply_filters()Calls the callback functions that have been added to a filter hook.
• home_url()Retrieves the URL for the current site where the front end is accessible.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• get_page_by_path()Retrieves a page given its path.
• get_post_status_object()Retrieves a post status object by name.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• get_post_types()Gets a list of all registered post type objects.
• is_post_type_viewable()Determines whether a post type is considered "viewable".
• wp_die()Kills WordPress execution and displays HTML page with an error message.
• __()Retrieves the translation of $text.
• get_taxonomies()Retrieves a list of registered taxonomy names or objects.
• is_admin()Determines whether the current request is for an administrative interface page.

Used by · 1

• WP::main()Sets up all of the variables required by the WordPress environment.

Source code

View on Trac ↗View on GitHub ↗

136	public function parse_request( $extra_query_vars = '' ) {137		global $wp_rewrite;138 139		/**140		 * Filters whether to parse the request.141		 *142		 * @since 3.5.0143		 *144		 * @param bool         $bool             Whether or not to parse the request. Default true.145		 * @param WP           $wp               Current WordPress environment instance.146		 * @param array|string $extra_query_vars Extra passed query variables.147		 */148		if ( ! apply_filters( 'do_parse_request', true, $this, $extra_query_vars ) ) {149			return false;150		}151 152		$this->query_vars     = array();153		$post_type_query_vars = array();154 155		if ( is_array( $extra_query_vars ) ) {156			$this->extra_query_vars = & $extra_query_vars;157		} elseif ( ! empty( $extra_query_vars ) ) {158			parse_str( $extra_query_vars, $this->extra_query_vars );159		}160		// Process PATH_INFO, REQUEST_URI, and 404 for permalinks.161 162		// Fetch the rewrite rules.163		$rewrite = $wp_rewrite->wp_rewrite_rules();164 165		if ( ! empty( $rewrite ) ) {166			// If we match a rewrite rule, this will be cleared.167			$error               = '404';168			$this->did_permalink = true;169 170			$pathinfo         = $_SERVER['PATH_INFO'] ?? '';171			list( $pathinfo ) = explode( '?', $pathinfo );172			$pathinfo         = str_replace( '%', '%25', $pathinfo );173 174			list( $req_uri ) = explode( '?', $_SERVER['REQUEST_URI'] );175			$self            = $_SERVER['PHP_SELF'];176 177			$home_path       = parse_url( home_url(), PHP_URL_PATH );178			$home_path_regex = '';179			if ( is_string( $home_path ) && '' !== $home_path ) {180				$home_path       = trim( $home_path, '/' );181				$home_path_regex = sprintf( '|^%s|i', preg_quote( $home_path, '|' ) );182			}183 184			/*185			 * Trim path info from the end and the leading home path from the front.186			 * For path info requests, this leaves us with the requesting filename, if any.187			 * For 404 requests, this leaves us with the requested permalink.188			 */189			$req_uri  = str_replace( $pathinfo, '', $req_uri );190			$req_uri  = trim( $req_uri, '/' );191			$pathinfo = trim( $pathinfo, '/' );192			$self     = trim( $self, '/' );193 194			if ( ! empty( $home_path_regex ) ) {195				$req_uri  = preg_replace( $home_path_regex, '', $req_uri );196				$req_uri  = trim( $req_uri, '/' );197				$pathinfo = preg_replace( $home_path_regex, '', $pathinfo );198				$pathinfo = trim( $pathinfo, '/' );199				$self     = preg_replace( $home_path_regex, '', $self );200				$self     = trim( $self, '/' );201			}202 203			// The requested permalink is in $pathinfo for path info requests and $req_uri for other requests.204			if ( ! empty( $pathinfo ) && ! preg_match( '|^.*' . $wp_rewrite->index . '$|', $pathinfo ) ) {205				$requested_path = $pathinfo;206			} else {207				// If the request uri is the index, blank it out so that we don't try to match it against a rule.208				if ( $req_uri === $wp_rewrite->index ) {209					$req_uri = '';210				}211 212				$requested_path = $req_uri;213			}214 215			$requested_file = $req_uri;

Changelog

Introduced in 2.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/class-wp.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.