The highlight_file() function prints out a syntax higlighted version of the code contained in filename using the colors defined in the built-in syntax highlighter for PHP.
If the second parameter return is set to TRUE then highlight_file() will return the highlighted code as a string instead of printing it out. If the second parameter is not set to TRUE then highlight_file() will return TRUE on success, FALSE on failure.
Note: The return parameter became available in PHP 4.2.0. Before this time it behaved like the default, which is FALSE
Note: Care should be taken when using the show_source() and highlight_file() functions to make sure that you do not inadvertently reveal sensitive information such as passwords or any other type of information that might create a potential security risk.
Example 1. Creating a source highlighting URL To setup a URL that can code hightlight any script that you pass to it, we will make use of the "ForceType" directive in Apache to generate a nice URL pattern, and use the function highlight_file() to show a nice looking code list. In your httpd.conf you can add the following:
And then make a file named "source" and put it in your web root directory.
Then you can use an URL like the one below to display a colorized version of a script located in "/path/to/script.php" in your web site.
|
See also highlight_string(), show_source().