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

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

作成日: 2025年09月11日更新日: 2025年10月28日

基本的な使い方

localNameプロパティは、XMLやHTMLのノードにおける、名前空間プレフィックスを除いたローカル名を保持するプロパティです。XMLでは、要素名や属性名に名前空間プレフィックスを付けて名前の衝突を避けることがあります。例えば、<ns:item>という要素がある場合、nodeNameプロパティはプレフィックスを含むns:itemという文字列を返します。これに対して、localNameプロパティはプレフィックス部分であるns:を除いたitemという部分、すなわちローカル名のみを返します。この機能により、開発者は名前空間を意識することなく、要素自体の名前を取得して処理を記述できます。もし対象のノードに名前空間プレフィックスが存在しない場合、localNameはnodeNameプロパティと同じ値を返します。また、このプロパティは読み取り専用であり、値を直接変更することはできません。要素や属性以外の、例えばテキストノードやコメントノードのように名前を持たないノードに対してこのプロパティにアクセスした場合、値としてnullが返されます。

構文(syntax)


1<?php
2$xmlString = '<prefix:book>Sample Book</prefix:book>';
3
4$dom = new DOMDocument();
5$dom->loadXML($xmlString);
6
7$node = $dom->documentElement;
8
9// ノードのローカル名 (接頭辞を除いた名前) を取得します。
10$localName = $node->localName;
11
12echo $localName;
13?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string|null

DOMNode オブジェクトのローカル名を表す文字列、または要素に名前空間が指定されていない場合は null を返します。

サンプルコード

PHP DOM: XML要素のローカル名を表示する


1<?php
2
3/**
4 * 指定されたXML文字列をパースし、各要素のローカル名を表示します。
5 *
6 * DOMNode::localName は、XML要素の名前空間プレフィックスを除いた名前を返します。
7 * これは、名前空間内で一意となる「ローカルな識別子」と考えることができます。
8 *
9 * ここでは、キーワード「local_addr (ローカルアドレス)」の「ローカル」という概念を、
10 * XMLの名前空間における「特定の名前空間内でのローカルな識別子」として関連付けています。
11 *
12 * @param string $xmlString パースするXML文字列
13 * @return void
14 */
15function displayNodeLocalNames(string $xmlString): void
16{
17    // DOMDocumentオブジェクトを作成し、XMLを読み込みます。
18    $dom = new DOMDocument();
19    // XMLパース時の警告を抑制し、内部エラーとして扱います。
20    // 初心者向けにはエラーハンドリングを示す良い機会にもなります。
21    libxml_use_internal_errors(true);
22    if (!$dom->loadXML($xmlString)) {
23        echo "エラー: XMLのパースに失敗しました。\n";
24        foreach (libxml_get_errors() as $error) {
25            echo " - " . trim($error->message) . "\n";
26        }
27        libxml_clear_errors(); // 処理したエラーをクリアします。
28        return;
29    }
30    libxml_use_internal_errors(false); // エラー設定を元に戻します。
31
32    echo "DOM要素のローカル名を表示します:\n";
33
34    // DOMXPathオブジェクトを使用して、XMLツリー内の全ての要素ノードを選択します。
35    $xpath = new DOMXPath($dom);
36    $elements = $xpath->query('//*'); // '//*' は全ての要素ノードを意味します。
37
38    foreach ($elements as $element) {
39        /* @var DOMElement $element */
40        // ノードの完全な名前 (nodeName) と、名前空間プレフィックスを除いたローカル名 (localName) を表示します。
41        // localNameは名前空間を持たない要素の場合、nodeNameと同じになります。
42        // namespaceURIも表示することで、名前空間の有無を明確にします。
43        echo " - ノード名 (nodeName): " . $element->nodeName;
44        echo ", ローカル名 (localName): " . ($element->localName ?? 'null'); // localNameはnullを返す可能性があります。
45        echo ", 名前空間URI (namespaceURI): " . ($element->namespaceURI ?? 'なし') . "\n";
46    }
47}
48
49// サンプルXMLデータ
50// 名前空間プレフィックスを持つ要素 (app:item, app:setting) と、
51// 名前空間を持たない要素 (title, description, timeout, rootElement, noNamespaceNode) を含めます。
52// これにより、localName の挙動の違いが明確になります。
53$sampleXml = <<<XML
54<?xml version="1.0" encoding="UTF-8"?>
55<root xmlns:app="http://example.com/app-data">
56    <app:item id="1">
57        <title>PHPの基本</title>
58        <description>PHPプログラミングの入門</description>
59    </app:item>
60    <app:item id="2">
61        <title>DOMNode::localName リファレンス</title>
62        <description>localNameプロパティの詳細</description>
63    </app:item>
64    <app:setting>
65        <timeout>60</timeout>
66    </app:setting>
67    <rootElement>
68        <noNamespaceNode>このノードは名前空間を持ちません。</noNamespaceNode>
69    </rootElement>
70</root>
71XML;
72
73// 定義した関数を呼び出し、サンプルXMLを使って実行します。
74displayNodeLocalNames($sampleXml);
75
76?>

