Home/ Manual/ filesystem / functions/ ftruncate

ftruncate

PHP function Edit on GitHub ✎

(PHP 4, PHP 5, PHP 7, PHP 8)

Truncates a file to a given length

Description

ftruncate(resource $stream, int $size): bool

Takes the filepointer, stream, and truncates the file to length, size.

Parameters

stream: The file pointer.
Note
The stream must be open for writing.
size: The size to truncate to.
Note
If size is larger than the file then the file is extended with null bytes.
If size is smaller than the file then the file is truncated to that size.

Return Values

Success

Examples

File truncation example

php

<?php
$filename = 'lorem_ipsum.txt';

$handle = fopen($filename, 'r+');
ftruncate($handle, rand(1, filesize($filename)));
rewind($handle);
echo fread($handle, filesize($filename));
fclose($handle);
?>

Notes

Note

The file pointer is not changed.