header
(PHP 3, PHP 4, PHP 5)
header -- 發送一個原始 HTTP 標題
說明
void header ( string string [, bool replace [, int http_response_code]] )
header() 函數用來發送一個原始 HTTP 標題。有關 HTTP 標題的更多內容見 HTTP/1.1 規範。
選擇性參數 replace 指明是替換掉前一條類似的標題還是增加一條相同類型的標題。預設為替換,但如果將其設為 FALSE 則可以強制發送多個同類標題。例如:
<?php header('WWW-Authenticate: Negotiate'); header('WWW-Authenticate: NTLM', false); ?> |
第二個選擇性參數 http_response_code 強制將 HTTP 響應代碼設為指定值(此參數是 PHP 4.3.0 新加的)。
有兩種特殊的 header 調用。第一種是標題以字串“HTTP/”(大小寫不重要)開頭的,可以用來確定要發送的 HTTP 狀態代碼。例如,如果配置了 Apache 用 PHP 來處理找不到檔案的錯誤處理請求(使用 ErrorDocument 指令),需要確保指令碼產生了正確的狀態代碼。
<?php header("HTTP/1.0 404 Not Found") ?> |
注: HTTP 狀態代碼標題行總是第一個被發送到用戶端,而並不管實際的 header() 調用是否是第一個。除非 HTTP 標題已經發送出去,任何時候都可以通過用新的狀態行調用 header() 函數來覆蓋原先的。
第二種特殊情況是以“Location:”標題。它不只是把這個標題發送回瀏覽器,它還將一個 REDIRECT(302)狀態代碼返回給瀏覽器,除非之前已經發出了某個 3xx 狀態代碼。
<?php header("Location: http://www.example.com/"); /* 重新導向瀏覽器 */ /* 確保重新導向後,後續代碼不會被執行 */ exit; ?>
|
注: HTTP/1.1 標準需要一個絕對位址的 URI 做為 Location: 的參數, 但有一些用戶端支援相對 URI。通常可以使用 $_SERVER['HTTP_HOST']、$_SERVER['PHP_SELF'] 及 dirname() 函數來自己從相對 URI 產生出絕對 URI:
<?phpheader("Location: http://".$_SERVER['HTTP_HOST'] . rtrim(dirname($_SERVER['PHP_SELF']), '/\\') ."/".$relative_url);?> |
注: 即使啟用了 session.use_trans_sid,Session ID 也不會隨著 Location 頭資訊被傳遞。必須手工用 SID 常量來傳遞。
PHP 指令碼通常會產生一些動態內容,這些內容必須不被瀏覽器或Proxy 伺服器緩衝。很多Proxy 伺服器和瀏覽器都可以被下面的方法禁止緩衝:
<?php header("Cache-Control: no-cache, must-revalidate"); // HTTP/1.1 header("Expires: Mon, 26 Jul 1997 05:00:00 GMT"); // 過去的時間 ?> |
注: 可能會發現即使不輸出上面所有的代碼,網頁也沒有被緩衝。使用者有很多選項可以設定來改變瀏覽器的預設緩衝行為。通過發送上述標題,應該可以覆蓋任何可以導致指令碼頁面被緩衝的設定。
另外,當使用了 session 時,利用 session_cache_limiter() 函數和 session.cache_limiter 選項可以用來自動產生正確的緩衝相關標題。
要記住 header() 必須在任何實際輸出之前調用,不論是來自普通的 HTML 標籤,空行或者 PHP。有一個常見錯誤就是在通過 include(),require() 或一些其它的檔案存取類函數讀取代碼時,有一些空格或者空行在調用 header() 之前被發送了出去。同樣在一個單獨的 PHP/HTML 檔案中這個錯誤也很普遍。
<html> <?php /* 這將產生一個錯誤,因為在調 header() * 之前已經輸出了東西 */ header('Location: http://www.example.com/'); ?> |
注: 自 PHP 4 起,可以通過一些輸出緩衝函數來解決這個問題。代價是把所有向瀏覽器的輸出都緩衝在伺服器,直到下命令發送它們。可以在代碼中使用 ob_start() 及 ob_end_flush() 來實現這樣的功能,或者通過修改 php.ini 中的 output_buffering 配置選項來實現,也可以通過修改伺服器設定檔來實現。
如果想提示使用者儲存所發送的資料,例如一個產生的 PDF 檔案,可以通過發送 Content-Disposition 標題提供推薦的檔案名稱來強制瀏覽器彈出一個儲存檔案對話方塊。
<?php // 這樣將會直接輸出一個 PDF 檔案 header('Content-type: application/pdf');// 這樣做就會提示下載 PDF 檔案 downloaded.pdf header('Content-Disposition: attachment; filename="downloaded.pdf"'); // 這是 original.pdf 的源檔案 readfile('original.pdf'); ?>
|
注: Microsoft Internet Explorer 4.01 中的一個漏洞使得該機制無法正常工作,無解決方案。在 Microsoft Internet Explorer 5.5 中也有個漏洞影響到這一點,升級到 Service Pack 2 或更高版本可以解決。
注: 在安全模式下,如果設定了 WWW-Authenticate 標題(用於 HTTP 認證)則指令碼的 UID 會添加到其中的 realm 部分中去。