【PHP入門】header関数とは?使い方をわかりやすく解説

PHPのheader関数とは?
指定したページにリダイレクトする方法が知りたい
ファイルを取得する方法が知りたい

PHPではHTTPによるリクエストや、レスポンスのやりとりをするときにHTTPヘッダの内容を指定できるheader関数があります。

この記事ではheader関数について、基本からファイルを取得する方法、ページにリダイレクトする方法などについて解説していきます。

※この記事ではPHPの「Version 7.1.1」で動作確認しました。

目次

header関数とは

header関数は、HTTPヘッダー情報を送信するときに使用します。

そもそもHTTPヘッダーとは、HTTPによる「リクエスト(要求)→レスポンス(応答)」の流れで、どのような情報をリクエストして、どのようなコンテンツを受け取るかを定義するためのものです。

HTTPヘッダを定義するheader関数は以下のように定義します。

header ( $ヘッダ文字列 [, bool $replace = true [, int $http_response_code ]] )

第一引数にはヘッダ文字列を指定します。ヘッダ文字列は”http/”から始まるヘッダを指定した場合は、HTTPステータスコードを示すために使用されます。

“Location:”ヘッダとURLを指定すると、指定したURLのブラウザを表示することができます。

第二引数のreplaceオプションを指定すると、前回送信された類似のヘッダが指定された場合に、値を置換するかどうかを指定します。

第三引数の$http_response_codeを指定すると、HTTPレスポンスコードを強制的に指定した値に設定することができます。

header関数の使い方

ファイルのダウンロード

ここでは実際にheader関数を使用して、sample.jpgをdownload.jpgという名前でダウンロードする方法を見ていきましょう。

「header.php」ファイルを作成して以下のプログラムを記述します。取得するファイルは予め用意して指定のディレクトリに格納しておきます。(ここでは取得するディレクトリを/Users/Shared/PHPで指定しています。)

<?php

// ダウンロードするサーバのファイル
$pass = 'sample.jpg';

// HTTPヘッダを設定
header('Content-Type: /Users/Shared/PHP');
header('Content-Length: '.filesize($pass));
header('Content-Disposition: attachment; filename=download.jpg');

readfile($filepath);

?>

header.phpを実行すると、指定したパスに存在する指定したファイルをダウンロードすることができます。

HTTPヘッダの設定では、まずContent-Typeにパスを指定し、Content-Lengthにはファイルサイズを指定します。

Content-Dispositionではdownload.jpgの名前でダウンロードされるように指定しています。

ファイルをダウンロードする方法については、以下の記事でも詳しく解説していますので、ぜひ参考にしてくださいね!

指定したページにリダイレクト

header関数で指定したページにリダイレクトするには、引数に「Location: url」の形式で指定します。

httpから始まるURLは、絶対パスでも相対パスでも構いません。

<?php

header('Location: https://www.sejuku.net/blog/');
exit();

?>

このサンプルを実行すると、指定したURLのページが表示されます。リダイレクトする際には、以降のコードが実行されないようにexit()を指定して処理を終了します。

JSONを出力するときの設定方法

JSON形式のデータを出力する際には、header関数で「Content-Type: application/json」を指定します。

JSONのデータは文字コードがUTF-8なので「charset=utf-8」を指定します。

'data1',
          'BBB'=>'data2',
          'CCC'=>'data3',
          'DDD'=>'data4',
          'EEE'=>'data5'
        ];

//配列をJSON形式に変換
$jsonstr =  json_encode($array);

receive_json($jsonstr);

?>

実行結果:

{"AAA":"data1","BBB":"data2","CCC":"data3","DDD":"data4","EEE":"data5"}

データをJSON形式に変換する方法や、JSON形式のデータをデコードする方法の詳細については、以下の記事で詳しく解説しています!

まとめ

ここでは、HTTPヘッダを使用するheader関数について、以下の内容で解説しました。

  • header関数の使用方法
  • header関数でファイルを取得する方法
  • header関数でブラウザをリダイレクトする方法
  • JSON形式のデータを適切に出力する方法

header関数を使用してHTTPヘッダを指定する処理はよく使いますので、よく理解しておきましょう。もしheader関数の使い方を忘れてしまったら、この記事を思い出してくださいね。

この記事を書いた人

侍エンジニア塾は「人生を変えるプログラミング学習」をコンセンプトに、過去多くのフリーランスエンジニアを輩出したプログラミングスクールです。侍テック編集部では技術系コンテンツを中心に有用な情報を発信していきます。

目次