highlight_file

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

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

Описание

highlight_file(string $filename, bool $return = false): string|bool

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

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

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

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

filename

Путь к PHP-файлу, который нужно подсветить.

return

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

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

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

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

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

Примечания

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

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

Замечание:

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

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

add a note add a note

User Contributed Notes 1 note

up
1
csst0266 at cs dot uoi dot gr
20 years ago
Here is a simple, yet useful, tip... Issuing the following command under a Unix-like OS:

ln -s your_script.php your_script.phps

Will result in the creation of a symbolic link (called your_script.phps) to the source code (your_script.php). This way you have (apart from the source code .php) the highlighted version of your script (.phps) accessible via your web browser.
To Top