【PHP8.x】removeメソッドの使い方

removeメソッドの使い方について、初心者にもわかりやすく解説します。

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

基本的な使い方

removeメソッドは、Dom\DocumentTypeオブジェクトが表すドキュメントタイプ宣言を、その親ノードであるドキュメントから削除するメソッドです。Dom\DocumentTypeクラスは、HTMLやXMLドキュメントの冒頭に記述される<!DOCTYPE ...>形式のドキュメントタイプ宣言を表すオブジェクトです。この宣言は、ウェブブラウザやパーサーがドキュメントをどのように解釈し、レンダリングすべきかを指示する重要な役割を担っています。

removeメソッドは、このドキュメントタイプ宣言を、それが所属するDom\Documentオブジェクトの子ノードリストから完全に切り離します。これにより、ドキュメントからDOCTYPE宣言そのものが取り除かれることになります。このメソッドは引数を取らず、処理が成功した場合に特定の値を返しません（void）。

この機能は、例えば、既存のHTML/XMLドキュメントの構造をプログラム的に変更し、ドキュメントタイプ宣言を削除したり、後から別のものに置き換えたりする場合に利用できます。ドキュメントからDOCTYPE宣言が削除されると、そのドキュメントはDOCTYPEを持たない状態となり、ウェブブラウザの表示モードやXMLパーサーの挙動に影響を与える可能性があるため、使用する際にはその影響を十分に考慮する必要があります。

構文(syntax)


1<?php
2
3// Dom\DocumentType クラスのインスタンスを用意します。
4// 例として、既存のDOMドキュメントからdoctypeノードを取得します。
5$dom = new DOMDocument();
6$dom->loadXML('<!DOCTYPE html><html><body></body></html>');
7$documentType = $dom->doctype;
8
9// remove() メソッドを呼び出し、この文書型宣言ノードを親ノードから削除します。
10$documentType->remove();
11
12?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

戻り値なし

戻り値はありません

サンプルコード

PHPでHTMLのDOCTYPEを削除する


1<?php
2
3/**
4 * ファイルから読み込んだHTMLコンテンツからDOCTYPE宣言を削除するサンプル関数
5 *
6 * このコードは、指定されたHTMLファイルの内容を読み込み、
7 * Dom\DocumentType::remove() メソッドを使用してDOCTYPE宣言を削除し、
8 * 変更前と変更後のHTMLを出力します。
9 *
10 * @param string $filepath 操作対象のHTMLファイルパス
11 * @return void
12 */
13function removeDoctypeFromFile(string $filepath): void
14{
15    // 操作対象のHTMLファイルを作成
16    $htmlContent = <<<HTML
17<!DOCTYPE html>
18<html lang="ja">
19<head>
20    <meta charset="UTF-8">
21    <title>サンプルHTML</title>
22</head>
23<body>
24    <h1>DOCTYPE宣言の削除テスト</h1>
25    <p>このファイルのDOCTYPE宣言が削除されます。</p>
26</body>
27</html>
28HTML;
29    file_put_contents($filepath, $htmlContent);
30
31    echo "--- 元のファイル内容 ---" . PHP_EOL;
32    echo file_get_contents($filepath) . PHP_EOL;
33    echo "-------------------------" . PHP_EOL . PHP_EOL;
34
35    // ファイルからHTMLコンテンツを読み込む
36    $html = file_get_contents($filepath);
37    if ($html === false) {
38        echo "ファイルの読み込みに失敗しました: {$filepath}" . PHP_EOL;
39        return;
40    }
41
42    // Dom\Documentオブジェクトを作成
43    $doc = new Dom\Document();
44
45    // HTMLを読み込む (不完全なHTMLでも警告を出さないように@を使用)
46    @$doc->loadHTML($html, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);
47
48    // ドキュメントにDOCTYPE宣言が存在するか確認
49    if ($doc->doctype) {
50        // DOCTYPEノードを削除する
51        // これが Dom\DocumentType::remove() の使用例です。
52        $doc->doctype->remove();
53        echo "DOCTYPE宣言を削除しました。" . PHP_EOL . PHP_EOL;
54    } else {
55        echo "DOCTYPE宣言が見つかりませんでした。" . PHP_EOL . PHP_EOL;
56    }
57    
58    // 変更後のHTMLを取得
59    $newHtmlContent = $doc->saveHTML();
60
61    echo "--- 変更後のHTML内容 ---" . PHP_EOL;
62    echo $newHtmlContent;
63    echo "--------------------------" . PHP_EOL;
64
65    // 後片付けとしてサンプルファイルを削除
66    unlink($filepath);
67}
68
69// サンプルを実行
70$sampleFile = 'sample.html';
71removeDoctypeFromFile($sampleFile);
72

