openssl_pkey_export_to_file

Function • Misc changes in PHP 8.2

Gets an exportable representation of a key into a file.

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_to_file Function synopsis

openssl_pkey_export_to_file(
    $key,
    string $output_filename,
    ?string $passphrase = null,
    ?array $options = null
  ): bool

Parameters

$key
$output_filename

Typestring

Path to the output file.

$passphrase

OptionalType?stringDefault valuenull

The key can be optionally protected by a $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.

Return value

Typebool

Returns true on success, false on failure

Changes to the openssl_pkey_export_to_file Function

PHP 8.2

PHP 8.0

  • Return type added: bool
  • Parameter name of parameter #2 changed: $outfilename to $output_filename
  • Parameter type added for parameter #2 ($output_filename): string
  • 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_to_file(
      $key,
-     $outfilename,
+     string $output_filename,
-     $passphrase,
+     ?string $passphrase = null,
-     $config_args
+     ?array $options = null
-   )
+   ): bool

openssl_pkey_export_to_file 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