php8.5
Home/ Manual/ dom / tokenlist/ Dom\TokenList::toggle

Dom\TokenList::toggle

PHP function Edit on GitHub ✎

(PHP 8 >= 8.4.0)

Toggles the presence of a token in the list

Description

Dom\TokenList::toggle(string $token, bool|null $force = null): bool

Toggles the presence of token in the list.

Parameters

token

The token to toggle.

force

If force is provided, setting it to true will add the token, and setting it to false will remove the token.

Return Values

Returns true if the token is in the list after the call, false otherwise.

Errors/Exceptions Errors

Examples

Dom\TokenList::toggle example

Toggles three classes, two without force, and one with.

php
<?php
$dom = Dom\HTMLDocument::createFromString('<p class="font-bold important"></p>', LIBXML_NOERROR);
$p = $dom->body->firstChild;

$classList = $p->classList;
$classList->toggle('font-bold', 'font-small');
$classList->toggle('important', force: true);

echo $dom->saveHtml($p);
?>

The above example will output:

output
<p class="font-bold important"></p>

Source: reference/dom/dom/tokenlist/toggle.xml · from the official PHP manual (php/doc-en)