【PHP8.x】DOMElement::localNameプロパティの使い方

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

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

基本的な使い方

localNameプロパティは、DOMElementノードのローカル名を保持するプロパティです。具体的には、XML名前空間を考慮した場合の要素の名称（名前空間プレフィックスを除いた部分）を文字列として取得します。このプロパティは読み取り専用であり、値を変更することはできません。

システムエンジニアを目指す上で、XMLやHTMLなどの構造化されたデータを扱う場面は多くあります。DOM (Document Object Model) は、これらのドキュメントをプログラムから操作するための標準的なインターフェースです。DOMElementは、DOMにおける要素ノードを表すクラスであり、localNameプロパティはその要素ノードの名前を知るために不可欠な情報を提供します。

例えば、<p:book xmlns:p="http://example.com"> という要素があった場合、この要素に対応するDOMElementオブジェクトのlocalNameプロパティは "book" という文字列を返します。名前空間プレフィックス "p:" は含まれません。

このプロパティを利用することで、プログラムはXMLドキュメント内の特定の要素を識別し、その要素に基づいて適切な処理を行うことができます。特に、複数の名前空間が混在する複雑なドキュメントを扱う際には、名前空間プレフィックスに依存せずに要素を特定できるため、localNameプロパティの重要性が際立ちます。DOMを扱う際には、このプロパティの役割を理解しておくことが重要です。

構文(syntax)


1DOMElement::$localName

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

DOMElementオブジェクトのローカル名を表す文字列を返します。これは、要素名の名前空間プレフィックスを除いた部分です。

サンプルコード

PHP DOMElement::localName を取得する


1<?php
2
3/**
4 * DOMElement::localName プロパティの使用例を示します。
5 * このプロパティは、XML/HTML要素の修飾名から名前空間のプレフィックスを除いた「ローカルな名前」を取得します。
6 * システムエンジニアを目指す初心者の方にも、DOM要素の識別子の一つである「ローカル名」の概念を理解できるよう、
7 * 名前空間を持つ要素と持たない要素の両方で動作を検証します。
8 */
9function demonstrateDOMElementLocalName(): void
10{
11    // 新しいDOMDocumentを作成
12    $dom = new DOMDocument('1.0', 'UTF-8');
13    $dom->formatOutput = true; // 出力を見やすく整形
14
15    // ルート要素を作成
16    $root = $dom->createElement('root');
17    $dom->appendChild($root);
18
19    // 1. 名前空間とプレフィックスを持つ要素を作成
20    // 'pref:item' の 'pref' は名前空間プレフィックス、'item' がローカル名です。
21    $namespaceUri = 'http://www.example.com/ns';
22    $prefixedElement = $dom->createElementNS($namespaceUri, 'pref:item', 'この要素にはプレフィックスがあります。');
23    $root->appendChild($prefixedElement);
24
25    // 2. 名前空間を持つがプレフィックスを持たない要素を作成
26    // この場合、ローカル名が要素名そのものになります。
27    $unprefixedNsElement = $dom->createElementNS($namespaceUri, 'data', 'この要素にはプレフィックスがありません。');
28    $root->appendChild($unprefixedNsElement);
29
30    // 3. 名前空間を全く持たない通常の要素を作成
31    // この場合も、ローカル名が要素名そのものになります。
32    $simpleElement = $dom->createElement('tag', 'この要素には名前空間がありません。');
33    $root->appendChild($simpleElement);
34
35    echo "--- DOM 構造の出力 ---\n";
36    echo $dom->saveXML() . "\n";
37    echo "----------------------\n\n";
38
39    echo "--- DOMElement::localName の取得結果 ---\n";
40
41    // 各要素の localName を取得して表示
42    // 1. プレフィックス付き要素の localName
43    //    'pref:item' から 'item' を取得
44    echo "要素 '" . $prefixedElement->nodeName . "' の localName: '" . $prefixedElement->localName . "'\n";
45
46    // 2. プレフィックスなし名前空間要素の localName
47    //    'data' から 'data' を取得
48    echo "要素 '" . $unprefixedNsElement->nodeName . "' の localName: '" . $unprefixedNsElement->localName . "'\n";
49
50    // 3. 通常要素の localName
51    //    'tag' から 'tag' を取得
52    echo "要素 '" . $simpleElement->nodeName . "' の localName: '" . $simpleElement->localName . "'\n";
53    echo "----------------------------------------\n";
54}
55
56// 関数を実行してDOMElement::localNameの動作を確認
57demonstrateDOMElementLocalName();

PHP 8で利用可能なDOMElement::localNameプロパティは、XMLやHTML文書をプログラムで操作するDOM（Document Object Model）において、要素の「ローカルな名前」を取得するために使用されます。このプロパティは、要素の修飾名から名前空間のプレフィックス（接頭辞）を除いた、純粋な要素名を文字列として返します。引数は不要で、常に文字列型の戻り値が得られます。

具体的には、<pref:item>のようにプレフィックスを持つ要素に対しては、プレフィックス部分のprefを除いたitemがlocalNameとして取得されます。一方、<data>のように名前空間は持つもののプレフィックスがない要素や、<tag>のように名前空間を全く持たない通常の要素の場合、要素名そのものであるdataやtagがlocalNameとして返されます。

システムエンジニアを目指す初心者の方にとって、このプロパティはXMLなどで名前空間が使われている場合に特に役立ちます。要素を識別したり、その種類によって処理を分けたりする際に、プレフィックスの有無に左右されず、要素が本来持っている名前で扱うことが可能になります。これにより、より汎用的で理解しやすいコードを作成できるようになります。

