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

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

作成日: 2025年09月11日更新日: 2025年12月02日

基本的な使い方

localNameプロパティは、DOMDocumentTypeクラスに属し、文書型宣言で指定されたルート要素の名前（ローカル名）を保持するプロパティです。PHPのDOM拡張機能は、XMLやHTMLドキュメントをオブジェクトとして扱い、その構造にプログラムからアクセス・操作することを可能にします。DOMDocumentTypeクラスは、これらのドキュメントの先頭にある文書型宣言（<!DOCTYPE ...>）に関する情報をカプセル化しています。

このlocalNameプロパティは、特にXMLドキュメントにおいて重要な概念である「名前空間」を考慮した上で、その要素のプレフィックス部分を除いた純粋な名前（ローカル名）を提供します。DOMDocumentTypeのコンテキストでは、文書型宣言によって定義されるドキュメントのルート要素のローカル名を文字列として取得できます。例えば、<!DOCTYPE html>という宣言があるHTMLドキュメントでは、このプロパティは"html"という値を返します。また、<!DOCTYPE mydocument SYSTEM "document.dtd">のようなXMLドキュメントでは、"mydocument"という値を返します。

システムエンジニアを目指す初心者の方にとって、localNameはドキュメントの型や構造をプログラム的に識別し、それに応じた処理を行う際に役立ちます。文書のルート要素名を正確に把握することで、特定のDTDに準拠しているかどうかの確認や、ドキュメントの特性に基づいた処理の分岐などを実現できます。このプロパティは読み取り専用であり、その値を変更することはできません。

構文(syntax)


1<?php
2$dom = new DOMDocument();
3$dom->loadHTML('<!DOCTYPE html><html lang="en"><body><h1>Hello</h1></body></html>');
4$documentType = $dom->doctype;
5$localName = $documentType->localName;
6?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

?string

DOMDocumentType クラスの localName プロパティは、このノードのローカル名を表す文字列、または名前空間プレフィックスがない場合は null を返します。

サンプルコード

PHP DOMDocumentTypeのlocalNameを確認する


1<?php
2
3/**
4 * DOMDocumentType の localName プロパティの使用例を示します。
5 *
6 * localName プロパティは、ノードのローカル名（名前空間接頭辞を含まない名前）を返します。
7 * DOMDocumentType ノードの場合、通常は null を返します。
8 * これは、DocumentType ノード自体が XML/HTML 要素ではないためです。
9 * キーワード "php local_addr" の「ローカル」という概念を、DOMノードの「ローカルな名前」として関連付けます。
10 */
11function demonstrateDomDocumentTypeLocalName(): void
12{
13    // 新しい DOMDocument オブジェクトを作成
14    $dom = new DOMDocument();
15
16    // シンプルな HTML ドキュメントをロード
17    // <!DOCTYPE html> は DocumentType ノードとしてパースされます。
18    $dom->loadHTML('<!DOCTYPE html><html><head><title>Test</title></head><body><h1>Hello</h1></body></html>');
19
20    // ドキュメントタイプノード (DOMDocumentType) を取得します。
21    // これはドキュメントの <!DOCTYPE ...> 部分を表します。
22    $docType = $dom->doctype;
23
24    if ($docType instanceof DOMDocumentType) {
25        // DOMDocumentType の nodeName プロパティを取得します。
26        // 通常、これは DOCTYPE 宣言で指定された名前（例: "html"）を返します。
27        $nodeName = $docType->nodeName;
28
29        // DOMDocumentType の localName プロパティを取得します。
30        // DocumentType ノードは XML/HTML 要素ではないため、名前空間接頭辞を持たず、
31        // このプロパティは常に null を返します。
32        $localName = $docType->localName;
33
34        echo "DOMDocumentType の情報:\n";
35        echo "  - nodeName: " . ($nodeName ?? 'null') . "\n";
36        echo "  - localName: " . ($localName ?? 'null') . "\n";
37        echo "\n";
38        echo "補足:\n";
39        echo "  DOMDocumentType ノードは要素ではないため、名前空間接頭辞（プレフィックス）を持たず、\n";
40        echo "  localName プロパティは常に null を返します。\n";
41        echo "  localName は主に名前空間を持つ要素（DOMElement）に対して有効なプロパティです。\n";
42    } else {
43        echo "DOMDocumentType ノードが見つかりませんでした。HTMLにDOCTYPE宣言が含まれているか確認してください。\n";
44    }
45}
46
47// 関数を実行してサンプルコードの動作を確認します。
48demonstrateDomDocumentTypeLocalName();

