highlight_file
(PHP 4, PHP 5, PHP 7)
highlight_file — Подсветка синтаксиса файла
Описание
Выводит или возвращает версию с подсветкой синтаксиса кода, содержащегося
в файле filename
, используя цвета, определенные во
встроенной подсветке синтаксиса PHP.
Большинство серверов сконфигурированы автоматически подсвечивать файлы с расширением phps. К примеру, при отображении файла example.phps будет выведен код с подсветкой синтаксиса. Для включения добавьте следующую строку в httpd.conf:
AddType application/x-httpd-php-source .phps
Список параметров
-
filename
-
Путь к подсвечиваемому файлу PHP.
-
return
-
Установите в этот параметр
true
для того, чтобы функция вернула подсвеченный код.
Возвращаемые значения
Если в return
установлено true
, то подсвеченный
код возвращается в виде строки, а отображает его. В другом случае будет
возвращено true
, либо false
при ошибке.
Примечания
Необходимо пользоваться функцией highlight_file() с должным вниманием, с тем чтобы по неосторожности не раскрыть конфиденциальную информацию, такую как пароли или любую другую информацию, которая может создать потенциальную угрозу безопасности.
Замечание:
При использовании параметра
return
данная функция использует внутреннюю буферизацию вывода, поэтому она не может быть использована внутри callback-функции ob_start().