Alert: This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

_get_component_from_parsed_url_array() WordPress Function

The get_component_from_parsed_url_array() function is used to get a specific component from a parsed URL array.

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

Retrieve a specific component from a parsed URL array.


Parameters

$url_parts

(array|false)(Required)The parsed URL. Can be false if the URL failed to parse.

$component

(int)(Optional)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 value: -1


Top ↑

Return

(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.


Top ↑

Source

File: wp-includes/http.php

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;
	}
}


Top ↑

Changelog

Changelog
VersionDescription
4.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.