fscanf

FunctionParams and return types changed in PHP 8.0

Parses input from a file according to a format.

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

fscanf Function synopsis

fscanf(
    $stream,
    string $format,
    mixed ...&$vars
  ): array|int|false|null

Parameters

$stream
$format

Typestring

$vars

Variadic, Passed by reference, OptionalTypemixed

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

Return value

Typearray|int|false|null

Changes to the fscanf Function

PHP 8.0

  • Return type added: array|int|false|null
  • Parameter type added for parameter #2 ($format): string
  • Parameter type added for parameter #3 ($vars): mixed
  fscanf(
      $stream,
-     $format,
+     string $format,
-     ...&$vars
+     mixed ...&$vars
-   )
+   ): array|int|false|null

PHP 5.6

  • Parameter name of parameter #3 changed: $... to $vars
  fscanf(
      $stream,
      $format,
-     &$...
+     ...&$vars
    )

fscanf 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