PHP | XMLWriter endComment() Function

The XMLWriter::endComment() function is an inbuilt function in PHP which is used to end a comment which is started using XMLWriter::startComment() function.

Syntax:

bool XMLWriter::endComment( void )

Parameters: This function doesn’t accept any parameter.

Return Value: This function returns TRUE on success or FALSE on failure.

Below examples illustrate the XMLWriter::endComment() function in PHP:

Example 1:

<?php

// Create a new XMLWriter instance
$writer = new XMLWriter();

// Create the output stream as PHP
$writer->openURI('php://output');

// Start the document
$writer->startDocument('1.0', 'UTF-8');

// Start a element
$writer->startElement('div');

// Start a comment
$writer->startComment();

// Add text to the comment
$writer->text('This is a comment');

// End the comment
$writer->endComment();

// End the element
$writer->endElement();

// End the document
$writer->endDocument();
?>

Output:

Example 2:

<?php

// Create a new XMLWriter instance
$writer = new XMLWriter();

// Create the output stream as PHP
$writer->openURI('php://output');

// Start the document
$writer->startDocument('1.0', 'UTF-8');

// Start a element
$writer->startElement('div');

// Start a comment
$writer->startComment();

// Add text to the comment
$writer->text('This will not be visible.');

// End the comment
$writer->endComment();

// Add value to the element
$writer->text('GeeksforGeeks');

// End the element
$writer->endElement();

// End the document
$writer->endDocument();
?>

Output:

GeeksforGeeks