highlight_file
(PHP 4, PHP 5, PHP 7, PHP 8)
highlight_file — Syntax-Hervorhebung für eine Datei
Beschreibung
$filename, bool $return = false): string|bool
Erzeugt die hervorgehobene Syntax des Codes der Datei
filename als Ausgabe oder als Rückgabewert. Dabei
werden die im eingebauten Syntax-Highlighter für PHP definierten Farben
benutzt.
Viele Server sind so konfiguriert, dass sie den Code von Dateien mit der phps-Erweiterung automatisch hervorheben. Wenn zum Beispiel beispiel.phps aufgerufen wird, wird die hervorgehobene Syntax des Quellcodes der Datei angezeigt. Mit der folgenden Zeile in der httpd.conf wird dies aktiviert:
AddType application/x-httpd-php-source .phps
Parameter-Liste
-
filename -
Der Pfad zur PHP-Datei, deren Code hervorgehoben werden soll.
-
return -
Wenn dieser Parameter auf
truegesetzt wird, gibt die Funktion den hervorgehobenen Code zurück.
Rückgabewerte
Falls return auf true gesetzt ist, wird der
hervorgehobene Code nicht direkt ausgegeben, sondern als Zeichenkette
zurückgegeben. Andernfalls wird bei Erfolg true zurückgegeben und
false, falls ein Fehler auftritt.
Anmerkungen
Wenn highlight_file() verwendet wird, sollte darauf geachtet werden, dass nicht versehentlich vertrauliche Informationen wie Passwörter oder andere Informationen, die ein potentielles Sicherheitsrisiko schaffen könnten, verraten werden.
Hinweis:
Wenn der Parameter
returnverwendet wird, benutzt diese Funktion die interne Ausgabepufferung und kann daher nicht in einer ob_start()-Callbackfunktion eingesetzt werden.
Siehe auch
- highlight_string() - Hervorhebung der Syntax einer Zeichenkette
- INI-Direktiven für Highlighting