DOMElement::localNameは、XML要素の名前から名前空間プレフィックスを除いた「ローカルな名前」を取得するために使われます。初心者の方は、要素の完全な名前を示すnodeNameと混同しやすいので注意が必要です。特に名前空間を持たない要素や、名前空間を持っていてもプレフィックスがない要素の場合、localNameとnodeNameは同じ値を返します。このプロパティは、XMLを名前空間を意識して処理する際に、要素を正しく識別するために重要です。プレフィックスは表示上の区別であり、要素をコードで扱う際はlocalNameとnamespaceURIを組み合わせて利用するのが一般的です。取得される値は文字列として安全に扱えます。

DOMElement::localNameで要素名を取得する


1<?php
2
3/**
4 * DOMElement::localName プロパティの使用例を示します。
5 * 要素のローカル名（名前空間接頭辞を含まない名前）を取得する方法をデモンストレーションします。
6 *
7 * このスクリプトは、PHPがインストールされたローカル環境で実行可能です。
8 * 例：コマンドラインで `php your_script_name.php` として実行、
9 * またはWebサーバー（Apache, Nginxなど）でPHPを動作させてブラウザからアクセス。
10 */
11function demonstrateDomLocalName(): void
12{
13    echo "--- DOMElement::localName のデモンストレーション ---\n\n";
14
15    // 1. シンプルなHTML文字列からのlocalName取得
16    // HTMLでは通常、localNameはnodeNameと同じになります。
17    $htmlString = '<html><body><p id="intro">これは導入の段落です。</p></body></html>';
18    $domHtml = new DOMDocument();
19    // HTMLとしてパースし、エラーを抑制 (@)
20    @$domHtml->loadHTML($htmlString);
21
22    // ID 'intro' を持つ <p> 要素を取得
23    $paragraphElement = $domHtml->getElementById('intro');
24
25    if ($paragraphElement instanceof DOMElement) {
26        echo "HTML要素 (<p id=\"intro\">):\n";
27        echo "  - nodeName: " . $paragraphElement->nodeName . "\n";
28        echo "  - localName: " . $paragraphElement->localName . "\n\n";
29    }
30
31    // 2. 名前空間を持つXML文字列からのlocalName取得
32    // XMLでは、名前空間接頭辞が付いている場合、localNameはnodeNameと異なります。
33    $xmlString = <<<XML
34    <my:bookstore xmlns:my="http://example.com/books">
35        <my:book>
36            <my:title>PHPプログラミング</my:title>
37            <author>山田太郎</author>
38        </my:book>
39    </my:bookstore>
40    XML;
41
42    $domXml = new DOMDocument();
43    // XMLとしてパースし、エラーを抑制 (@)
44    @$domXml->loadXML($xmlString);
45
46    // 名前空間URIとローカル名で <my:title> 要素を取得
47    $titleElements = $domXml->getElementsByTagNameNS('http://example.com/books', 'title');
48
49    if ($titleElements->length > 0) {
50        $titleElement = $titleElements->item(0);
51        if ($titleElement instanceof DOMElement) {
52            echo "XML要素 (<my:title>):\n";
53            echo "  - nodeName: " . $titleElement->nodeName . "\n";     // 接頭辞を含む完全な名前
54            echo "  - localName: " . $titleElement->localName . "\n";   // 名前空間接頭辞を除いた名前
55            echo "  - namespaceURI: " . $titleElement->namespaceURI . "\n\n"; // 名前空間のURI
56        }
57    }
58}
59
60// 関数を実行
61demonstrateDomLocalName();

PHPのDOMElement::localNameプロパティは、XMLやHTMLドキュメント内の要素が持つ名前空間接頭辞を含まない「ローカル名」を取得するために使用されます。このプロパティは引数を取らず、要素のローカル名を文字列として返します。

要素の完全な名前を返すnodeNameプロパティと比較すると、その違いが明確になります。例えば、HTMLドキュメント内の<p>タグのように名前空間を持たない要素の場合、localNameもnodeNameもどちらも「p」という同じ値を返します。しかし、名前空間が定義されたXMLドキュメントで<my:title>のような要素がある場合、nodeNameは「my:title」を返しますが、localNameは名前空間接頭辞である「my:」を取り除いた純粋な名前である「title」を返します。これにより、開発者は要素の特定の属性や内容を名前空間に依存せずに識別し、処理することができます。

このサンプルコードでは、DOMDocumentクラスを用いてHTML文字列と名前空間を持つXML文字列をそれぞれパース（解析）しています。まず、シンプルなHTMLから<p>要素のlocalNameを取得し、その結果がnodeNameと同じになることを示します。次に、名前空間を持つXMLから<my:title>要素を取得し、localNameが「title」を、nodeNameが「my:title」を返す違いを具体的にデモンストレーションしています。

このスクリプトは、PHPがインストールされたローカル環境で、コマンドラインやWebサーバー経由で簡単に実行し、動作を確認できます。

DOMElement::localNameは、特にXMLドキュメントで名前空間を持つ要素から、名前空間接頭辞を含まない純粋な要素名を取得する際に利用します。HTML要素では通常、nodeNameと同じ値になります。サンプルコードの@演算子はエラーを抑制しますが、実際の開発ではエラー発生時に問題特定が困難になるため、エラーハンドリングを適切に実装することが推奨されます。このスクリプトは、PHPがインストールされ、DOM拡張が有効なローカル環境（Webサーバーやコマンドライン）で実行可能です。取得した要素が期待通りDOMElementであることをinstanceofで確認する習慣は、安全なプログラミングにおいて重要です。