highlight_file

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

highlight_file — Syntax-Hervorhebung für eine Datei

Beschreibung

highlight_file(string $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 true gesetzt 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.

Changelog

Version	Beschreibung
8.3.0	Das resultierende HTML wurde geändert.

Anmerkungen

Achtung

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 return verwendet 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

add a note

User Contributed Notes 1 note

down

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.

add a note