PHP 8で提供されるDom\DocumentType::remove()メソッドは、HTMLやXMLドキュメント内の**DOCTYPE宣言（文書型宣言）**を削除するために使用されます。このメソッドは、ドキュメント内のDOCTYPE宣言を表すDom\DocumentTypeクラスのインスタンスに対して呼び出されます。引数を必要とせず、処理が完了しても特に値を返しません（void）。

サンプルコードでは、まず指定されたHTMLファイルを作成し、その内容をPHPのDom\Documentオブジェクトとして読み込んでいます。ファイルから読み込んだHTMLコンテンツは、Dom\Documentオブジェクトとして内部的にDOMツリーに変換されます。次に、$doc->doctypeプロパティを通じてドキュメントのDOCTYPE宣言にアクセスし、それが存在する場合にremove()メソッドを呼び出しています。この呼び出しによって、DOMツリーからDOCTYPE宣言のノードが削除され、ドキュメントからDOCTYPE宣言がなくなります。変更後のHTMLコンテンツは、$doc->saveHTML()メソッドを使って文字列として取得できます。この機能は、HTMLコンテンツをプログラムで扱い、DOCTYPE宣言の有無や種類を柔軟に制御したい場合に活用できます。このメソッド自体はファイルを削除するのではなく、ファイルから読み込んだHTMLのデータ構造からDOCTYPE宣言部分を削除する役割を持っています。

このサンプルコードは、PHPでHTMLコンテンツをDOMツリーとして扱い、Dom\DocumentType::remove()メソッドでDOCTYPE宣言ノードを削除する手順を示しています。このメソッドは、ディスク上のHTMLファイルそのものからDOCTYPE宣言を直接削除するわけではありません。あくまでPHPのメモリ上で扱われるDOMオブジェクト内のノードを操作するものです。キーワードにある「ファイルの削除」とは機能が異なりますので混同しないようご注意ください。ファイル自体を削除するにはunlink()関数を使用します。また、HTMLをパースする際に不正なHTML構造があると警告が発生することがあります。サンプルコードでは@演算子で警告を抑制していますが、実際のシステムでは適切なエラーハンドリングを実装することが重要です。$doc->doctypeプロパティはDOCTYPE宣言が存在しない場合にnullとなるため、remove()を呼び出す前には必ずその存在を確認する習慣をつけましょう。

PHPで配列から特定要素を削除する


