THE WORLD'S LARGEST WEB DEVELOPER SITE

PHP Tutorial

PHP HOME PHP Intro PHP Install PHP Syntax PHP Comments PHP Variables PHP Echo / Print PHP Data Types PHP Strings PHP Numbers PHP Constants PHP Operators PHP If...Else...Elseif PHP Switch PHP While Loops PHP For Loops PHP Functions PHP Arrays PHP Sorting Arrays PHP Superglobals

PHP Forms

PHP Form Handling PHP Form Validation PHP Form Required PHP Form URL/E-mail PHP Form Complete

PHP Advanced

PHP Arrays Multi PHP Date and Time PHP Include PHP File Handling PHP File Open/Read PHP File Create/Write PHP File Upload PHP Cookies PHP Sessions PHP Filters PHP Filters Advanced

PHP OOP

PHP What is OOP PHP Classes/Objects PHP Constructor PHP Destructor PHP Access Modifiers PHP Inheritance PHP Constants PHP Abstract Classes PHP Traits

MySQL Database

MySQL Database MySQL Connect MySQL Create DB MySQL Create Table MySQL Insert Data MySQL Get Last ID MySQL Insert Multiple MySQL Prepared MySQL Select Data MySQL Delete Data MySQL Update Data MySQL Limit Data

PHP XML

PHP XML Parsers PHP SimpleXML Parser PHP SimpleXML - Get PHP XML Expat PHP XML DOM

PHP - AJAX

AJAX Intro AJAX PHP AJAX Database AJAX XML AJAX Live Search AJAX Poll

PHP Examples

PHP Examples PHP Quiz PHP Exercises PHP Certificate

PHP Reference

PHP Overview PHP Array PHP Calendar PHP Date PHP Directory PHP Error PHP Filesystem PHP Filter PHP FTP PHP Libxml PHP Mail PHP Math PHP Misc PHP MySQLi PHP Network PHP SimpleXML PHP Stream PHP String PHP XML Parser PHP Zip PHP Timezones

PHP highlight_file() Function

❮ PHP Misc Reference

Example

Using a test file ("test.php") to output the file with the PHP syntax highlighted:

<html>
<body>
<?php
highlight_file("test.php");
?>
</body>
</html>

The browser output of the code above could be (depending on the content in your file):

<html>
<body>
<?php
echo ("test.php");
?>
</body>
</html>

The HTML output of the code above could be (View Source):

<html>
<body>
<code><span style="color: #000000">
&lt;html&gt;
<br />&lt;body&gt;
<br /><span style="color: #0000BB">&lt;?php
<br /></span><span style="color: #007700">echo&nbsp;(</span><span style="color: #DD0000">"test.php"</span><span style="color: #007700">);
<br /></span><span style="color: #0000BB">?&gt;
<br /></span>&lt;/body&gt;
<br />&lt;/html&gt;</span>
</code>
</body>
</html>
Try it Yourself »


Definition and Usage

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 syntax 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!


Syntax

highlight_file(filename,return)
Parameter Description
filename Required. Specifies the file to be highlighted
return Optional. If set to TRUE, this function will return the highlighted code as a string, instead of printing it out. Default is FALSE

Technical Details

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: PHP 4.2.1 - This function is now also affected by safe_mode and open_basedir. However, safe_mode was deprecated and removed in PHP 5.4.
PHP 4.2 - The return parameter was added.

❮ PHP Misc Reference