highlight_string

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

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

Описание

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

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

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

string

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

return

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

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

Функция не выводит, а возвращает код с подсветкой синтаксиса в виде строки, если для параметра return установили значение true. В остальных случаях функция возвращает значение true.

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

Версия Описание
8.4.0 Тип значения возврата изменили со string|bool на string|true.
8.3.0 Изменилась результирующая HTML-разметка.

Примеры

Пример #1 Пример подсветки PHP-синтаксиса функцией 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>

Примечания

Замечание:

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

В будущем возможно изменение HTML-разметки, которую генерирует функция.

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