openssl_pkey_export

Function • Misc changes in PHP 8.2

Gets an exportable representation of a key into a string.

PHP 5
PHP 7
PHP 8.0
Improved
PHP 8.1
PHP 8.2
Changed
PHP 8.3
PHP 8.4
PHP 8.5
PHP 8.6

openssl_pkey_export Function synopsis

openssl_pkey_export(
    $key,
    &$output,
    ?string $passphrase = null,
    ?array $options = null
  ): bool

Parameters

$key
$output

Passed by reference

$passphrase

OptionalType?stringDefault valuenull

The key is optionally protected by $passphrase.

$options

OptionalType?arrayDefault valuenull

$options can be used to fine-tune the export process by specifying and/or overriding options for the openssl configuration file. See openssl_csr_new for more information about $options.

Note that the parameter $output is passed by reference, and contains additional/updated context data that may be useful.

Return value

Typebool

Returns true on success, false on failure

Changes to the openssl_pkey_export Function

PHP 8.2

PHP 8.0

  • Return type added: bool
  • Parameter name of parameter #2 changed: $out to $output
  • Parameter type added for parameter #3 ($passphrase): ?string
  • Parameter default value added for position #3 ($passphrase): null
  • Parameter name of parameter #4 changed: $config_args to $options
  • Parameter type added for parameter #4 ($options): ?array
  • Parameter default value added for position #4 ($options): null
  openssl_pkey_export(
      $key,
-     &$out,
+     &$output,
-     $passphrase,
+     ?string $passphrase = null,
-     $config_args
+     ?array $options = null
-   )
+   ): bool

openssl_pkey_export Function Availability

PHP VersionAvailability
PHP 8.6Upcoming Release Yes
PHP 8.5Supported (Latest) Yes
PHP 8.4Supported Yes
PHP 8.3Security-Fixes Only Yes
PHP 8.2Security-Fixes Only Yes
PHP 8.1Unsupported 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