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

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

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

基本的な使い方

prefixプロパティは、この処理命令ノードの名前空間接頭辞を保持するプロパティです。このプロパティは、すべてのノードの基底クラスであるDOMNodeクラスから継承されています。XMLドキュメントにおいて、要素が<app:item>のように名前空間接頭辞を持つ場合、このプロパティはその接頭辞部分（この例では「app」）の文字列を取得するために使用されます。しかし、処理命令（例: <?xml-stylesheet ...?>）は、その構文の性質上、要素ノードのように名前空間接頭辞を持つ構造にはなっていません。そのため、DOMProcessingInstructionオブジェクトのprefixプロパティにアクセスした場合、ほとんどの状況で値としてnullが返されます。このプロパティは、DOMツリー内の多様なノードタイプを統一的なインターフェースで扱えるようにするために存在しますが、処理命令ノードの情報を取得する目的で積極的に利用されることは稀です。処理命令のターゲット名を取得したい場合は、代わりにtargetプロパティを使用することが推奨されます。

構文(syntax)


1<?php
2
3// XML文字列を定義します。'php' という接頭辞を持つ処理命令が含まれています。
4$xml = <<<XML
5<?xml version="1.0" encoding="utf-8"?>
6<doc>
7  <?php:instruction data?>
8</doc>
9XML;
10
11// DOMDocumentオブジェクトを作成し、XMLを読み込みます。
12$dom = new DOMDocument();
13$dom->loadXML($xml);
14
15// 処理命令ノード(DOMProcessingInstruction)を取得します。
16$pi = $dom->getElementsByTagName('instruction')->item(0);
17
18// prefixプロパティにアクセスして、処理命令の名前空間接頭辞を取得し表示します。
19// この場合の接頭辞は 'php' です。
20echo $pi->prefix;
21
22?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string|null

DOMProcessingInstruction::prefix プロパティは、指示（instruction）の接頭辞（prefix）を文字列で返します。接頭辞が存在しない場合は null を返します。

サンプルコード

PHPで数値をゼロパディングする


1<?php
2
3declare(strict_types=1);
4
5/**
6 * 数値の前に'0'を追加して、指定された桁数にフォーマットします（ゼロパディング）。
7 *
8 * この関数は、IDやコード番号など、固定長の数値を扱う際に便利です。
9 *
10 * @param int $number フォーマット対象の正の整数。
11 * @param int $digits 結果として得たい文字列の総桁数。
12 * @return string 先頭が'0'で埋められた、指定桁数の文字列。
13 */
14function prefixNumberWithZero(int $number, int $digits): string
15{
16    // sprintf関数を使用して数値をフォーマットする
17    // "%04d" のようなフォーマット文字列は、
18    // 「引数を整数(d)として扱い、全体で4桁になるように、足りない部分を左側に0で埋める」
19    // という意味になります。
20    // ここでは桁数を可変にするため、フォーマット文字列を動的に生成しています。
21    $format = "%0{$digits}d";
22
23    return sprintf($format, $number);
24}
25
26// --- 関数の使用例 ---
27
28// 数値 5 を 4桁にフォーマットする
29$number1 = 5;
30$paddedString1 = prefixNumberWithZero($number1, 4);
31echo "{$number1} -> {$paddedString1}" . PHP_EOL; // 出力: 5 -> 0005
32
33// 数値 123 を 4桁にフォーマットする
34$number2 = 123;
35$paddedString2 = prefixNumberWithZero($number2, 4);
36echo "{$number2} -> {$paddedString2}" . PHP_EOL; // 出力: 123 -> 0123
37
38// 元の数値が指定した桁数と同じかそれ以上の場合は、何も付加されない
39$number3 = 9876;
40$paddedString3 = prefixNumberWithZero($number3, 4);
41echo "{$number3} -> {$paddedString3}" . PHP_EOL; // 出力: 9876 -> 9876
42
43// 数値 88 を 6桁にフォーマットする
44$number4 = 88;
45$paddedString4 = prefixNumberWithZero($number4, 6);
46echo "{$number4} -> {$paddedString4}" . PHP_EOL; // 出力: 88 -> 000088
47
48?>

このPHPコードは、数値の前に'0'を追加して、指定された桁数の文字列に整形（ゼロパディング）するprefixNumberWithZero関数を定義したものです。

この関数は2つの引数を受け取ります。第一引数$numberには整形したい数値を、第二引数$digitsには最終的に揃えたい桁数を指定します。関数の内部では、文字列を特定の書式で整形するPHPのsprintf関数が使われています。動的に生成される書式"%0{$digits}d"は、「渡された数値を整数として扱い、全体の桁数が$digitsに満たない場合、左側を'0'で埋める」という指示を表します。

この関数を呼び出すと、戻り値として、先頭が'0'で埋められて指定桁数になった文字列が返されます。例えば、数値5と桁数4を渡すと'0005'という文字列が返ってきます。なお、元の数値が指定した桁数以上の場合、先頭に'0'は追加されず、数値がそのまま文字列に変換されて返されます。

