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

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

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

基本的な使い方

『removeメソッドは、Dom\TokenListオブジェクトから指定された1つ以上のトークンを削除するメソッドです。Dom\TokenListは、HTML要素のclass属性のように、スペースで区切られた文字列の集合を表現し、操作するためのオブジェクトです。このメソッドを利用することで、要素が持つクラスのリストから、特定のクラス名を安全かつ簡単 Gに取り除くことができます。引数には、削除したいトークンを文字列として1つ、あるいは複数指定します。複数のトークンを一度に削除したい場合は、引数をカンマで区切って渡します。指定したトークンがリスト内に存在しない場合、このメソッドは何も行わず、エラーも発生しません。ただし、引数に空の文字列や、スペース、タブなどのASCII空白文字を含む文字列を渡した場合にはDom\Exceptionが発生するため注意が必要です。このメソッドは呼び出し元のDom\TokenListオブジェクトの状態を直接変更し、処理結果としての戻り値はありません。DOM操作において、クラス属性を動的に変更する際に非常に便利な機能です。

構文(syntax)


1<?php
2
3$document = new DOMDocument();
4$document->loadHTML('<html><body><div class="class1 class2 class3"></div></body></html>');
5
6$element = $document->getElementsByTagName('div')->item(0);
7$tokenList = $element->classList;
8
9// 1つ以上のトークン (クラス名) を引数に指定して削除します
10$tokenList->remove('class2', 'class3');
11
12// 結果: "class1"
13echo $element->getAttribute('class');
14
15?>

引数(parameters)

string ...$tokens

string ...$tokens: 削除したいトークンを空白文字で区切られた文字列として複数指定

戻り値(return)

void

このメソッドは、指定されたトークンをDom\TokenListから削除します。戻り値はありません。