Tutorials References Menu

PHP Tutorial

PHP HOME PHP Intro PHP Install PHP Syntax PHP Comments PHP Variables PHP Echo / Print PHP Data Types PHP Strings PHP Numbers PHP Math PHP Constants PHP Operators PHP If...Else...Elseif PHP Switch PHP Loops PHP Functions PHP Arrays PHP Superglobals PHP RegEx

PHP Forms

PHP Form Handling PHP Form Validation PHP Form Required PHP Form URL/E-mail PHP Form Complete

PHP Advanced

PHP Date and Time PHP Include PHP File Handling PHP File Open/Read PHP File Create/Write PHP File Upload PHP Cookies PHP Sessions PHP Filters PHP Filters Advanced PHP Callback Functions PHP JSON PHP Exceptions

PHP OOP

PHP What is OOP PHP Classes/Objects PHP Constructor PHP Destructor PHP Access Modifiers PHP Inheritance PHP Constants PHP Abstract Classes PHP Interfaces PHP Traits PHP Static Methods PHP Static Properties PHP Namespaces PHP Iterables

MySQL Database

MySQL Database MySQL Connect MySQL Create DB MySQL Create Table MySQL Insert Data MySQL Get Last ID MySQL Insert Multiple MySQL Prepared MySQL Select Data MySQL Where MySQL Order By MySQL Delete Data MySQL Update Data MySQL Limit Data

PHP XML

PHP XML Parsers PHP SimpleXML Parser PHP SimpleXML - Get PHP XML Expat PHP XML DOM

PHP - AJAX

AJAX Intro AJAX PHP AJAX Database AJAX XML AJAX Live Search AJAX Poll

PHP Examples

PHP Examples PHP Compiler

PHP Reference

PHP Overview PHP Array PHP Calendar PHP Date PHP Directory PHP Error PHP Exception PHP Filesystem PHP Filter PHP FTP PHP JSON PHP Keywords PHP Libxml PHP Mail PHP Math PHP Misc PHP MySQLi PHP Network PHP Output Control PHP RegEx PHP SimpleXML PHP Stream PHP String PHP Variable Handling PHP XML Parser PHP Zip PHP Timezones

PHP ob_start() Function

❮ PHP Output Control Functions

Example

Create an output buffer:

<?php
ob_start();
echo "This content will not be sent to the browser.";
ob_end_clean();

echo "This content will be sent to the browser.";
?>
Try it Yourself »

Definition and Usage

The ob_start() function creates an output buffer. A callback function can be passed in to do processing on the contents of the buffer before it gets flushed from the buffer. Flags can be used to permit or restrict what the buffer is able to do.


Syntax

ob_start(callback, chunk_size, flags);

Parameter Values

Parameter Description
callback Optional. A callback used to process the contents of the buffer before it gets flushed.

The callback function should have the following parameters:
Parameter Description
buffer The contents of the output buffer
phase A bitmask which may have any number of the following flags:
PHP_OUTPUT_HANDLER_START - If the output buffer was just created
PHP_OUTPUT_HANDLER_FLUSH - If the output buffer is currently being flushed
PHP_OUTPUT_HANDLER_FINAL - If the output buffer will be deleted right after this operation
chunk_size Optional. Defaults to 0. When set to a value greater than zero, the buffer will automatically be flushed as soon as the length of the contents exceeds this value
flags Optional. Defaults to PHP_OUTPUT_HANDLER_STDFLAGS.

A bitmask which determines what operations the buffer is permitted to do. It may contain the following flags:

PHP_OUTPUT_HANDLER_CLEANABLE - Calls to ob_clean(), ob_end_clean() and ob_get_clean() are permitted.

PHP_OUTPUT_HANDLER_FLUSHABLE - Calls to ob_flush(), ob_end_flush() and ob_get_flush() are permitted.

PHP_OUTPUT_HANDLER_REMOVABLE - Calls to ob_end_clean(), ob_end_flush() and ob_get_flush() are permitted.

PHP_OUTPUT_HANDLER_STDFLAGS - Equivalent to

PHP_OUTPUT_HANDLER_CLEANABLE|
PHP_OUTPUT_HANDLER_FLUSHABLE|
PHP_OUTPUT_HANDLER_REMOVABLE

Technical Details

Return Value: TRUE on success, FALSE on failure
PHP Version: 4+

❮ PHP Output Control Functions