📄 function.highlight-file.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html> <head> <title>Syntax highlighting of a file</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> </head> <body><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.halt-compiler.html">__halt_compiler</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.highlight-string.html">highlight_string</a></div> <div class="up"><a href="ref.misc.html">Misc. Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div><hr /><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> <div class="refsect1 description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><b><b>highlight_file</b></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> ] )</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"><pre><div class="cdata"><pre>AddType application/x-httpd-php-source .phps</pre></div> </pre></div> </div> <div class="refsect1 parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><i><tt class="parameter">filename</tt></i></span> <dd> <p class="para"> Path to the PHP file to be highlighted. </p> </dd> </dt> <dt> <span class="term"><i><tt class="parameter">return</tt></i></span> <dd> <p class="para"> Set this parameter to <b><tt>TRUE</tt></b> to make this function return the highlighted code. </p> </dd> </dt> </dl> </p> </div> <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>TRUE</tt></b>, returns the highlighted code as a string instead of printing it out. Otherwise, it will return <b><tt>TRUE</tt></b> on success, <b><tt>FALSE</tt></b> on failure. </p> </div> <div class="refsect1 changelog"> <h3 class="title">ChangeLog</h3> <p class="para"> <table class="informaltable"> <colgroup> <thead valign="middle"> <tr valign="middle"> <th colspan="1">Version</th> <th colspan="1">Description</th> </tr> </thead> <tbody valign="middle" class="tbody"> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">4.2.1</td> <td colspan="1" rowspan="1" align="left"> This function is now also affected by <a href="features.safe-mode.html#ini.safe-mode" class="link">safe_mode</a> and <a href="features.safe-mode.html#ini.open-basedir" class="link">open_basedir</a>. </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">4.2.0</td> <td colspan="1" rowspan="1" align="left"> The <i><tt class="parameter">return</tt></i> parameter was added. </td> </tr> </tbody> </colgroup> </table> </p> </div> <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 bufferingwith this parameter so it can not be used inside an<a href="function.ob-start.html" class="function">ob_start()</a> callback function.<br /></p></blockquote> </div> <div class="refsect1 seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"><a href="function.highlight-string.html" class="function" rel="rdfs-seeAlso">highlight_string()</a></li> </ul> </p> </div></div><hr /><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.halt-compiler.html">__halt_compiler</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.highlight-string.html">highlight_string</a></div> <div class="up"><a href="ref.misc.html">Misc. Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -