highlight_file

(PHP 4, PHP 5, PHP 7)

highlight_fileПодсветка синтаксиса файла

Описание

mixed highlight_file ( string $filename [, bool $return = false ] )

Выводит или возвращает версию с подсветкой синтаксиса кода, содержащегося в файле filename, используя цвета определенные во встроенной подсветке синтаксиса PHP.

Большинство серверов сконфигурированы автоматически подсвечивать файлы с расширением phps. К примеру, при отображении файла example.phps будет выведен код с подсветкой синтаксиса. Для включения добавьте следующую строку в httpd.conf:

AddType application/x-httpd-php-source .phps

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

filename

Путь к подсвечиваемому PHP файлу.

return

Установите в этот параметр TRUE для того чтобы функция возвращала подсвеченный код.

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

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

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

Версия Описание
4.2.1 На данный момент на эту функцию также воздействуют режимы safe_mode и open_basedir.

Примечания

Предостережение

Необходимо пользоваться функцией highlight_file() с должным вниманием, с тем чтобы по неосторожности не раскрыть конфиденциальную информацию, такую как пароли или любую другую информацию, которая может создать потенциальную угрозу безопасности.

Замечание:

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

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