Uri\Rfc3986\Uri::getPassword

(PHP 8 >= 8.5.0)

Uri\Rfc3986\Uri::getPassword — Retrieve the normalized password

Description

public function Uri\Rfc3986\Uri::getPassword(): ?string

Retrieves the normalized password part (the text after the first : character) from the userinfo component.

Hexadecimal triplets are converted to uppercase, percent-encoded unreserved characters are decoded, the scheme and host components are normalized to lowercase, and dot segments are removed from the path, per RFC 3986.

Parameters

This function has no parameters.

Return Values

Returns the normalized password as a string if the userinfo component contains a : character. An empty string is returned when the userinfo component doesn't contain a : character. null is returned when the userinfo component doesn't exist.

Examples

Example #1 Uri\Rfc3986\Uri::getPassword() basic example

<?php
$uri = new \Uri\Rfc3986\Uri("https://user:password@example.com");

echo $uri->getPassword();
?>

The above example will output:

password

See Also

+add a note

User Contributed Notes

There are no user contributed notes for this page.