openssl_pkey_get_private
Function • Misc changes in PHP 8.2
Get a private key.
openssl_pkey_get_private Function synopsis
openssl_pkey_get_private($private_key, ?string $passphrase = null): OpenSSLAsymmetricKey|falseParameters
$private_key
$private_key can be one of the following:
$passphrase
OptionalType?stringDefault valuenull
The optional parameter $passphrase must be used
if the specified key is encrypted (protected by a passphrase).
Return value
TypeOpenSSLAsymmetricKey|false
Returns an OpenSSLAsymmetricKey instance on success, or false on error.
Changes to the openssl_pkey_get_private Function
PHP 8.2
- Attribute added for parameter
$private_key:#[SensitiveParameter] - Attribute added for parameter
$passphrase:#[SensitiveParameter]
PHP 8.0
- Return type added:
OpenSSLAsymmetricKey|false - Parameter name of parameter #1 changed:
$keyto$private_key - Parameter type added for parameter #2 (
$passphrase):?string - Parameter default value added for position #2 (
$passphrase):null
- openssl_pkey_get_private($key, $passphrase)
+ openssl_pkey_get_private($private_key, ?string $passphrase = null): OpenSSLAsymmetricKey|falseopenssl_pkey_get_private Function Availability
openssl_pkey_get_private Function Availability| PHP Version | Availability |
|---|---|
| PHP 8.6Future Release | Yes |
| PHP 8.5Upcoming Release | Yes |
| PHP 8.4Supported (Latest) | Yes |
| PHP 8.3Supported | Yes |
| PHP 8.2Security-Fixes Only | Yes |
| PHP 8.1Security-Fixes Only | Yes |
| PHP 8.0Unsupported | Yes |
| PHP 7.4Unsupported | Yes |
| PHP 7.3Unsupported | Yes |
| PHP 7.2Unsupported | Yes |
| PHP 7.1Unsupported | Yes |
| PHP 7.0Unsupported | Yes |
| PHP 5.6Unsupported | Yes |
| PHP 5.5Unsupported | Yes |
| PHP 5.4Unsupported | Yes |
| PHP 5.3Unsupported | Yes |