PHPのDOMDocumentType::localNameプロパティは、DOMノードのローカル名、つまり名前空間接頭辞（プレフィックス）を含まない名前を取得するものです。このプロパティは引数を取らず、戻り値として文字列またはnullを返します。?stringという戻り値型は、文字列であるか、値が存在しない場合にnullを返すことを意味しています。

DOMDocumentTypeクラスは、HTMLやXMLドキュメントの<!DOCTYPE ...>宣言を表します。この宣言は、一般的なXML/HTMLの要素とは性質が異なり、通常は名前空間を持ちません。そのため、DOMDocumentTypeノードのlocalNameプロパティは常にnullを返します。これは、ローカルな名前そのものが存在しないためです。

サンプルコードでは、まず<!DOCTYPE html>を含むHTMLドキュメントを読み込み、そのDOMDocumentTypeノードを取得しています。そして、nodeNameプロパティがDOCTYPE宣言で指定された名前（この場合は"html"）を返すのに対し、localNameプロパティがnullを返すことを示しています。この挙動は、「php local_addr」の「ローカル」という概念が、DOMノードの名前空間を含まない部分を指すことと関連付けられます。localNameは主に名前空間を持つ要素に対して有効なプロパティであり、DOMDocumentTypeのような特別なノードではnullを返すことを理解することが重要です。

PHPのDOMDocumentType::localNameプロパティは、初心者が特に注意すべき点があります。このプロパティは、DocumentTypeノードがXMLやHTMLの要素ではないため、名前空間接頭辞を持たず、通常はnullを返します。localNameは主に、名前空間を持つDOMElement（例えば<svg:circle>のようなタグ）から名前空間接頭辞を除いたローカル名を取得するために設計されています。したがって、DOMDocumentTypeに対してこのプロパティを使用する際は、戻り値が常にnullである可能性を考慮し、必ずnullチェックを行うようにしてください。また、DOMDocument::$doctypeプロパティは、パース対象のドキュメントにDOCTYPE宣言が含まれていない場合、nullを返すため、DOMDocumentTypeインスタンスが正しく取得できたかの確認も重要です。

PHPローカルサーバーでDOCTYPEローカル名を取得する


