【PHP8.x】SimpleXMLElement::registerXPathNamespace()メソッドの使い方

registerXPathNamespaceメソッドは、XMLドキュメント内でXPath式を使って名前空間付きの要素や属性を操作する際に、名前空間を登録するメソッドです。

XMLにおける名前空間は、異なる語彙を持つ要素が混在する際に、要素名の衝突を避けるために利用されます。たとえば、同じ「title」という名前の要素が、文書のタイトルを表す場合と商品のタイトルを表す場合で意味が異なる際に、それぞれ異なる名前空間を適用することで区別できます。

このメソッドを使用することで、XPathクエリで名前空間が適用された要素や属性を正確に指定し、選択することが可能になります。具体的には、引数として名前空間のプレフィックス（接頭辞）と、そのプレフィックスが示す名前空間URI（識別子）を渡します。SimpleXMLElementオブジェクトに対してこのメソッドを呼び出すと、指定されたプレフィックスとURIの対応関係がそのオブジェクトのコンテキストに設定され、以降のXPathクエリで名前空間を認識して要素を選択できるようになります。

主に、SOAPメッセージやRSSフィード、設定ファイルなど、名前空間が定義された複雑なXML構造から特定のデータを抽出する際に非常に役立ちます。このメソッドで一度名前空間を登録すると、そのSimpleXMLElementインスタンスとその子孫に対して、登録された名前空間が有効になります。名前空間の登録が成功した場合はtrue、失敗した場合はfalseが返されます。

Copy
1<?php
2$simpleXMLElement = new SimpleXMLElement('<root/>');
3$result = $simpleXMLElement->registerXPathNamespace('prefix', 'http://example.com/namespace');

string $prefix, string $namespace

• string $prefix: XPathの名前空間に割り当てる接頭辞を指定する文字列
• string $namespace: 登録するXPathの名前空間URIを指定する文字列

bool

SimpleXMLElement オブジェクトに XPath 名前空間を登録する処理が成功したかどうかを示す真偽値を返します。登録が成功した場合は true を、失敗した場合は false を返します。