PHP | SimpleXMLIterator key() Function

The SimpleXMLIterator::key() function is an inbuilt function in PHP which is used to return the key of current element.

Syntax:

mixed SimpleXMLIterator::key( void )

Parameters: This function does not accept any parameters.

Return Value: This function returns the XML tag name of the element SimpleXMLIterator object on success or FALSE on failure.

Below program illustrates the SimpleXMLIterator::key() function in PHP:

Program:

<?php

// Store the xml element to variable
$xml = <<<XML
    <organization>
        <name>GeeksforGeeks</name>
        <address>Noida India</address>
        <contact>
            <email>abc@geeksforgeeks.org</email>
            <mobile>+91-987654321</mobile>
        </contact>
    </organization>
XML;

$xmlIt = new SimpleXMLIterator($xml);

// Loop starts from first element of xml and
// run upto when elements are not valid
for( $xmlIt->rewind(); $xmlIt->valid(); $xmlIt->next() ) {

    var_dump($xmlIt->key());
}

?>

Output:

string(4) "name"
string(7) "address"
string(7) "contact"

Reference: https://www.php.net/manual/en/simplexmliterator.key.php