PHP function stream_filter_append()

Availability in versions: PHP 4.3.0

Attach a filter to a stream

Parameters

Parameter	Data type	Default value	Note
$stream	resource	not	The target stream.
$filtername	string	not	The filter name.
$read_write	int	null,	By default, stream_filter_append will attach the filter to the read filter chain if the file was opened for reading (i.e. File Mode: r, and/or +). The filter will also be attached to the write filter chain if the file was opened for writing (i.e. File Mode: w, a, and/or +). STREAM_FILTER_READ, STREAM_FILTER_WRITE, and/or STREAM_FILTER_ALL can also be passed to the read_write parameter to override this behavior.
$params	mixed	null	This filter will be added with the specified params to the end of the list and will therefore be called last during stream operations. To add a filter to the beginning of the list, use stream_filter_prepend.

Return values

resource

a resource which can be used to refer to this filter instance during a call to stream_filter_remove.

Other resources

Official stream-filter-append documentation