このようなゼロパディング処理は、会員IDや商品コードのように、常に桁数を揃えてデータを扱いたい場合に非常に便利な手法です。

この関数は数値を固定長の「文字列」に変換します。そのため、返された「0005」のような値は文字として扱われ、そのままでは足し算などの数値計算はできません。注意点として、元の数値が指定した桁数を超えている場合、文字列が切り捨てられることはなく、元の桁数のまま出力されます。また、この関数は正の整数を想定しており、負の数を渡すとマイナス記号も文字数に含まれるため、意図しない結果になる可能性があります。同様のゼロ埋めは、文字列を直接操作するstr_pad関数を使っても実現できます。

PHP DOMProcessingInstruction の prefix を取得する


1<?php
2
3/**
4 * DOMProcessingInstructionオブジェクトのprefixプロパティの使用例を示します。
5 *
6 * XMLの処理命令ノード (例: `<?target data?>`) は、通常、名前空間プレフィックスを
7 * 持たないため、その `prefix` プロパティは `null` を返します。
8 * このサンプルでは、処理命令ノードのプレフィックスが `null` であることと、
9 * 比較対象としてプレフィックスを持つ要素ノードの値が文字列として取得できることを示します。
10 */
11function showDomProcessingInstructionPrefix(): void
12{
13    // 処理命令(<?php-style ...?>)と名前空間を持つ要素(<bk:book>)を含むXML文字列を定義
14    $xmlString = <<<XML
15<?xml version="1.0" encoding="UTF-8"?>
16<?php-style-checker content="value"?>
17<root xmlns:bk="urn:example:books">
18    <bk:book>Advanced PHP Programming</bk:book>
19</root>
20XML;
21
22    // DOMDocumentオブジェクトを生成し、XMLを読み込む
23    $dom = new DOMDocument();
24    $dom->loadXML($xmlString);
25
26    // ドキュメント直下の子ノードをループし、処理命令ノードを探す
27    foreach ($dom->childNodes as $node) {
28        // ノードがDOMProcessingInstructionのインスタンスであるかを確認
29        if ($node instanceof DOMProcessingInstruction) {
30            // DOMProcessingInstructionオブジェクトのprefixプロパティを取得して表示します。
31            // 処理命令はプレフィックスを持たないため、結果は null になります。
32            echo "処理命令ノード ('" . $node->target . "') のプレフィックス:" . PHP_EOL;
33            var_dump($node->prefix); // 出力: NULL
34            echo PHP_EOL;
35        }
36    }
37
38    // 比較のため、名前空間プレフィックスを持つ要素ノードを取得
39    // getElementsByTagNameはプレフィックスを無視してローカル名で要素を取得します
40    $bookElement = $dom->getElementsByTagName('book')->item(0);
41
42    if ($bookElement) {
43        // DOMElementオブジェクトのprefixプロパティを取得して表示します。
44        // この要素には 'bk' というプレフィックスが付いています。
45        echo "要素ノード ('" . $bookElement->nodeName . "') のプレフィックス:" . PHP_EOL;
46        var_dump($bookElement->prefix); // 出力: string(2) "bk"
47    }
48}
49
50// 関数を実行して結果を表示
51showDomProcessingInstructionPrefix();

DOMProcessingInstructionクラスのprefixプロパティは、XMLの処理命令ノード（例: <?target data?>）の名前空間プレフィックスを取得するために使用します。このプロパティに引数はありません。戻り値は、ノードにプレフィックスが存在すればその名前を文字列(string)で返し、存在しなければnullを返します。

XMLの処理命令は、その構造上、通常は名前空間プレフィックスを持ちません。そのため、DOMProcessingInstructionオブジェクトのprefixプロパティにアクセスすると、多くの場合nullが返されます。

このサンプルコードでは、まず処理命令 (<?php-style-checker ...?>) を含むXML文書を読み込みます。そして、文書の中から処理命令ノードを特定し、そのprefixプロパティの値を出力します。処理命令にはプレフィックスがないため、結果はnullとなります。

比較のために、bkというプレフィックスを持つ要素ノード (<bk:book>) のprefixプロパティも取得して表示しています。この場合、プロパティは文字列として'bk'を正しく返します。このようにprefixプロパティは、ノードの種類に応じてプレフィックスの有無とその名前を確認する際に役立ちます。

DOMProcessingInstructionのprefixプロパティは、XMLの処理命令（例: <?target ...?>）が仕様上、名前空間プレフィックスを持たないため、常にnullを返します。サンプルコードのように、プレフィックスを持つ要素ノード（例: <bk:book>）のprefixプロパティが文字列を返すのとは挙動が異なる点に注意が必要です。このプロパティの戻り値の型はstring|nullであり、nullが返ることを前提としてコーディングすることが大切です。また、loadXML()は不正なXMLを読み込むと失敗する場合があるため、実際の開発ではエラーハンドリングを適切に行うことを推奨します。