php8.5
Home/ Manual/ xmlwriter / xmlwriter/ XMLWriter::flush

XMLWriter::flush

PHP function Edit on GitHub ✎

(PHP 5 >= 5.1.2, PHP 7, PHP 8, PECL xmlwriter >= 1.0.0)

Flush current buffer

Description

Oop

XMLWriter::flush(bool $empty = true): string|int

Procedural

xmlwriter_flush(XMLWriter $writer, bool $empty = true): string|int

Flushes the current buffer.

Parameters

empty

Whether to empty the buffer or not. Default is true.

Return Values

If you opened the writer in memory, this function returns the generated XML buffer, Else, if using URI, this function will write the buffer and return the number of written bytes.

Changelog

VersionDescription
8.0.0This function can no longer return false.

Source: reference/xmlwriter/xmlwriter/flush.xml · from the official PHP manual (php/doc-en)