1<?php
2
3/**
4 * このスクリプトは、PHPのローカル開発サーバー（例: `php -S localhost:8000` コマンドで起動）
5 * や、Apache/Nginxなどのローカルウェブサーバー環境で実行されることを想定しています。
6 * HTMLドキュメントのDOCTYPE宣言から、そのローカル名を取得する方法を示します。
7 * DOMDocumentType::localName は、DOCTYPEの名前（例: `<!DOCTYPE html>` なら `html`）を返します。
8 */
9
10/**
11 * 指定されたHTML文字列からDOCTYPE宣言のローカル名を取得します。
12 *
13 * @param string $htmlString 処理するHTML文字列。
14 * @return string|null DOCTYPEのローカル名、またはDOCTYPE宣言が存在しない場合はnull。
15 */
16function getHtmlDoctypeLocalName(string $htmlString): ?string
17{
18    // DOMDocument オブジェクトを新しく作成します。
19    // このオブジェクトを使ってHTMLやXML文書を操作します。
20    $dom = new DOMDocument();
21    
22    // HTML文字列をDOMDocumentにロードします。
23    // @ 演算子を使用することで、不正なHTML構造によるパース警告を抑制しています。
24    @$dom->loadHTML($htmlString);
25    
26    // ドキュメントのDOCTYPEノードを取得します。
27    // DOMDocumentType クラスのインスタンスが返されるか、DOCTYPEがない場合はnullが返されます。
28    $doctype = $dom->doctype;
29
30    // DOCTYPEノードが実際に存在するかどうかを確認します。
31    if ($doctype instanceof DOMDocumentType) {
32        // localName プロパティは、DOCTYPE宣言のルート要素の名前を返します。
33        // 例えば、HTML5の `<!DOCTYPE html>` の場合は `html` を返します。
34        return $doctype->localName;
35    }
36
37    // DOCTYPE宣言が存在しない場合はnullを返します。
38    return null;
39}
40
41// -----------------------------------------------------------------------------
42// スクリプトの実行例
43// -----------------------------------------------------------------------------
44
45// DOCTYPE宣言を含むHTML文字列の例
46$sampleHtmlWithDoctype = '<!DOCTYPE html>
47<html>
48<head>
49    <title>PHP DOMDocumentType::localName サンプル</title>
50</head>
51<body>
52    <h1>HTML5 DOCTYPEの例</h1>
53    <p>このHTMLには標準的なHTML5のDOCTYPE宣言が含まれています。</p>
54</body>
55</html>';
56
57// DOCTYPE宣言を含まないHTML文字列の例
58$sampleHtmlWithoutDoctype = '<html>
59<head>
60    <title>DOCTYPEなしの例</title>
61</head>
62<body>
63    <p>このHTMLにはDOCTYPE宣言が含まれていません。</p>
64</body>
65</html>';
66
67// 1. DOCTYPE宣言を含むHTMLのローカル名を取得して表示
68$localNameWithDoctype = getHtmlDoctypeLocalName($sampleHtmlWithDoctype);
69if ($localNameWithDoctype !== null) {
70    echo "DOCTYPEのローカル名 (HTML5の例): " . $localNameWithDoctype . "\n";
71} else {
72    echo "HTML5の例ではDOCTYPE宣言が見つかりませんでした。\n";
73}
74
75echo "----------------------------------------\n";
76
77// 2. DOCTYPE宣言を含まないHTMLのローカル名を取得して表示
78$localNameWithoutDoctype = getHtmlDoctypeLocalName($sampleHtmlWithoutDoctype);
79if ($localNameWithoutDoctype !== null) {
80    echo "DOCTYPEのローカル名 (DOCTYPEなしの例): " . $localNameWithoutDoctype . "\n";
81} else {
82    echo "DOCTYPEなしの例ではDOCTYPE宣言が見つかりませんでした。\n";
83}
84
85?>

DOMDocumentType::localNameプロパティは、HTMLやXML文書のDOCTYPE宣言におけるルート要素の「ローカル名」を取得するために使用されます。このプロパティはDOMDocumentTypeクラスに属しており、引数は取りません。例えば、HTML5の標準的なDOCTYPE宣言である<!DOCTYPE html>からは、「html」という文字列を返します。

サンプルコードでは、まずDOMDocumentオブジェクトにHTML文字列を読み込み、$dom->doctypeを通じて文書のDOMDocumentTypeオブジェクトを取得しています。このDOMDocumentTypeオブジェクトが正常に取得できた場合（つまり、HTML文字列にDOCTYPE宣言が含まれている場合）、$doctype->localNameにアクセスすることで、そのローカル名を文字列として取得できます。DOCTYPE宣言が存在しない場合には、このプロパティはnullを返します。

この処理は、php -S localhost:8000コマンドで起動するPHPのローカル開発サーバーや、Apache/Nginxなどのローカルウェブサーバー環境で実行されることを想定しています。システムエンジニアとして文書の構造情報を動的に解析し、特定の種類の文書を識別する際に役立つ基本的な機能の一つです。

このサンプルコードは、PHPのDOM拡張機能を利用し、HTMLのDOCTYPE宣言からそのローカル名を取得する方法を示しています。

最も注意すべき点は、DOMDocument::loadHTML()に付いている@演算子です。これはHTMLパース時の警告を抑制するため、開発中は問題を見逃す原因となりがちです。本番環境ではエラーハンドリングを適切に行い、安易な抑制は避けることを推奨します。

また、DOMDocumentType::localNameプロパティは、DOCTYPE宣言が存在しない場合や不正なHTMLの場合にはnullを返します。そのため、サンプルコードのようにif ($doctype instanceof DOMDocumentType)でノードの存在を必ず確認し、nullが返される可能性を考慮した処理を実装してください。

この機能は、HTML文書の構造をプログラムで解析する際に重要です。ローカルサーバーで動作を確認しながら利用してください。