wppaste
WordPress

_get_component_from_parsed_url_array( array|false $url_parts, int $component = -1 ): mixed

Since
4.7.0
Source
wp-includes/http.php:780
Retrieves a specific component from a parsed URL array.

Compatibility

WordPress
since 4.7.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$url_partsarray|false
The parsed URL. Can be false if the URL failed to parse.
$componentintoptional
The specific component to retrieve. Use one of the PHP predefined constants to specify which one.
Defaults to -1 (= return all parts as an array).Default: -1

Return value

mixed
False on parse failure; Array of URL components on success; When a specific component has been requested: null if the component doesn't exist in the given URL; a string or - in the case of PHP_URL_PORT - integer when it does. See parse_url()'s return values.

Performance profile

How much work a call to _get_component_from_parsed_url_array() 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
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
5–16

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

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

What one call costs · 2 distinct outcomes

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

WhenInstructionsCalls it makes
$component === -15none
$component !== -111–16_wp_translate_php_url_constant_to_key()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 18 instructions, 5–16 executed per call, 4 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 1

Used by · 1

  • wp_parse_url()A wrapper for PHP's parse_url() function that handles consistency in the return values across PHP versions.

Source code

View on Trac View on GitHub 

function _get_component_from_parsed_url_array( $url_parts, $component = -1 ) {	if ( -1 === $component ) {		return $url_parts;	} 	$key = _wp_translate_php_url_constant_to_key( $component );	if ( false !== $key && is_array( $url_parts ) && isset( $url_parts[ $key ] ) ) {		return $url_parts[ $key ];	} else {		return null;	}}

Changelog

Introduced in 4.7.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 6.8.8 tag, from src/wp-includes/http.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.