sha1()

sha1() — Calculate the sha1 hash of a string.

Built-in function of PHP 8.5. The manual lists it as available in PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.

What it does

Calculates the sha1 hash of string using the US Secure Hash Algorithm 1.

Signature

sha1(string $string, bool $binary = false): string

Parameters

ParameterTypeWhat it takes
$stringstringThe input string.
$binaryboolIf the optional binary is set to true, then the sha1 digest is instead returned in raw binary format with a length of 20, otherwise the returned value is a 40-character hexadecimal number.

Return value

Returns the sha1 hash as a string.

Example

A runnable snippet:

$str = 'apple'; if (sha1($str) === 'd0be2dc421be4fcd0172e5afceea3970e2f3d940') { echo "Would you like a green or red apple?"; }

See also

hash(), password_hash()

All PHP 8.5 built-in functions

Reference card built from the PHP manual page sha1() (PHP documentation, CC BY 3.0). The page is generated from the manual, so the wording of the parameter and return value text follows php.net.