Using a test file ("test.php") to output the file with the PHP syntax highlighted:
The browser output of the code above could be (depending on the content in your file):
The HTML output of the code above could be (View Source):
The highlight_file() function outputs a file with the PHP syntax highlighted. The syntax is highlighted by using HTML tags.
Tip: The colors used for highlighting can be set in the php.ini file or with the ini_set() function.
Note: When using this function, the entire file will be displayed - including passwords and any other sensitive information!
Parameter | Description |
---|---|
filename | Required. Specifies the file to display |
return | Optional. If this parameter is set to TRUE, this function will return the highlighted code as a string, instead of printing it out. Default is FALSE |
Return Value: | If the return parameter is set to TRUE, this function returns the highlighted code as a string instead of printing it out. Otherwise, it returns TRUE on success, or FALSE on failure |
---|---|
PHP Version: | 4+ |
Changelog: | As of PHP 4.2.1, this function is now also affected by safe_mode and
open_basedir. However, safe_mode was removed in PHP 5.4. The return parameter was added in PHP 4.2.0. |