Skip to content

[Uid] Document Ulid::isValid() $format argument #21698

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
javiereguiluz merged 1 commit into from
Jan 13, 2026
Merged

[Uid] Document Ulid::isValid() $format argument #21698

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions components/uid.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -550,6 +550,14 @@ ULID objects created with the ``Ulid`` class can use the following methods::
// checking if a given value is valid as ULID
$isValid = Ulid::isValid($ulidValue); // true or false

// validating ULIDs in a specific format
$isValid = Ulid::isValid($ulidValue, Ulid::FORMAT_BASE_32);
$isValid = Ulid::isValid($ulidValue, Ulid::FORMAT_RFC_4122);

By default, ``Ulid::isValid()`` validates ULIDs in the canonical Base32 format.
Use the optional ``$format`` argument to validate ULIDs in other representations,
such as RFC 4122, binary or Base58 formats.

// getting the ULID datetime
$ulid1->getDateTime(); // returns a \DateTimeImmutable instance

Expand Down
Loading