1<?php
2
3/**
4 * 配列から指定した値を最初に検出された一つだけ削除し、インデックスを再構築します。
5 *
6 * この関数は、PHP 8で提供される Dom\DocumentType::remove() メソッドとは異なり、
7 * 配列から要素を削除する一般的な操作を示すものです。
8 * Dom\DocumentType::remove() はDOMツリーから文書型定義ノードを削除するメソッドであり、
9 * 配列操作には使用できません。
10 *
11 * @param array $array 対象の配列
12 * @param mixed $valueToRemove 削除したい値
13 * @return array 削除後の配列（元の配列のコピーが変更されて返されます）
14 */
15function removeValueFromArray(array $array, mixed $valueToRemove): array
16{
17    // 削除したい値が配列内に存在するかどうか、その最初のキー（インデックス）を探します。
18    // array_search() は最初に見つかったキーを返し、見つからない場合は false を返します。
19    $key = array_search($valueToRemove, $array);
20
21    // キーが見つかった場合のみ削除処理を行います。
22    if ($key !== false) {
23        // array_splice() を使用して指定したキーの要素を削除し、
24        // その後の要素を自動的に前に詰めてインデックスを再構築します。
25        // 第一引数: 操作対象の配列 (この関数ではコピーを操作するため、元の配列は変更されません)
26        // 第二引数: 削除を開始するオフセット (キー)
27        // 第三引数: 削除する要素の数 (ここでは1つだけ削除)
28        array_splice($array, $key, 1);
29    }
30
31    return $array;
32}
33
34// --- 使用例 ---
35
36// 1. 基本的な配列からの削除
37$fruits = ['apple', 'banana', 'orange', 'grape'];
38echo "--- 元の配列 (fruits) ---\n";
39print_r($fruits);
40
41// 'banana' を配列から削除
42$fruitsAfterRemoval = removeValueFromArray($fruits, 'banana');
43echo "\n--- 'banana' 削除後の配列 ---\n";
44print_r($fruitsAfterRemoval);
45
46// 2. 存在しない値を削除しようとした場合
47$colors = ['red', 'green', 'blue'];
48echo "\n--- 元の配列 (colors) ---\n";
49print_r($colors);
50
51// 'yellow' (存在しない値) を削除しようとした場合、配列は変更されません。
52$colorsAfterRemoval = removeValueFromArray($colors, 'yellow');
53echo "\n--- 'yellow' 削除後の配列 (変更なし) ---\n";
54print_r($colorsAfterRemoval);
55
56// 3. 重複する値がある場合、最初に見つかったものだけが削除されます。
57$items = ['alpha', 'beta', 'gamma', 'beta', 'delta'];
58echo "\n--- 元の配列 (items) ---\n";
59print_r($items);
60
61// 'beta' を削除（最初に見つかった一つだけが削除される）
62$itemsAfterRemoval = removeValueFromArray($items, 'beta');
63echo "\n--- 'beta' 削除後の配列 (最初の一つのみ) ---\n";
64print_r($itemsAfterRemoval);
65
66?>

このサンプルコードは、PHP 8で提供されるDom\DocumentType::remove()メソッドとは異なり、配列から特定の値を削除する一般的な方法を示すものです。Dom\DocumentType::remove()は、DOMツリー内の文書型定義ノードを削除するメソッドであり、配列の要素操作には使用できません。

removeValueFromArray関数は、引数として渡された配列から、削除したい値が最初に見つかった一つだけを削除し、残りの要素のインデックスを自動的に再構築します。この関数は、まずarray_searchを使って削除したい値のキー（配列内の位置）を特定し、そのキーに対応する要素をarray_spliceという関数で削除する仕組みです。

第一引数$arrayには操作対象の配列を渡し、第二引数$valueToRemoveには配列から削除したい値を指定します。この関数は元の配列のコピーを操作するため、元の配列自体は変更されません。戻り値としては、削除処理が施された新しい配列が返されます。もし削除したい値が配列内に存在しない場合は配列は変更されずにそのまま返され、重複する値がある場合は最初に見つかった値のみが削除されます。

提示のリファレンス情報にあるDom\DocumentType::remove()メソッドは、DOMツリーの文書型定義ノードを削除するものであり、配列の要素を削除する機能とは異なります。混同しないよう注意が必要です。サンプルコードのremoveValueFromArray関数は、配列から指定した値を最初に見つかった一つだけ削除し、インデックスを再構築します。複数の重複値を全て削除したい場合には、この関数は全ての値を削除しないため、別の処理を検討してください。また、array_searchが値を見つけられなかった場合にfalseを返すため、厳密な比較!== falseで安全に条件分岐させています。元の配列を変更するには、関数の戻り値を受け取る必要があります。