parse_url

Parse a URL and return its components.

parse_url Function synopsis

parse_url(string $url, int $component = -1): array|string|int|false|null

Parameters

$url

Typestring

The URL to parse.

$component

OptionalTypeintDefault value-1

Specify one of PHP_URL_SCHEME, PHP_URL_HOST, PHP_URL_PORT, PHP_URL_USER, PHP_URL_PASS, PHP_URL_PATH, PHP_URL_QUERY or PHP_URL_FRAGMENT to retrieve just a specific URL component as a string (except when PHP_URL_PORT is given, in which case the return value will be an int).

$component accepts one of the following constant 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

Return value

Typearray|string|int|false|null

On seriously malformed URLs, parse_url may return false.

If the $component parameter is omitted, an associative array is returned. At least one element will be present within the array. Potential keys within this array are:

If the $component parameter is specified, parse_url returns a string (or an int, in the case of PHP_URL_PORT) instead of an array. If the requested component doesn't exist within the given URL, null will be returned. As of PHP 8.0.0, parse_url distinguishes absent and empty queries and fragments:

Previously all cases resulted in query and fragment being `null`.

Note that control characters (cf. ctype_cntrl) in the components are replaced with underscores (_).