iconv_mime_decode_headers

Function • Params and return types changed in PHP 8.0

Decodes multiple MIME header fields at once.

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

iconv_mime_decode_headers Function synopsis

iconv_mime_decode_headers(
    string $headers,
    int $mode = 0,
    ?string $encoding = null
  ): array|false

Parameters

$headers

Typestring

The encoded headers, as a string.

$mode

OptionalTypeintDefault value0

$mode determines the behaviour in the event iconv_mime_decode_headers encounters a malformed MIME header field. You can specify any combination of the following bitmasks.

$mode accepts one of the following constant values:

$encoding

OptionalType?stringDefault valuenull

The optional $encoding parameter specifies the character set to represent the result by. If omitted or null, iconv.internal_encoding will be used.

Return value

Typearray|false

Returns an associative array that holds a whole set of MIME header fields specified by $headers on success, or false if an error occurs during the decoding.

Each key of the return value represents an individual field name and the corresponding element represents a field value. If more than one field of the same name are present, iconv_mime_decode_headers automatically incorporates them into a numerically indexed array in the order of occurrence. Note that header names are not case-insensitive.

Changes to the iconv_mime_decode_headers Function

PHP 8.0

  • Return type added: array|false
  • Parameter type added for parameter #1 ($headers): string
  • Parameter type added for parameter #2 ($mode): int
  • Parameter default value added for position #2 ($mode): 0
  • Parameter name of parameter #3 changed: $charset to $encoding
  • Parameter type added for parameter #3 ($encoding): ?string
  • Parameter default value added for position #3 ($encoding): null
  iconv_mime_decode_headers(
-     $headers,
+     string $headers,
-     $mode,
+     int $mode = 0,
-     $charset
+     ?string $encoding = null
-   )
+   ): array|false

iconv_mime_decode_headers 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