php8.5
Home/ Manual/ tidy / tidy/ tidy::getOpt

tidy::getOpt

PHP function Edit on GitHub ✎

Returns the value of the specified configuration option for the tidy document

Description

Oop

tidy::getOpt(string $option): string|int|bool

Procedural

tidy_getopt(tidy $tidy, string $option): string|int|bool

Returns the value of the specified option for the specified tidy tidy.

Parameters

tidy

Object

option

You will find a list with each configuration option and their types at: Conf.

Return Values

Returns the value of the specified option. The return type depends on the type of the specified one.

Examples

tidy_getopt() example

php
<?php

$html ='
<html><head><title>Title</title></head>
<body>

<p><img src="img.png"></p>

</body></html>';

$config = array('accessibility-check' => 3,
                'alt-text' => 'some text');

$tidy = new tidy();
$tidy->parseString($html, $config);


var_dump($tidy->getOpt('accessibility-check')); //integer
var_dump($tidy->getOpt('lower-literals')); //boolean
var_dump($tidy->getOpt('alt-text')); //string

?>

The above example will output:

output
int(3)
bool(true)
string(9) "some text"

Source: reference/tidy/tidy/getopt.xml · from the official PHP manual (php/doc-en)