PHP8 ob_start — 打開輸出控制緩沖

2023-09-12 14:07 更新

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

ob_start — 打開輸出控制緩沖

說明

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

此函數(shù)將打開輸出緩沖。當輸出緩沖激活后，腳本將不會輸出內(nèi)容（消息頭除外），相反需要輸出的內(nèi)容被存儲在內(nèi)部緩沖區(qū)中。

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

警告

當有正在調(diào)用的回調(diào)函數(shù)時，一些 Web 服務器（例如 Apache）會改變腳本的工作目錄?？梢栽诨卣{(diào)函數(shù)中再把它改回來，例如 chdir(dirname($_SERVER['SCRIPT_FILENAME']))。

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

如果腳本結(jié)束時輸出緩存仍處于激活狀態(tài)，PHP 會自動輸出內(nèi)容。

參數(shù)

callback

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

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

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

這個參數(shù) 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() 函數(shù)的存在有助于將 gz 編碼的數(shù)據(jù)發(fā)送到支持壓縮網(wǎng)頁的 Web 瀏覽器。ob_gzhandler() 確定瀏覽器將接受哪種類型的內(nèi)容編碼并相應的返回輸出。

chunk_size

如果可選參數(shù) chunk_size 被賦值了，在任何一個能引起緩沖區(qū)的長度等于 或超過 chunk_size 的輸出操作后，緩沖區(qū)都會被刷送。 默認值 0 意味著函數(shù)僅在最后被調(diào)用。

flags

flags 參數(shù)代表了一個掩碼位，用來控制對緩沖區(qū)的操作。默認是允許清理、刷新和移除輸出緩沖區(qū)，可以通過 PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_FLUSHABLE | PHP_OUTPUT_HANDLER_REMOVABLE 顯式設置或使用 PHP_OUTPUT_HANDLER_STDFLAGS 作為簡寫。

每個標志都控制著對一組功能的訪問，詳細介紹如下：

常量 函數(shù)
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 創(chuàng)建不可擦除的輸出緩沖區(qū)

<?php

ob_start(null, 0, PHP_OUTPUT_HANDLER_STDFLAGS ^ PHP_OUTPUT_HANDLER_REMOVABLE);

?>

參見

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


以上內(nèi)容是否對您有幫助：
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號