rewind()

rewind() — Rewind the position of a file pointer.

Built-in function of PHP 8.5. The manual lists it as available in PHP 4, PHP 5, PHP 7, PHP 8. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.

What it does

Sets the file position indicator for stream to the beginning of the file stream.

Signature

rewind(resource $stream): bool

Parameters

ParameterTypeWhat it takes
$streamresourceThe file pointer must be valid, and must point to a file successfully opened by fopen().

Return value

Returns true on success or false on failure.

Example

A runnable snippet:

$handle = fopen('output.txt', 'r+'); fwrite($handle, 'Really long sentence.'); rewind($handle); fwrite($handle, 'Foo'); rewind($handle); echo fread($handle, filesize('output.txt')); fclose($handle);

Output:

Foolly long sentence.

See also

fread(), fseek(), ftell(), fwrite()

All PHP 8.5 built-in functions

Reference card built from the PHP manual page rewind() (PHP documentation, CC BY 3.0). The page is generated from the manual, so the wording of the parameter and return value text follows php.net.