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()

Дивіться також

• highlight_string() - Підсвічує синтаксис рядка
• Підсвічування директив INI