Uri\Rfc3986\Uri::getUsername

(PHP 8 >= 8.5.0)

Uri\Rfc3986\Uri::getUsername — Retrieve the normalized username

Description

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

Retrieves the normalized username part (the text before 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 username as a string if the userinfo component exists, null is returned otherwise.

Examples

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

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

echo $uri->getUsername();
?>

The above example will output:

user

See Also

+add a note

User Contributed Notes

There are no user contributed notes for this page.