highlight_file
(PHP 4, PHP 5, PHP 7, PHP 8)
highlight_file — Подсвечивает синтаксис файла
Описание
Многие серверы настроены с модулем 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().