What is PhpDig?
PhpDig is a PHP MySQL based
Web Spider & Search Engine.

highlight_file
Prev	XXXIX. Miscellaneous Functions	Next

highlight_file

Name

highlight_file — Displays a file with PHP syntax highlighting.

Synopsis

bool highlight_file(filename); string filename: File to display with PHP syntax highlighting

Returns

TRUE on success; FALSE on failure

Description

highlight_file() is used to display a file with PHP syntax highlighting, using PHP's built-in syntax highlighter. The syntax highlighting is applied using HTML tags. The function returns TRUE on success and FALSE on failure.

The colors used for highlighting can be set in the php.ini file. They can also be set using the ini_set() function (see the example).

Caution

When a file is displayed using highlight_file() , all of the content of the file will be displayed - including passwords and any other sensitive information.

Version

PHP Version: 4+

Example

Example 757. Display only the comments in a syntax-highlighted file

<?php
# Show only the comments
ini_set ('highlight.string',  '#FFFFFF');
ini_set ('highlight.comment', '#FF8000');
ini_set ('highlight.keyword', '#FFFFFF');
ini_set ('highlight.bg',      '#FFFFFF');
ini_set ('highlight.default', '#FFFFFF');
ini_set ('highlight.html',    '#FFFFFF');

# Display this file with syntax highlighting
highlight_file (basename ($SCRIPT_NAME));
?>

Prev	Home	Next
get_browser	Up	highlight_string

PHP Functions Essential Reference. Copyright © 2002 by New Riders Publishing (Authors: Zak Greant, Graeme Merrall, Torben Wilson, Brett Michlitsch). This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, v1.0 or later (the latest version is presently available at http://www.opencontent.org/openpub/). The authors of this book have elected not to choose any options under the OPL. This online book was obtained from http://www.fooassociates.com/phpfer/ and is designed to provide information about the PHP programming language, focusing on PHP version 4.0.4 for the most part. The information is provided on an as-is basis, and no warranty or fitness is implied. All persons and entities shall have neither liability nor responsibility to any person or entity with respect to any loss or damage arising from the information contained in this book.