Source of: /manual/en/function.highlight-file.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.misc.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.highlight-file.php',
1 => 'highlight_file',
),
'up' =>
array (
0 => 'ref.misc.php',
1 => 'Misc. Functions',
),
'prev' =>
array (
0 => 'function.halt-compiler.php',
1 => '__halt_compiler',
),
'next' =>
array (
0 => 'function.highlight-string.php',
1 => 'highlight_string',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.highlight-file" class="refentry">
<div class="refnamediv">
<h1 class="refname">highlight_file</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">highlight_file</span> — <span class="dc-title">Syntax highlighting of a file</span></p>
</div>
<a name="function.highlight-file.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.php#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><b>highlight_file</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$filename</tt></span>
[, <span class="methodparam"><span class="type">bool</span> <tt class="parameter">$return</tt><span class="initializer"> = false</span></span>
] )</div>
<p class="para rdfs-comment">
Prints out or returns a syntax highlighted version of the code contained
in <i><tt class="parameter">filename</tt></i>
using the colors defined in the
built-in syntax highlighter for PHP.
</p>
<p class="para">
Many servers are configured to automatically highlight files
with a <em class="emphasis">phps</em> extension. For example,
<var class="filename">example.phps</var> when viewed will show the
syntax highlighted source of the file. To enable this, add this
line to the <var class="filename">httpd.conf</var>:
</p>
<div class="example-contents screen">
<div class="descriptioncode"><pre class="descriptioncode">AddType application/x-httpd-php-source .phps</pre>
</div>
</div>
</div>
<a name="function.highlight-file.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">filename</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Path to the PHP file to be highlighted.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">return</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Set this parameter to <b><tt class="constant">TRUE</tt></b> to make this function return the
highlighted code.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.highlight-file.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
If <i><tt class="parameter">return</tt></i>
is set to <b><tt class="constant">TRUE</tt></b>, returns the highlighted
code as a string instead of printing it out. Otherwise, it will return
<b><tt class="constant">TRUE</tt></b> on success, <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.highlight-file.changelog"></a><div class="refsect1 changelog">
<h3 class="title">Changelog</h3>
<p class="para">
</p><table class="doctable informaltable">
<thead valign="middle">
<tr valign="middle">
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody valign="middle" class="tbody">
<tr valign="middle">
<td align="left">4.2.1</td>
<td align="left">
This function is now also affected by <a href="ini.sect.safe-mode.php#ini.safe-mode" class="link">safe_mode</a> and <a href="ini.sect.safe-mode.php#ini.open-basedir" class="link">open_basedir</a>.
</td>
</tr>
<tr valign="middle">
<td align="left">4.2.0</td>
<td align="left">
The <i><tt class="parameter">return</tt></i>
parameter was added.
</td>
</tr>
</tbody>
</table>
<p>
</p>
</div>
<a name="function.highlight-file.notes"></a><div class="refsect1 notes">
<h3 class="title">Notes</h3>
<div class="caution"><b class="caution">Caution</b>
<p class="para">
Care should be taken when using the <b>highlight_file()</b>
function 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.
</p>
</div>
<blockquote><p><b class="note">Note</b>: This function uses internal output buffering
with this parameter so it can not be used inside an
<a href="function.ob-start.php" class="function">ob_start()</a> callback function.<br /></p></blockquote>
</div>
<a name="function.highlight-file.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.highlight-string.php" class="function" rel="rdfs-seeAlso">highlight_string()</a> - Syntax highlighting of a string</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
