← All docs

tidy_get_opt_doc()

Returns libtidy's documentation for a configuration option, or false when it has none.

tidy_get_opt_doc()

function tidy_get_opt_doc(mixed $tidy, string $option): string|false

Returns libtidy’s documentation for a configuration option, or false when it has none.

Parameters:

  • $tidy (mixed)
  • $option (string)

Returns: string|false

Availability

Compiled (AOT)Magician (eval)
AvailableAvailable

No examples yet. Check examples/ and showcases/ for usage patterns.

Internals

For how tidy_get_opt_doc is implemented in the compiler, see the internals page.