SplFileObject::fwrite

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

SplFileObject::fwriteWrite to file

Description

public SplFileObject::fwrite(string $data, int $length = 0): int|false

Writes the contents of string to the file

Parameters

data

The string to be written to the file.

length

If the length argument is given, writing will stop after length bytes have been written or the end of string is reached, whichever comes first.

Return Values

Returns the number of bytes written, or false on error.

Changelog

Version Description
7.4.0 The function now returns false instead of zero on failure.

Examples

Example #1 SplFileObject::fwrite() example

<?php
$file
= new SplFileObject("fwrite.txt", "w");
$written = $file->fwrite("12345");
echo
"Wrote $written bytes to file";
?>

The above example will output something similar to:

Wrote 5 bytes to file

See Also

add a note add a note

User Contributed Notes 1 note

up
7
bas dot hilbers at tribal-im dot com
11 years ago
Your \SplFileObject will not throw an exception when trying to write to a non-writeable stream!

I forgot to set the second parameter on my \SplFileObject constructor (the mode), costing me minutes to figure out why nothing was writter by the fwrite method...

Just to let you know!
To Top