(PHP 4, PHP 5, PHP 7, PHP 8)
ob_start — 打開(kāi)輸出控制緩沖
$output_callback
= null
, int $chunk_size
= 0, int $flags
= PHP_OUTPUT_HANDLER_STDFLAGS
): bool此函數將打開(kāi)輸出緩沖。當輸出緩沖激活后,腳本將不會(huì )輸出內容(除http標頭外),相反需要輸出的內容被存儲在內部緩沖區中。
內部緩沖區的內容可以用 ob_get_contents() 函數復制到一個(gè)字符串變量中。 想要輸出存儲在內部緩沖區中的內容,可以使用 ob_end_flush() 函數。另外, 使用 ob_end_clean() 函數會(huì )靜默丟棄掉緩沖區的內容。
當有正在調用的回調函數時(shí),一些網(wǎng)絡(luò )服務(wù)器(例如Apache)會(huì )改變一個(gè)腳本的工作目錄。
你可以在回調函數中再把它改回來(lái),例如
chdir(dirname($_SERVER['SCRIPT_FILENAME']))
。
輸出緩沖區是可堆疊的,這即意謂著(zhù),當有一個(gè) ob_start() 是活躍的時(shí), 你可以調用另一個(gè) ob_start() 。 只要確保又正確調用了 ob_end_flush() 恰當的次數即可。 如果有多重輸出回調函數是活躍的,輸出內容會(huì )一直按嵌套的順序依次通過(guò)它們而被過(guò)濾。
output_callback
可選參數 output_callback
函數可以被指定。
此函數把一個(gè)字符串當作參數并返回一個(gè)字符串。
當輸出緩沖區被( ob_flush(), ob_clean() 或者相似的函數)沖刷(送出)或者被清洗的時(shí)候;或者在請求結束之際輸出緩沖區內容被沖刷到瀏覽器的時(shí)候該函數將會(huì )被調用。
當調用 output_callback
時(shí),它將收到輸出緩沖區的內容作為參數
并預期返回一個(gè)新的輸出緩沖區作為結果,這個(gè)新返回的輸出緩沖區內容將被送到瀏覽器。
如果這個(gè) output_callback
不是一個(gè)可以調用的函數,此函數
會(huì )返回 false
。以下是回調簽名:
$buffer
, int $phase
= ?): stringbuffer
phase
PHP_OUTPUT_HANDLER_*
常量。
如果 output_callback
返回 false
,其原來(lái)的輸入
內容被直接送到瀏覽器。
這個(gè)參數 output_callback
可以通過(guò)直接給一個(gè) null
值而避開(kāi)。
ob_end_clean(), ob_end_flush(),
ob_clean(), ob_flush() 和
ob_start() 不能從一個(gè)回調函數中調用。
如果從回調函數中調用了它們,產(chǎn)生的行為是不明確的。
如果想要刪除緩沖區的內容,從回調函數中返回一個(gè)"" (空字符串)。
更不能從一個(gè)回調函數中使用像print_r($expression, true)
或highlight_file($filename, true)
一樣的輸出緩沖函數。
注意:
ob_gzhandler() function exists to facilitate sending gz-encoded data to web browsers that support compressed web pages. ob_gzhandler() determines what type of content encoding the browser will accept and will return its output accordingly.
chunk_size
如果可選參數 chunk_size
被賦值了,在任何一個(gè)能引起緩沖區的長(cháng)度等于
或超過(guò) chunk_size
的輸出操作后,緩沖區都會(huì )被刷送。
默認值 0
意味著(zhù)函數僅在最后被調用。
PHP 5.4.0 之前,1
是一個(gè)特殊情況下的值,代表將 chunk_size 設置為 4096 字節。
flags
flags
參數代表了一個(gè)掩碼位,用來(lái)控制對緩沖區的操作。
The default
is to allow output buffers to be cleaned, flushed and removed, which
can be set explicitly via
PHP_OUTPUT_HANDLER_CLEANABLE
|
PHP_OUTPUT_HANDLER_FLUSHABLE
|
PHP_OUTPUT_HANDLER_REMOVABLE
, or
PHP_OUTPUT_HANDLER_STDFLAGS
as shorthand.
每個(gè)標志都控制著(zhù)對一組功能的訪(fǎng)問(wèn),詳細介紹如下:
Constant | Functions |
---|---|
PHP_OUTPUT_HANDLER_CLEANABLE |
ob_clean(), ob_end_clean() 和 ob_get_clean()。 |
PHP_OUTPUT_HANDLER_FLUSHABLE |
ob_end_flush(), ob_flush() 和 ob_get_flush()。 |
PHP_OUTPUT_HANDLER_REMOVABLE |
ob_end_clean(), ob_end_flush() 和 ob_get_flush()。 |
成功時(shí)返回 true
, 或者在失敗時(shí)返回 false
。
示例 #1 用戶(hù)自定義回調函數的例子
<?php
function callback($buffer)
{
// replace all the apples with oranges
return (str_replace("apples", "oranges", $buffer));
}
ob_start("callback");
?>
<html>
<body>
<p>It's like comparing apples to oranges.</p>
</body>
</html>
<?php
ob_end_flush();
?>
以上例程會(huì )輸出:
<html> <body> <p>It's like comparing oranges to oranges.</p> </body> </html>
示例 #2 以兼容 PHP 5.3 和 5.4 的方式創(chuàng )建一個(gè)不可擦除的輸出緩沖區
<?php
if (version_compare(PHP_VERSION, '5.4.0', '>=')) {
ob_start(null, 0, PHP_OUTPUT_HANDLER_STDFLAGS ^
PHP_OUTPUT_HANDLER_REMOVABLE);
} else {
ob_start(null, 0, false);
}
?>