stream_copy_to_stream

Function • Params changed in PHP 8.6

Copies data from one stream to another.

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
Improved

stream_copy_to_stream Function synopsis

stream_copy_to_stream(
    $from,
    $to,
    ?int $length = null,
    int $offset = 0,
    $context = null
  ): int|false

Parameters

$from

The source stream

$to

The destination stream

$length

OptionalType?intDefault valuenull

Maximum bytes to copy. By default all bytes left are copied.

$offset

OptionalTypeintDefault value0

The offset where to start to copy data

$context

OptionalDefault valuenull

Return value

Typeint|false

Returns the total count of bytes copied, or false on failure.

Changes to the stream_copy_to_stream Function

PHP 8.6

  • Optional parameter added - #5: $context = null
 stream_copy_to_stream(
     $from,
     $to,
     ?int $length = null,
-    int $offset = 0
+    int $offset = 0,
+    $context = null
   ): int|false

PHP 8.0

  • Return type added: int|false
  • Parameter name of parameter #1 changed: $source to $from
  • Parameter name of parameter #2 changed: $dest to $to
  • Parameter name of parameter #3 changed: $maxlen to $length
  • Parameter type added for parameter #3 ($length): ?int
  • Parameter default value added for position #3 ($length): null
  • Parameter name of parameter #4 changed: $pos to $offset
  • Parameter type added for parameter #4 ($offset): int
  • Parameter default value added for position #4 ($offset): 0
  stream_copy_to_stream(
-     $source,
+     $from,
-     $dest,
+     $to,
-     $maxlen,
+     ?int $length = null,
-     $pos
+     int $offset = 0
-   )
+   ): int|false

stream_copy_to_stream 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