W3cubDocs

/WordPress

wp_parse_url( string $url, int $component = -1 )

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

Description

PHP 5.4.7 expanded parse_url()’s ability to handle non-absolute url’s, including schemeless and relative url’s with :// in the path. This function works around those limitations providing a standard output on PHP 5.2~5.4+.

Secondly, across various PHP versions, schemeless URLs starting containing a ":" in the query are being handled inconsistently. This function works around those differences as well.

Parameters

$url

(string) (Required) The URL 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

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.

Source

File: wp-includes/http.php 

function wp_parse_url( $url, $component = -1 ) {
	$to_unset = array();
	$url      = strval( $url );

	if ( '//' === substr( $url, 0, 2 ) ) {
		$to_unset[] = 'scheme';
		$url        = 'placeholder:' . $url;
	} elseif ( '/' === substr( $url, 0, 1 ) ) {
		$to_unset[] = 'scheme';
		$to_unset[] = 'host';
		$url        = 'placeholder://placeholder' . $url;
	}

	$parts = parse_url( $url );

	if ( false === $parts ) {
		// Parsing failure.
		return $parts;
	}

	// Remove the placeholder values.
	foreach ( $to_unset as $key ) {
		unset( $parts[ $key ] );
	}

	return _get_component_from_parsed_url_array( $parts, $component );
}

Used By

Used By Description
wp-includes/formatting.php: wp_rel_callback()

Callback to add a rel attribute to HTML A element.
wp-includes/l10n.php: load_script_textdomain()

Loads the script translated strings.
wp-includes/embed.php: get_oembed_response_data_for_url()

Retrieves the oEmbed response data for a given URL.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::is_cross_domain()

Determines whether the admin and the frontend are on different domains.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::add_state_query_params()

Add customize state query params to a given URL if preview is allowed.
wp-includes/general-template.php: wp_resource_hints()

Prints resource hints to browsers for pre-fetching, pre-rendering and pre-connecting to web sites.
wp-includes/general-template.php: wp_dependencies_unique_hosts()

Retrieves a list of unique hosts of all enqueued scripts and styles.
wp-includes/class-http.php: WP_Http::parse_url()

Used as a wrapper for PHP’s parse_url() function that handles edgecases in < PHP 5.4.7.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::customize_preview_settings()

Print JavaScript settings for preview frame.
wp-includes/formatting.php: esc_url()

Checks and cleans a URL.
wp-includes/pluggable.php: wp_notify_postauthor()

Notify an author (and/or others) of a comment/trackback/pingback on a post.
wp-includes/pluggable.php: wp_mail()

Sends an email, similar to PHP’s mail function.
wp-includes/class-http.php: WP_Http::make_absolute_url()

Converts a relative URL to an absolute URL relative to a given URL.
wp-includes/media.php: wp_video_shortcode()

Builds the Video shortcode output.
wp-includes/ms-functions.php: wpmu_welcome_user_notification()

Notify a user that their account activation has been successful.
wp-includes/ms-functions.php: wpmu_welcome_notification()

Notify a user that their blog activation has been successful.
wp-includes/ms-functions.php: wpmu_signup_blog_notification()

Send a confirmation request email to a user when they sign up for a new site. The new site will not become active until the confirmation link is clicked.
wp-includes/ms-functions.php: wpmu_signup_user_notification()

Send a confirmation request email to a user when they sign up for a new user account (without signing up for a site at the same time). The user account will not become active until the confirmation link is clicked.

Changelog

Version Description
4.7.0 The $component parameter was added for parity with PHP's parse_url().
4.4.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_parse_url