highlight_file

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

highlight_file — Colorisation syntaxique d'un fichier

Description

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

Affiche la syntaxe colorisée du fichier filename, en utilisant les couleurs définies dans le moteur interne de PHP.

De nombreux serveurs sont configurés pour automatiquement afficher le source colorisé, avec l'extension phps. Par exemple, example.phps va afficher le source du script. Pour activer cette fonctionnalité, utilisez cette ligne dans httpd.conf :

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

Liste de paramètres

filename: Le chemin vers le fichier PHP à coloriser.
return: En passant ce paramètre à true, la fonction retourne le code colorisé au lieu de l'afficher.

Valeurs de retour

Si le second paramètre optionnel return vaut true alors highlight_file() retournera le code généré, au lieu de l'afficher. Si le second paramètre ne vaut pas true alors highlight_file() retournera true en cas de succès, et false sinon.

Historique

Version	Description
8.3.0	Le HTML résultant a changé.

Notes

Attention

Beaucoup de soin doit être apporté lors de l'utilisation de highlight_file() pour s'assurer que vous ne révélez pas d'informations critiques telles que des mots de passe ou d'autres informations qui pourraient créer des fuites d'informations.

Note:
Lorsque le paramètre return est utilisé, cette fonction utilise la mise en tampon (buffer) interne de sortie, il ne peut donc pas être utilisé dans la fonction de rappel de ob_start().

Voir aussi

highlight_string() - Applique la syntaxe colorisée à du code PHP
Les directives INI de coloration

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