WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_parse_url()

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

In this article

Back to top

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

Description

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

Parameters

$urlstringrequired
The URL 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

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

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

	if ( str_starts_with( $url, '//' ) ) {
		$to_unset[] = 'scheme';
		$url        = 'placeholder:' . $url;
	} elseif ( str_starts_with( $url, '/' ) ) {
		$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 );
}

View all references View on Trac View on GitHub

UsesDescription
_get_component_from_parsed_url_array()wp-includes/http.php

Retrieves a specific component from a parsed URL array.

Used byDescription
WP_URL_Pattern_Prefixer::get_default_contexts()wp-includes/class-wp-url-pattern-prefixer.php

Returns the default contexts used by the class.

wp_is_authorize_application_redirect_url_valid()wp-admin/includes/user.php

Validates the redirect URL protocol scheme. The protocol can be anything except http and javascript.

_make_clickable_rel_attr()wp-includes/formatting.php

Helper function used to build the “rel” attribute for a URL when creating an anchor using make_clickable() .

wp_is_internal_link()wp-includes/link-template.php

Determines whether or not the specified URL is of a host included in the internal hosts list.

wp_internal_hosts()wp-includes/link-template.php

Returns an array of URL hosts which are considered to be internal hosts.

wp_is_home_url_using_https()wp-includes/https-detection.php

Checks whether the current site URL is using HTTPS.

wp_is_site_url_using_https()wp-includes/https-detection.php

Checks whether the current site’s URL where WordPress is stored is using HTTPS.

wp_should_replace_insecure_home_url()wp-includes/https-migration.php

Checks whether WordPress should replace old HTTP URLs to the site with their HTTPS counterpart.

WP_REST_Server::serve_batch_request_v1()wp-includes/rest-api/class-wp-rest-server.php

Serves the batch/v1 request.

get_oembed_response_data_for_url()wp-includes/embed.php

Retrieves the oEmbed response data for a given URL.

WP_Customize_Manager::is_cross_domain()wp-includes/class-wp-customize-manager.php

Determines whether the admin and the frontend are on different domains.

WP_Customize_Manager::add_state_query_params()wp-includes/class-wp-customize-manager.php

Adds customize state query params to a given URL if preview is allowed.

wp_resource_hints()wp-includes/general-template.php

Prints resource hints to browsers for pre-fetching, pre-rendering and pre-connecting to websites.

wp_dependencies_unique_hosts()wp-includes/general-template.php

Retrieves a list of unique hosts of all enqueued scripts and styles.

strip_fragment_from_url()wp-includes/canonical.php

Strips the #fragment from a URL, if one is present.

WP_Http::parse_url()wp-includes/class-wp-http.php

Used as a wrapper for PHP’s parse_url() function that handles edgecases in < PHP 5.4.7.

WP_Customize_Manager::customize_preview_settings()wp-includes/class-wp-customize-manager.php

Prints JavaScript settings for preview frame.

esc_url()wp-includes/formatting.php

Checks and cleans a URL.

wp_notify_postauthor()wp-includes/pluggable.php

Notifies an author (and/or others) of a comment/trackback/pingback on a post.

wp_mail()wp-includes/pluggable.php

Sends an email, similar to PHP’s mail function.

WP_Http::make_absolute_url()wp-includes/class-wp-http.php

Converts a relative URL to an absolute URL relative to a given URL.

wp_update_plugins()wp-includes/update.php

Checks for available updates to plugins based on the latest versions hosted on WordPress.org.

wp_update_themes()wp-includes/update.php

Checks for available updates to themes based on the latest versions hosted on WordPress.org.

wpmu_welcome_user_notification()wp-includes/ms-functions.php

Notifies a user that their account activation has been successful.

wpmu_welcome_notification()wp-includes/ms-functions.php

Notifies the site administrator that their site activation was successful.

wpmu_signup_blog_notification()wp-includes/ms-functions.php

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

wpmu_signup_user_notification()wp-includes/ms-functions.php

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

Show 22 moreShow less

Changelog

VersionDescription
4.7.0The $component parameter was added for parity with PHP’s parse_url().
4.4.0Introduced.

User Contributed Notes

  1. Skip to note 5 content
    Barrett Golding
    You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note

    Example return array

    // Get array of URL 'scheme', 'host', and 'path'.
$url_parse = wp_parse_url( 'https://developer.wordpress.org/reference/functions/wp_parse_url/' );

// Output URL's path.
echo $url_parse['path'];

/*
Array
(
    [scheme] => https
    [host] => developer.wordpress.org
    [path] => /reference/functions/wp_parse_url/
)
*/
  2. Skip to note 6 content
    Philipp Stracker
    You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

    For reference, here’s a sample that shows URL parts that are returned by parse_url:

    $url = 'https://user:pass@example.org:8080/path/to/file.min.js?param=value&int=1#anchor';
print_r( wp_parse_url( $url ) );

/*
Array
(
    [scheme] => https
    [host] => example.org
    [port] => 8080
    [user] => user
    [pass] => pass
    [path] => /path/to/file.min.js
    [query] => param=value&int=1
    [fragment] => anchor
)
*/

    And here’s a list of valid $component values:

    * PHP_URL_SCHEME
    * PHP_URL_HOST
    * PHP_URL_PORT
    * PHP_URL_USER
    * PHP_URL_PASS
    * PHP_URL_PATH
    * PHP_URL_QUERY
    * PHP_URL_FRAGMENT

  3. Skip to note 7 content
    rebasaurus
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

    wp_parse_url() seems to fix a bug of parse_url(), where port-like string in URL is incorrectly parsed as a port:

    wp_parse_url( '//example.com/foo:1234' );

/* Output:
array(2) {
  "host" => string(11) "example.com"
  "path" => string(9) "/foo:1234"
} */
    parse_url( '//example.com/foo:1234' );

/* Output:
array(3) {
  "host" => string(11) "example.com"
  "port" => int( 1234 )
  "path" => string(9) "/foo:1234"
} */

You must log in before being able to contribute a note or feedback.