PHP
 Computer >> コンピューター >  >> プログラミング >> PHP

PHPのhighlight_file()関数とは？使い方をわかりやすく解説

PHPのhighlight_file()関数は、指定したファイルの内容をPHP構文がハイライト（色分け）された状態で出力する関数です。ソースコードを読みやすく表示したい場合に便利で、チュートリアルサイトやデモページなどでよく利用されます。

構文

highlight_file(file, return)

パラメータ

  • file − ハイライト表示したいファイル名を指定します。

  • return − このパラメータにtrueを設定すると、関数はハイライト済みのコードをブラウザに出力せず、文字列として返します。デフォルト値はfalseです。

戻り値

returnパラメータがtrueの場合、highlight_file()関数はハイライト済みのコードを文字列として返します。それ以外の場合は、成功すればtrueを、失敗すればfalseを返します。

使用例

以下は、テストファイル「new.php」を使って、PHP構文がハイライトされた状態でファイルを出力する例です。

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

出力結果

ブラウザには次のように表示されます。

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

補足

highlight_file()は、show_source()関数のエイリアスとしても知られており、どちらを呼び出しても同じ動作になります。なお、本番環境でこの関数を使ってファイルを公開する場合、データベースの接続情報などの機密データが含まれたソースコードがそのまま見えてしまう恐れがあるため、取り扱いには十分注意しましょう。

  1. PHPのdelete()関数とは？使い方とサンプルコードをわかりやすく解説

    PHPのdelete()関数は、指定したファイルを削除するための関数です。削除したいファイルのパスをパラメータとして渡すことで、そのファイルをシステムから削除できます。 構文（Syntax） delete(file_path) パラメータ（Parameters） file_path： 削除したいファイルのパスを指定します。相対パス・絶対パスのどちらでも指定可能です。 戻り値（Return） delete()関数は、処理結果に応じて以下のブール値を返します。 true： ファイルの削除が成功した場合 false： ファイルの削除に失敗した場合（ファイルが存在しない、権限がないなど） 使用

  2. PHPのcopy()関数とは？使い方・パラメータ・実行例をわかりやすく解説

    PHPのcopy()関数は、指定したファイルを別の場所へコピーするための組み込み関数です。この関数を実行すると、コピー元（ソース）ファイルをもとに、コピー先（デスティネーション）として新しいファイルが作成されます。なお、コピー先にすでに同名のファイルが存在する場合は、そのファイルは上書きされる点に注意してください。構文（Syntax）copy(source_file, dest_file)パラメータsource_file − コピー元となるファイルを指定します。dest_file − コピー先のファイルパスを指定します。戻り値（Return値）copy()関数は、処理結果に応じて以下のブール値