【PHP8.x】prefixプロパティの使い方

prefixプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年11月20日

基本的な使い方

prefixプロパティは、XMLドキュメント内の要素を表すDom\Elementオブジェクトが持つ名前空間接頭辞を保持するプロパティです。Dom\Elementクラスは、XMLツリー内の特定の要素ノードへのアクセスを提供します。XMLでは、要素や属性の名前の衝突を避け、異なる語彙を持つXML文書を組み合わせるために「名前空間」という仕組みが用いられます。この名前空間を識別するために、要素名の前に付けられる短い文字列が「接頭辞（prefix）」です。

たとえば、<ns:element>のような形式のXML要素があった場合、このprefixプロパティは"ns"という文字列を返します。この接頭辞は、XMLドキュメント内で特定のURI（Uniform Resource Identifier）と関連付けられ、その要素がどの名前空間に属するかを示します。もし要素に名前空間接頭辞が指定されていない場合、このプロパティは空の文字列（""）を返します。

このprefixプロパティは読み取り専用であり、直接値を変更することはできません。XMLドキュメントの構造を解析し、特定の名前空間に属する要素を識別したり、フィルタリングしたりする際に非常に役立ちます。システムエンジニアを目指す初心者の方も、XMLデータの処理や解析を行う際には、要素の識別と名前空間の理解に不可欠なこのプロパティを活用できます。

構文(syntax)


1$xmlString = <<<XML
2<?xml version="1.0"?>
3<root xmlns:ns="http://example.com/namespace">
4    <ns:element />
5</root>
6XML;
7
8$doc = new Dom\Document();
9$doc->loadXML($xmlString);
10
11// 'ns:element' タグを持つ要素を取得
12$element = $doc->getElementsByTagName('ns:element')[0];
13
14// Dom\Element::prefix プロパティで要素の名前空間プレフィックスを取得
15echo $element->prefix; // "ns" を出力

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

このプロパティは、要素の名前空間プレフィックスを文字列で返します。