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

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

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

基本的な使い方

localNameプロパティは、Dom\HTMLElementオブジェクトが表す要素のローカル名を保持するプロパティです。このプロパティは、HTMLドキュメントやXMLドキュメント内の特定の要素の名前空間プレフィックスを含まない部分、つまり「ローカル名」を取得するために使用されます。

XMLドキュメントにおいて、要素が名前空間プレフィックスを持つ場合、たとえば<prefix:elementName>という形式の要素では、localNameプロパティはそのプレフィックスを除いた「elementName」の部分を返します。これにより、同じローカル名を持つ要素が異なる名前空間に属していても、共通の識別子として扱うことが可能になります。

一方、HTMLドキュメントでは通常、要素に名前空間プレフィックスがありません。そのため、Dom\HTMLElementオブジェクトが表す<div>や<p>のようなHTML要素の場合、localNameプロパティは要素のタグ名そのもの、つまり「div」や「p」といった値を返します。

このプロパティを使用することで、要素がどの名前空間に属しているかに関わらず、その要素の基本的な名前を統一的に取得できます。特に、複雑なXML構造を解析する際や、HTML要素のタグ名を取得して処理を分岐させる際などに役立ちます。システムエンジニアを目指す初心者の方にとっては、HTML要素のタグ名を取得する基本的な方法の一つとして理解しておくと良いでしょう。

構文(syntax)


1<?php
2
3$dom = new DOMDocument();
4$dom->loadHTML('<html><body><p id="example">テキスト</p></body></html>');
5
6$element = $dom->getElementById('example');
7
8// Dom\HTMLElement::localName プロパティへのアクセス
9echo $element->localName;
10
11?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

このプロパティは、要素のローカル名を文字列として返します。ローカル名とは、名前空間を考慮しない要素のタグ名のことです。

サンプルコード

PHPでHTML要素のタグ名を取得する


1<?php
2
3/**
4 * Dom\HTMLElement::localName プロパティの使用例を示します。
5 * このプロパティは、要素のローカル名（タグ名）を返します。
6 * システムエンジニアを目指す初心者向けに、HTML文字列を解析して要素のタグ名を取得する手順を示します。
7 */
8
9// サンプルとなるHTML文字列を定義します。
10$htmlString = '
11<!DOCTYPE html>
12<html>
13<head>
14    <title>サンプルページ</title>
15</head>
16<body>
17    <h1 id="main-heading">こんにちは、世界！</h1>
18    <p>これはサンプル段落です。</p>
19    <div>
20        <span class="highlight">強調表示されたテキスト</span>
21    </div>
22</body>
23</html>';
24
25// Dom\HTMLDocument クラスのインスタンスを作成します。
26// これにより、HTMLドキュメントをプログラムで操作できるようになります。
27$document = new Dom\HTMLDocument();
28
29// HTML文字列をパース（解析）して、DOMツリー（ドキュメントの構造）を構築します。
30// LIBXML_HTML_NOIMPLIED と LIBXML_HTML_NODEFDTD は、より厳密なパースを可能にしますが、
31// このシンプルな例では必須ではありません。
32$document->loadHTML($htmlString);
33
34// 特定のHTML要素を取得する例：<h1>要素
35// getElementsByTagName() メソッドは、指定されたタグ名を持つすべての要素のリスト（Dom\HTMLCollection）を返します。
36$h1Elements = $document->getElementsByTagName('h1');
37
38// 要素が見つかったかどうかを確認します。
39if ($h1Elements->count() > 0) {
40    // 最初の <h1> 要素を取得します。
41    $h1Element = $h1Elements[0];
42
43    // 取得した要素が Dom\HTMLElement のインスタンスであることを確認します。
44    // Dom\HTMLElement は、ほとんどの標準的なHTML要素を表すクラスです。
45    if ($h1Element instanceof Dom\HTMLElement) {
46        // localName プロパティを使用して、要素のローカル名（タグ名）を取得します。
47        // 例えば <h1> 要素であれば "h1" を返します。
48        $localName = $h1Element->localName;
49
50        echo "最初の <h1> 要素のタグ名 (localName): " . $localName . PHP_EOL; // 出力: h1
51    } else {
52        echo "最初の <h1> 要素は Dom\\HTMLElement のインスタンスではありませんでした。" . PHP_EOL;
53    }
54} else {
55    echo "<h1>要素が見つかりませんでした。" . PHP_EOL;
56}
57
58echo "-------------------------------------" . PHP_EOL;
59
60// 別の例：<span>要素のタグ名を取得
61$spanElements = $document->getElementsByTagName('span');
62
63if ($spanElements->count() > 0) {
64    $spanElement = $spanElements[0];
65
66    if ($spanElement instanceof Dom\HTMLElement) {
67        $localName = $spanElement->localName;
68        echo "最初の <span> 要素のタグ名 (localName): " . $localName . PHP_EOL; // 出力: span
69    } else {
70        echo "最初の <span> 要素は Dom\\HTMLElement のインスタンスではありませんでした。" . PHP_EOL;
71    }
72} else {
73    echo "<span>要素が見つかりませんでした。" . PHP_EOL;
74}
75
76?>

