SimpleXMLElement::rewind

(PHP 8)

SimpleXMLElement::rewind — Rewind to the first element

Description

public function SimpleXMLElement::rewind(): void

Warning

Prior to PHP 8.0, SimpleXMLElement::rewind() was only declared on the subclass SimpleXMLIterator.

This method rewinds the SimpleXMLElement to the first element.

Note:
As of PHP 8.4.0, calling get methods (such as SimpleXMLElement::asXML() or SimpleXMLElement::getName()) or casting a SimpleXMLElement to a string no longer implicitly rewinds the iterator. Where required, the iterator must be rewound explicitly by calling this method.

Parameters

This function has no parameters.

Return Values

No value is returned.

Examples

Example #1 Rewind to the first element

<?php
$xmlElement = new SimpleXMLElement('<books><book>PHP Basics</book><book>XML Basics</book></books>');
$xmlElement->rewind();

var_dump($xmlElement->current());
?>

The above example will output:

object(SimpleXMLElement)#2 (1) {
  [0]=>
  string(10) "PHP Basics"
}