(PHP 4, PHP 5, PHP 7, PHP 8)
ob_start — 打開輸出控制緩沖
$output_callback
= null
, int $chunk_size
= 0, int $flags
= PHP_OUTPUT_HANDLER_STDFLAGS
): bool此函數(shù)將打開輸出緩沖。當(dāng)輸出緩沖激活后,腳本將不會(huì)輸出內(nèi)容(除http標(biāo)頭外),相反需要輸出的內(nèi)容被存儲(chǔ)在內(nèi)部緩沖區(qū)中。
內(nèi)部緩沖區(qū)的內(nèi)容可以用 ob_get_contents() 函數(shù)復(fù)制到一個(gè)字符串變量中。 想要輸出存儲(chǔ)在內(nèi)部緩沖區(qū)中的內(nèi)容,可以使用 ob_end_flush() 函數(shù)。另外, 使用 ob_end_clean() 函數(shù)會(huì)靜默丟棄掉緩沖區(qū)的內(nèi)容。
當(dāng)有正在調(diào)用的回調(diào)函數(shù)時(shí),一些網(wǎng)絡(luò)服務(wù)器(例如Apache)會(huì)改變一個(gè)腳本的工作目錄。
你可以在回調(diào)函數(shù)中再把它改回來,例如
chdir(dirname($_SERVER['SCRIPT_FILENAME']))
。
輸出緩沖區(qū)是可堆疊的,這即意謂著,當(dāng)有一個(gè) ob_start() 是活躍的時(shí), 你可以調(diào)用另一個(gè) ob_start() 。 只要確保又正確調(diào)用了 ob_end_flush() 恰當(dāng)?shù)拇螖?shù)即可。 如果有多重輸出回調(diào)函數(shù)是活躍的,輸出內(nèi)容會(huì)一直按嵌套的順序依次通過它們而被過濾。
output_callback
可選參數(shù) output_callback
函數(shù)可以被指定。
此函數(shù)把一個(gè)字符串當(dāng)作參數(shù)并返回一個(gè)字符串。
當(dāng)輸出緩沖區(qū)被( ob_flush(), ob_clean() 或者相似的函數(shù))沖刷(送出)或者被清洗的時(shí)候;或者在請(qǐng)求結(jié)束之際輸出緩沖區(qū)內(nèi)容被沖刷到瀏覽器的時(shí)候該函數(shù)將會(huì)被調(diào)用。
當(dāng)調(diào)用 output_callback
時(shí),它將收到輸出緩沖區(qū)的內(nèi)容作為參數(shù)
并預(yù)期返回一個(gè)新的輸出緩沖區(qū)作為結(jié)果,這個(gè)新返回的輸出緩沖區(qū)內(nèi)容將被送到瀏覽器。
如果這個(gè) output_callback
不是一個(gè)可以調(diào)用的函數(shù),此函數(shù)
會(huì)返回 false
。以下是回調(diào)簽名:
$buffer
, int $phase
= ?): stringbuffer
phase
PHP_OUTPUT_HANDLER_*
常量。
如果 output_callback
返回 false
,其原來的輸入
內(nèi)容被直接送到瀏覽器。
這個(gè)參數(shù) output_callback
可以通過直接給一個(gè) null
值而避開。
ob_end_clean(), ob_end_flush(),
ob_clean(), ob_flush() 和
ob_start() 不能從一個(gè)回調(diào)函數(shù)中調(diào)用。
如果從回調(diào)函數(shù)中調(diào)用了它們,產(chǎn)生的行為是不明確的。
如果想要?jiǎng)h除緩沖區(qū)的內(nèi)容,從回調(diào)函數(shù)中返回一個(gè)"" (空字符串)。
更不能從一個(gè)回調(diào)函數(shù)中使用像print_r($expression, true)
或highlight_file($filename, true)
一樣的輸出緩沖函數(shù)。
注意:
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
如果可選參數(shù) chunk_size
被賦值了,在任何一個(gè)能引起緩沖區(qū)的長度等于
或超過 chunk_size
的輸出操作后,緩沖區(qū)都會(huì)被刷送。
默認(rèn)值 0
意味著函數(shù)僅在最后被調(diào)用。
PHP 5.4.0 之前,1
是一個(gè)特殊情況下的值,代表將 chunk_size 設(shè)置為 4096 字節(jié)。
flags
flags
參數(shù)代表了一個(gè)掩碼位,用來控制對(duì)緩沖區(qū)的操作。
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è)標(biāo)志都控制著對(duì)一組功能的訪問,詳細(xì)介紹如下:
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 用戶自定義回調(diào)函數(shù)的例子
<?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è)不可擦除的輸出緩沖區(qū)
<?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);
}
?>