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

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

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

基本的な使い方

『supportsメソッドは、Dom\TokenListオブジェクトが関連付けられている属性で、指定されたトークンが仕様上サポートされているかどうかを判定するメソッドです。HTMLの属性の中には、<link>要素のrel属性のように、stylesheetやiconといった特定のキーワードしか値として許可されていないものがあります。このメソッドは、そのような属性に対して、引数で指定したトークンが有効な値として定義されているかを検証するために使用されます。指定したトークンがその属性でサポートされていればtrueを、そうでなければfalseを返します。この機能は、トークンが現在の属性値に実際に含まれているかを確認するcontainsメソッドとは異なります。supportsメソッドは、値の存在有無ではなく、その属性の仕様としてトークンが妥当であるかをチェックする役割を担います。引数として渡すトークンが空文字列であったり、空白文字を含んでいたりするとDOMExceptionというエラーが発生するため注意が必要です。

構文(syntax)


1<?php
2
3$document = new Dom\Document();
4$element = $document->createElement('div');
5
6// Dom\TokenList オブジェクトを取得します
7$tokenList = $element->classList;
8
9// public Dom\TokenList::supports(string $token): bool
10$isSupported = $tokenList->supports('some-class');
11
12var_dump($isSupported);

引数(parameters)

string $token

string $token: サポートされているかどうかを確認したいトークンを指定する文字列

戻り値(return)

bool

このメソッドは、引数として渡されたCSSトークンが、この Dom\TokenList オブジェクトでサポートされているかどうかを示す真偽値（trueまたはfalse）を返します。