このPHPサンプルコードは、XMLドキュメント内の各要素から「ローカル名」を取得する方法を示しています。DOMNode::localNameプロパティは、XML要素の名前空間プレフィックスを除いた名前を文字列として返します。これは、提供されたキーワード「local_addr (ローカルアドレス)」の「ローカル」という概念と同様に、XMLの名前空間における特定のスコープ内で識別される「ローカルな識別子」と理解することができます。例えば、<app:item>のような名前空間プレフィックスを持つ要素の場合、localNameは「item」を返します。このプロパティに引数は不要で、戻り値は文字列(string)、または名前空間を持たない要素やXML要素ではないノードの場合にnullを返します。

サンプルコードでは、まず指定されたXML文字列をDOMDocumentで読み込み、パースエラーの処理も示しています。その後、DOMXPathを使ってXMLツリー内のすべての要素ノードを選択し、それぞれの要素についてnodeName（完全なノード名）、localName、そしてnamespaceURIを表示しています。これにより、名前空間の有無やプレフィックスの有無によってlocalNameがどのように振る舞うかを具体的に確認できます。このlocalNameプロパティは、XMLドキュメントの構造を解析し、名前空間に依存せずに特定の要素を識別したい場合に非常に役立つ機能です。

DOMNode::localNameは、XML要素の名前空間プレフィックスを除いた名前を取得します。これは、キーワード「local_addr」の「ローカル」が示すように、特定の名前空間内での識別子と考えると理解しやすいでしょう。名前空間を持たない要素ではnodeNameプロパティと同じ値を返しますが、名前空間を持つ要素と持たない要素で結果が異なる点を理解することが重要です。リファレンスではnullを返す可能性があると示されていますが、DOMElementに対してアクセスする場合は常に文字列を返します。このサンプルコードでは、libxml_use_internal_errors関数を使ったXMLパース時のエラーハンドリングが実装されています。実運用では、不正なXMLに備えてこのようなエラー処理を必ず組み込むようにしてください。これにより、プログラムの安定性が向上し、問題発生時の原因特定が容易になります。

PHP DOMNode::localNameで要素名を取得する


