SimpleXMLElement::key

(No version information available, might only be in Git)

SimpleXMLElement::key現在のキーを返す

説明

public SimpleXMLElement::key(): string
警告

PHP 8.0 より前のバージョンでは、 SimpleXMLElement::key() はサブクラスの SimpleXMLIterator でのみ宣言されていました。

このメソッドは、現在の要素の XML タグ名を取得します。

パラメータ

この関数にはパラメータはありません。

戻り値

現在の SimpleXMLElement オブジェクトが参照する要素の XML タグ名を返します。

エラー / 例外

失敗した場合にError をスローします。

変更履歴

バージョン 説明
8.1.0 SimpleXMLElement::key() を不正なイテレータを渡してコールすると、 Error をスローするようになりました。 これより前のバージョンでは、false を返していました。

例1 現在の XML タグキーの取得

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

echo
var_dump($xmlElement->key());
$xmlElement->rewind(); // 最初の要素に巻き戻します
echo var_dump($xmlElement->key());

?>

上の例の出力は以下となります。

bool(false)
string(4) "book"

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top