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

Description

Parameters

$urlstring

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.

Uses · 2

• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• _get_component_from_parsed_url_array()Retrieves a specific component from a parsed URL array.

Used by · 32

• WP_Customize_Manager::add_state_query_params()Adds customize state query params to a given URL if preview is allowed.
• WP_Customize_Manager::customize_preview_settings()Prints JavaScript settings for preview frame.
• WP_Customize_Manager::is_cross_domain()Determines whether the admin and the frontend are on different domains.
• WP_Http::make_absolute_url()Converts a relative URL to an absolute URL relative to a given URL.
• WP_Http::parse_url()Used as a wrapper for PHP's parse_url() function that handles edgecases in < PHP 5.4.7.
• WP_Image_Editor_Imagick::load()Loads image from $this->file into new Imagick Object.
• WP_REST_Server::serve_batch_request_v1()Serves the batch/v1 request.
• WP_URL_Pattern_Prefixer::get_default_contexts()Returns the default contexts used by the class.
• _load_script_textdomain_from_src()Resolves and loads the translation JSON file for a given script or script module source URL.
• _make_clickable_rel_attr()Helper function used to build the "rel" attribute for a URL when creating an anchor using make_clickable().
• _wp_kses_allow_pdf_objects()Helper function to check if this is a safe PDF URL.
• esc_url()Checks and cleans a URL.

Source

View on Trac ↗View on GitHub ↗

761function wp_parse_url( $url, $component = -1 ) {762	$to_unset = array();763	$url      = (string) $url;764 765	if ( str_starts_with( $url, '//' ) ) {766		$to_unset[] = 'scheme';767		$url        = 'placeholder:' . $url;768	} elseif ( str_starts_with( $url, '/' ) ) {769		$to_unset[] = 'scheme';770		$to_unset[] = 'host';771		$url        = 'placeholder://placeholder' . $url;772	}773 774	$parts = parse_url( $url );775 776	if ( false === $parts ) {777		// Parsing failure.778		return $parts;779	}780 781	// Remove the placeholder values.782	foreach ( $to_unset as $key ) {783		unset( $parts[ $key ] );784	}785 786	return _get_component_from_parsed_url_array( $parts, $component );787}

History

Introduced in 4.4.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.0.4 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.