ob_start

(PHP 4, PHP 5, PHP 7, PHP 8)

ob_start打開輸出控制緩沖

說明

ob_start(callable $output_callback = null, int $chunk_size = 0, int $flags = PHP_OUTPUT_HANDLER_STDFLAGS): bool

此函數(shù)將打開輸出緩沖。當(dāng)輸出緩沖激活后,腳本將不會輸出內(nèi)容(除http標(biāo)頭外),相反需要輸出的內(nèi)容被存儲在內(nèi)部緩沖區(qū)中。

內(nèi)部緩沖區(qū)的內(nèi)容可以用 ob_get_contents() 函數(shù)復(fù)制到一個字符串變量中。 想要輸出存儲在內(nèi)部緩沖區(qū)中的內(nèi)容,可以使用 ob_end_flush() 函數(shù)。另外, 使用 ob_end_clean() 函數(shù)會靜默丟棄掉緩沖區(qū)的內(nèi)容。

警告

當(dāng)有正在調(diào)用的回調(diào)函數(shù)時,一些網(wǎng)絡(luò)服務(wù)器(例如Apache)會改變一個腳本的工作目錄。 你可以在回調(diào)函數(shù)中再把它改回來,例如 chdir(dirname($_SERVER['SCRIPT_FILENAME'])) 。

輸出緩沖區(qū)是可堆疊的,這即意謂著,當(dāng)有一個 ob_start() 是活躍的時, 你可以調(diào)用另一個 ob_start() 。 只要確保又正確調(diào)用了 ob_end_flush() 恰當(dāng)?shù)拇螖?shù)即可。 如果有多重輸出回調(diào)函數(shù)是活躍的,輸出內(nèi)容會一直按嵌套的順序依次通過它們而被過濾。

參數(shù)

output_callback

可選參數(shù) output_callback 函數(shù)可以被指定。 此函數(shù)把一個字符串當(dāng)作參數(shù)并返回一個字符串。 當(dāng)輸出緩沖區(qū)被( ob_flush(), ob_clean() 或者相似的函數(shù))沖刷(送出)或者被清洗的時候;或者在請求結(jié)束之際輸出緩沖區(qū)內(nèi)容被沖刷到瀏覽器的時候該函數(shù)將會被調(diào)用。 當(dāng)調(diào)用 output_callback 時,它將收到輸出緩沖區(qū)的內(nèi)容作為參數(shù) 并預(yù)期返回一個新的輸出緩沖區(qū)作為結(jié)果,這個新返回的輸出緩沖區(qū)內(nèi)容將被送到瀏覽器。 如果這個 output_callback 不是一個可以調(diào)用的函數(shù),此函數(shù) 會返回 false。以下是回調(diào)簽名:

handler(string $buffer, int $phase = ?): string
buffer
輸出緩沖區(qū)中的內(nèi)容。
phase
比特掩碼 PHP_OUTPUT_HANDLER_* 常量。

如果 output_callback 返回 false ,其原來的輸入 內(nèi)容被直接送到瀏覽器。

這個參數(shù) output_callback 可以通過直接給一個 null 值而避開。

ob_end_clean(), ob_end_flush(), ob_clean(), ob_flush()ob_start() 不能從一個回調(diào)函數(shù)中調(diào)用。 如果從回調(diào)函數(shù)中調(diào)用了它們,產(chǎn)生的行為是不明確的。 如果想要刪除緩沖區(qū)的內(nèi)容,從回調(diào)函數(shù)中返回一個"" (空字符串)。 更不能從一個回調(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 被賦值了,在任何一個能引起緩沖區(qū)的長度等于 或超過 chunk_size 的輸出操作后,緩沖區(qū)都會被刷送。 默認(rèn)值 0 意味著函數(shù)僅在最后被調(diào)用。

PHP 5.4.0 之前,1 是一個特殊情況下的值,代表將 chunk_size 設(shè)置為 4096 字節(jié)。

flags

flags 參數(shù)代表了一個掩碼位,用來控制對緩沖區(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.

每個標(biāo)志都控制著對一組功能的訪問,詳細(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()

返回值

成功時返回 true, 或者在失敗時返回 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
();

?>

以上例程會輸出:

<html>
<body>
<p>It's like comparing oranges to oranges.</p>
</body>
</html>

示例 #2 以兼容 PHP 5.3 和 5.4 的方式創(chuàng)建一個不可擦除的輸出緩沖區(qū)

<?php

if (version_compare(PHP_VERSION'5.4.0''>=')) {
  
ob_start(null0PHP_OUTPUT_HANDLER_STDFLAGS ^
    
PHP_OUTPUT_HANDLER_REMOVABLE);
} else {
  
ob_start(null0false);
}

?>

參見

  • ob_get_contents() - 返回輸出緩沖區(qū)的內(nèi)容
  • ob_end_clean() - 清空(擦除)緩沖區(qū)并關(guān)閉輸出緩沖
  • ob_end_flush() - 沖刷出(送出)輸出緩沖區(qū)內(nèi)容并關(guān)閉緩沖
  • ob_implicit_flush() - 打開/關(guān)閉絕對刷送
  • ob_gzhandler() - 在ob_start中使用的用來壓縮輸出緩沖區(qū)中內(nèi)容的回調(diào)函數(shù)。ob_start callback function to gzip output buffer
  • ob_iconv_handler() - 以輸出緩沖處理程序轉(zhuǎn)換字符編碼
  • mb_output_handler() - 在輸出緩沖中轉(zhuǎn)換字符編碼的回調(diào)函數(shù)
  • ob_tidyhandler() - ob_start callback function to repair the buffer