PHPのDom\HTMLElement::localNameプロパティは、HTML要素の「ローカル名」、つまりタグ名を取得するために使用されます。このプロパティは、WebページなどのHTML構造をプログラムで解析し、特定の要素がどのようなタグ（例: h1、p、spanなど）であるかを識別したい場合に非常に役立ちます。

サンプルコードでは、まずHTML文字列を定義し、Dom\HTMLDocumentクラスのインスタンスを作成してそのHTMLを解析しています。これにより、HTMLドキュメントの構造がメモリ上に表現され、プログラムから操作できるようになります。

次に、getElementsByTagName()メソッドを使って、たとえば<h1>要素や<span>要素など、特定のタグ名を持つ要素をHTMLドキュメント内から検索して取得します。このメソッドは、一致する要素のリスト（Dom\HTMLCollection）を返します。

リストから特定の要素（例: 最初の<h1>要素）を取り出した後、その要素がDom\HTMLElementのインスタンスであることを確認します。Dom\HTMLElementは、HTMLの一般的な要素を表す基底クラスです。このインスタンスからlocalNameプロパティにアクセスすると、引数なしで、その要素のタグ名が文字列として直接取得できます。たとえば、<h1>要素であれば"h1"が、<span>要素であれば"span"が戻り値として返されます。これにより、プログラムは各要素のタイプを正確に判別し、その後の処理に利用することができます。

このサンプルコードは、HTML文字列から特定の要素のタグ名を取得する基本的なDOM操作を示しています。まず、Dom\HTMLDocumentクラスを使用してHTMLをパースし、要素ツリーを構築します。getElementsByTagNameメソッドは、指定したタグ名の要素が複数存在しうるため、それらの要素をまとめたコレクション（Dom\HTMLCollection）を返します。そのため、個々の要素にアクセスする際は、配列のようにインデックスを指定する必要があります。

要素が見つからない可能性を考慮し、count()メソッドで要素の有無を確認する習慣をつけましょう。また、取得した要素が必ずしもDom\HTMLElementのインスタンスであるとは限らないため、instanceof演算子で型を確認することは、予期せぬエラーを防ぎ、プログラムの堅牢性を高める上で非常に重要です。localNameプロパティは要素のタグ名を返しますが、XMLなど名前空間を持つドキュメントを扱う際には、nodeNameプロパティとの違いも理解しておくと良いでしょう。実運用では、HTMLのエンコーディングやパースエラーのハンドリングも考慮に入れる必要があります。

PHP 8 Dom\HTMLElement::localNameで要素名を取得する


