stream_get_line

Function • Params and return types changed in PHP 8.0

Gets line from stream resource up to a given delimiter.

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

stream_get_line Function synopsis

stream_get_line(
    $stream,
    int $length,
    string $ending = ""
  ): string|false

Parameters

$stream

A valid file handle.

$length

Typeint

The maximum number of bytes to read from the handle. Negative values are not supported. Zero (0) means the default socket chunk size, i.e. 8192 bytes.

$ending

OptionalTypestringDefault value""

An optional string delimiter.

Return value

Typestring|false

Returns a string of up to $length bytes read from the file pointed to by $stream, or false on failure.

Changes to the stream_get_line Function

PHP 8.0

  • Return type added: string|false
  • Parameter name of parameter #2 changed: $maxlen to $length
  • Parameter type added for parameter #2 ($length): int
  • Parameter type added for parameter #3 ($ending): string
  • Parameter default value added for position #3 ($ending): ""
  stream_get_line(
      $stream,
-     $maxlen,
+     int $length,
-     $ending
+     string $ending = ""
-   )
+   ): string|false

stream_get_line 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