highlight_string

(PHP 4, PHP 5, PHP 7, PHP 8)

highlight_string — Подсвечивает синтаксис строки

Описание

highlight_string(string $string, bool $return = false): string|bool

Выводит или возвращает HTML-разметку для версии c подсветкой синтаксиса PHP-кода, применяя цвета, которые определены во встроенном обработчике подсветки синтаксиса PHP.

Список параметров

string

PHP-код, который нужно подсветить. Код должен включать открывающий тег.

return

Параметру устанавливают значение true, чтобы функция возвращала подсвеченный код.

Возвращаемые значения

Если параметр return равен true, то вместо вывода в виде строки возвращается код с подсветкой синтаксиса. В противном случае возвращает true или false в случае возникновения ошибки.

Список изменений

Версия Описание
8.3.0 Изменился результирующий HTML.

Примеры

Пример #1 Пример использования функции highlight_string()

<?php

highlight_string('<?php phpinfo(); ?>');

?>

Результат выполнения приведённого примера: 

<code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php phpinfo</span><span style="color: #007700">(); </span><span style="color: #0000BB">?&gt;</span>
</span>
</code>

Результат выполнения приведённого примера в PHP 8.3: 

<pre><code style="color: #000000"><span style="color: #0000BB">&lt;?php phpinfo</span><span style="color: #007700">(); </span><span style="color: #0000BB">?&gt;</span></code></pre>

Примечания

Замечание:

Поскольку в сигнатуре функции есть параметр return, она будет использовать внутреннюю буферизацию вывода, поэтому эту функцию нельзя указывать в качестве callback-функции при вызове функции ob_start().

В будущем возможно изменение сгенерированной HTML-разметки.

Смотрите также