readfile

Function • Params and return types changed in PHP 8.0

Outputs a file.

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

readfile Function synopsis

readfile(
    string $filename,
    bool $use_include_path = false,
    $context = null
  ): int|false

Parameters

$filename

Typestring

The filename being read.

$use_include_path

OptionalTypeboolDefault valuefalse

You can use the optional second parameter and set it to true, if you want to search for the file in the include_path too.

$context

OptionalDefault valuenull

Return value

Typeint|false

Returns the number of bytes read from the file on success, or false on failure

Changes to the readfile Function

PHP 8.0

  • Return type added: int|false
  • Parameter type added for parameter #1 ($filename): string
  • Parameter name of parameter #2 changed: $flags to $use_include_path
  • Parameter type added for parameter #2 ($use_include_path): bool
  • Parameter default value added for position #2 ($use_include_path): false
  • Parameter default value added for position #3 ($context): null
  readfile(
-     $filename,
+     string $filename,
-     $flags,
+     bool $use_include_path = false,
-     $context
+     $context = null
-   )
+   ): int|false

readfile 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