1<?php
2
3// このサンプルコードは、PHP 8.2 以降の Dom 拡張機能を使用しています。
4// PHP 8.0 または 8.1 では、Dom\HTMLElement クラスは利用できませんのでご注意ください。
5// このファイルをローカルサーバー（例: `php -S localhost:8000` を実行後、ブラウザでアクセス）で実行することで、
6// HTML要素のローカル名を確認できます。
7
8/**
9 * Dom\HTMLElement::localName プロパティの使用方法をデモンストレーションします。
10 * localName プロパティは、XML名前空間プレフィックスを含まない要素のローカル名（タグ名）を返します。
11 * 例えば、`<div id="test">` の `localName` は `"div"` になります。
12 */
13function demonstrateLocalNameProperty(): void
14{
15    // 解析するHTML文字列を定義します。
16    // ここでは、PHPのヒアドキュメント構文を使用して、可読性の高いHTMLを埋め込んでいます。
17    $htmlString = <<<HTML
18    <!DOCTYPE html>
19    <html lang="ja">
20    <head>
21        <title>localName Example</title>
22    </head>
23    <body>
24        <div id="main-content">
25            <p class="intro">これは最初の段落です。</p>
26            <span id="targetElement">これは対象のスパン要素です。</span>
27            <custom:tag>これは名前空間プレフィックス付きのカスタムタグです。</custom:tag>
28        </div>
29    </body>
30    </html>
31    HTML;
32
33    // Dom\Document オブジェクトを作成し、上記のHTML文字列をロードします。
34    // PHP 8.2 以降では、この操作で新しい Dom\ 名前空間のクラスが使用されます。
35    $document = new Dom\Document();
36    $document->loadHTML($htmlString);
37
38    echo "<h1>Dom\\HTMLElement::localName のデモンストレーション</h1>";
39    echo "<p>このPHPコードは、ローカルサーバーで動作することを想定しており、<br>HTML要素のローカル名（プレフィックスを含まないタグ名）を取得する方法を示します。</p>";
40
41    // ID 'targetElement' を持つ要素を取得します。
42    // Dom\Document::getElementById() は Dom\Element オブジェクトを返しますが、
43    // HTML要素の場合、それは Dom\HTMLElement のインスタンスとして扱われます。
44    $element = $document->getElementById('targetElement');
45
46    // 取得した要素が Dom\HTMLElement のインスタンスであることを確認します。
47    if ($element instanceof Dom\HTMLElement) {
48        echo "<h2>ID 'targetElement' の要素:</h2>";
49        // localName プロパティにアクセスして、要素のローカル名を取得し、出力します。
50        echo "<p>要素のローカル名: <strong>" . htmlspecialchars($element->localName) . "</strong></p>";
51        echo "<p>期待される値: <strong>span</strong></p>";
52    } else {
53        echo "<p>エラー: ID 'targetElement' の要素が見つからないか、期待される型ではありませんでした。</p>";
54    }
55
56    echo "<hr>";
57
58    // 名前空間プレフィックスを持つ要素の localName の挙動を確認します。
59    // HTMLでは一般的ではありませんが、XML的な要素の処理を示すために含めています。
60    $customTags = $document->getElementsByTagName('custom:tag');
61    if ($customTags->count() > 0) {
62        $customTag = $customTags->item(0);
63        // ここでも、取得した要素が Dom\HTMLElement のインスタンスであることを確認します。
64        if ($customTag instanceof Dom\HTMLElement) {
65            echo "<h2>名前空間プレフィックスを持つ 'custom:tag' 要素:</h2>";
66            echo "<p>要素のローカル名: <strong>" . htmlspecialchars($customTag->localName) . "</strong></p>";
67            echo "<p>期待される値: <strong>tag</strong> (プレフィックス 'custom:' は除外されます)</p>";
68            // 参考として、nodeName プロパティはプレフィックスを含む完全なノード名を返します。
69            echo "<p>要素のノード名 (nodeName): <strong>" . htmlspecialchars($customTag->nodeName) . "</strong></p>";
70            echo "<p>期待される値: <strong>custom:tag</strong></p>";
71        }
72    } else {
73        echo "<p>エラー: 'custom:tag' 要素が見つかりませんでした。</p>";
74    }
75}
76
77// 上記のデモンストレーション関数を実行します。
78demonstrateLocalNameProperty();
79

PHPのDom\HTMLElement::localNameプロパティは、HTMLやXML文書内の要素が持つ「ローカル名」を取得するために使用されます。このプロパティは引数を取らず、要素のタグ名を文字列として返します。ローカル名とは、XML名前空間のプレフィックスを含まない、純粋な要素のタグ名のことです。例えば、<div id="example">という要素の場合、localNameは「div」という値を返します。

提供されたサンプルコードは、PHP 8.2以降の環境で、php -S localhost:8000のようなコマンドで起動したローカルサーバー上で実行することで動作を確認できます。コードでは、まずHTML文字列をDom\Documentオブジェクトとして読み込み、特定のIDを持つHTML要素を取得しています。取得した要素がDom\HTMLElementのインスタンスであることを確認した後、$element->localNameのようにプロパティにアクセスすることで、その要素のローカル名を取得し、ブラウザ上に表示しています。

特に、<custom:tag>のように名前空間プレフィックスを持つ要素に対してもlocalNameを使用すると、プレフィックスの「custom:」を除いた「tag」の部分のみが返されます。これに対し、nodeNameプロパティは「custom:tag」のようにプレフィックスを含んだ完全な名前を返しますので、両者の違いを理解するとより効果的に利用できます。このプロパティは、HTML要素のタグ名をプログラムで取得し、その種類に応じて処理を分岐させるような場面で非常に役立つでしょう。

このサンプルコードはPHP 8.2以降で動作します。PHP 8.0や8.1ではDom\HTMLElementクラスが利用できませんので、実行環境のPHPバージョンを必ずご確認ください。コードをブラウザで確認できるよう、php -S localhost:8000のようなコマンドでローカルサーバーを起動し、アクセスすることをお勧めします。Dom\HTMLElement::localNameプロパティは、HTML要素やXML要素のタグ名から名前空間プレフィックスを除外したローカル名（例：<div id="test">であれば"div"）を返します。名前空間プレフィックスを含む要素（例：<custom:tag>）の場合でも、localNameはプレフィックスを除いた"tag"を返します。これに対し、nodeNameプロパティはプレフィックスを含む完全なタグ名（"custom:tag"）を返しますので、用途に応じて使い分けてください。要素取得後にinstanceof Dom\HTMLElementで型を確認することは、予期せぬエラーを防ぐための良い習慣です。