1<?php
2
3/**
4 * DOMNode::localName プロパティの使用例を示す関数。
5 *
6 * この関数は、HTMLコンテンツをDOMDocumentで解析し、
7 * 各要素のローカル名（名前空間プレフィックスを除いた名前）を出力します。
8 * PHPの組み込みウェブサーバーやApache/Nginxなどのローカルサーバー上で
9 * このスクリプトを実行し、ブラウザでアクセスすることを想定した
10 * ウェブコンテンツ処理のシナリオです。
11 */
12function demonstrateDomLocalName(): void
13{
14    // 解析するHTMLコンテンツを定義します。
15    // これは、ローカルサーバー経由でブラウザに表示される一般的なウェブページのコンテンツを模しています。
16    $htmlContent = <<<HTML
17    <!DOCTYPE html>
18    <html lang="en">
19    <head>
20        <meta charset="UTF-8">
21        <title>DOM localName Example</title>
22    </head>
23    <body>
24        <div id="main-content">
25            <h1>DOMNode::localNameのデモンストレーション</h1>
26            <p>これは最初の段落です。</p>
27            <p>これは二番目の段落です。</p>
28            <a href="https://example.com">リンクの例</a>
29        </div>
30        <!-- 名前空間の例としてSVG要素を含めます -->
31        <svg xmlns="http://www.w3.org/2000/svg" width="100" height="100">
32            <circle cx="50" cy="50" r="40" stroke="black" stroke-width="3" fill="blue" />
33        </svg>
34    </body>
35    </html>
36    HTML;
37
38    // 新しいDOMDocumentオブジェクトを作成します。
39    $dom = new DOMDocument();
40
41    // HTMLのパース時に発生する警告やエラーを非表示にします。
42    // これにより、不完全なHTMLでもスクリプトが停止することなく処理を続けられます。
43    libxml_use_internal_errors(true);
44
45    // 定義したHTML文字列をDOMDocumentにロードします。
46    // この操作は、ウェブスクレイピングやコンテンツ処理で頻繁に行われます。
47    $dom->loadHTML($htmlContent);
48
49    // libxml_use_internal_errors(true)を設定した場合、処理後にエラーをクリアすることが推奨されます。
50    libxml_clear_errors();
51
52    echo "--- DOMNode::localName プロパティの使用例 ---\n\n";
53
54    // <body>要素を取得し、そのローカル名を出力します。
55    // HTML要素の場合、ローカル名は通常そのタグ名と同じです。
56    $bodyElements = $dom->getElementsByTagName('body');
57    if ($bodyElements->length > 0) {
58        $bodyNode = $bodyElements->item(0);
59        echo "<body>要素の localName: " . $bodyNode->localName . "\n"; // 出力: body
60    }
61
62    // 最初の<p>要素を取得し、そのローカル名を出力します。
63    $pElements = $dom->getElementsByTagName('p');
64    if ($pElements->length > 0) {
65        $pNode = $pElements->item(0);
66        echo "<p>要素の localName: " . $pNode->localName . "\n"; // 出力: p
67    }
68
69    // <a>要素を取得し、そのローカル名を出力します。
70    $aElements = $dom->getElementsByTagName('a');
71    if ($aElements->length > 0) {
72        $aNode = $aElements->item(0);
73        echo "<a>要素の localName: " . $aNode->localName . "\n"; // 出力: a
74    }
75
76    // SVG要素内の<circle>要素を取得し、そのローカル名を出力します。
77    // SVGはXMLの名前空間を使用するため、localNameの概念がより重要になります。
78    // 例：<svg:circle>のような要素が存在した場合でも、localNameは 'circle' となります。
79    $circleElements = $dom->getElementsByTagName('circle');
80    if ($circleElements->length > 0) {
81        $circleNode = $circleElements->item(0);
82        echo "<circle>要素の localName: " . $circleNode->localName . "\n"; // 出力: circle
83    }
84
85    echo "\n補足:\n";
86    echo "- localName は、XML名前空間プレフィックスを含まないノード名を返します。\n";
87    echo "- HTML要素の場合、通常はタグ名がそのままローカル名となります。\n";
88    echo "- XML名前空間が使用されている場合 (例: <ns:element>)、DOMNode::nodeName は 'ns:element' を返すことがありますが、localName は 'element' を返します。\n";
89}
90
91// 関数を実行して、DOMNode::localName のデモンストレーションを開始します。
92demonstrateDomLocalName();

PHPのDOMNode::localNameプロパティは、HTMLやXML文書内の各要素（ノード）の「ローカル名」を取得するために使用されます。これは、名前空間プレフィックスを含まない、純粋な要素名です。このプロパティは引数を取らず、ノードのローカル名を表す文字列を返しますが、該当するノードが存在しない場合などはnullを返す可能性があります。

サンプルコードでは、まずHTMLコンテンツを文字列として定義し、それをDOMDocumentクラスを使って解析しています。ウェブサーバー環境でのHTML処理を想定しており、$dom->loadHTML()でHTMLを読み込んだ後、getElementsByTagName()メソッドで特定のタグ名の要素を取得しています。

例えば、<body>、<p>、<a>といったHTML要素に対してlocalNameプロパティにアクセスすると、それぞれ"body"、"p"、"a"というタグ名そのものが返されます。これは、HTML要素には通常名前空間プレフィックスがないためです。また、SVG要素内の<circle>要素のようにXML名前空間が使われる場合でも、localNameは"circle"と、プレフィックスを含まない名前を正確に返します。これにより、複雑なXML構造から目的の要素名を効率的に抽出できます。

localNameは、HTMLやXMLの要素名から名前空間のプレフィックスを除いた名前を取得します。HTML要素では通常タグ名そのままですが、SVGなどの名前空間を持つXML要素を扱う際に、修飾名であるnodeNameと区別して要素の純粋な名前を得るために特に有用です。

HTMLの解析時に、DOMDocument::loadHTMLは不完全なHTMLに対して警告を出すことがあります。これを避けるため、libxml_use_internal_errors(true)で一時的に警告を抑制し、処理の後にlibxml_clear_errors()でエラー状態をクリアすると、スクリプトが安定して動作します。

また、getElementsByTagNameなどのメソッドは、該当する要素のリスト（DOMNodeList）を返します。目的の要素が存在しない場合も考慮し、必ずlengthプロパティで要素数をチェックしてからitem(0)でアクセスするようにしてください。これにより、プログラムの予期せぬエラーを防ぐことができます。