stream_filter_register
Function • Params and return types changed in PHP 8.0
Register a user defined stream filter.
stream_filter_register Function synopsis
stream_filter_register(string $filter_name, string $class): boolParameters
$filter_name
Typestring
The filter name to be registered.
$class
Typestring
To implement a filter, you need to define a class as an extension of
php_user_filter with a number of member
functions. When performing read/write operations on the stream
to which your filter is attached, PHP will pass the data through your
filter (and any other filters attached to that stream) so that the
data may be modified as desired. You must implement the methods
exactly as described in php_user_filter - doing
otherwise will lead to undefined behaviour.
Return value
Typebool
Returns true on success, false on failure
stream_filter_register will return false if the
$filter_name is already defined.
Changes to the stream_filter_register Function
PHP 8.0
- Return type added:
bool - Parameter name of parameter #1 changed:
$filternameto$filter_name - Parameter type added for parameter #1 (
$filter_name):string - Parameter name of parameter #2 changed:
$classnameto$class - Parameter type added for parameter #2 (
$class):string
- stream_filter_register($filtername, $classname)
+ stream_filter_register(string $filter_name, string $class): boolstream_filter_register Function Availability
stream_filter_register Function Availability| PHP Version | Availability |
|---|---|
| PHP 8.6Upcoming Release | Yes |
| PHP 8.5Supported (Latest) | Yes |
| PHP 8.4Supported | Yes |
| PHP 8.3Security-Fixes Only | Yes |
| PHP 8.2Security-Fixes Only | Yes |
| PHP 8.1Unsupported | Yes |
| PHP 8.0Unsupported | Yes |
| PHP 7.4Unsupported | Yes |
| PHP 7.3Unsupported | Yes |
| PHP 7.2Unsupported | Yes |
| PHP 7.1Unsupported | Yes |
| PHP 7.0Unsupported | Yes |
| PHP 5.6Unsupported | Yes |
| PHP 5.5Unsupported | Yes |
| PHP 5.4Unsupported | Yes |
| PHP 5.3Unsupported | Yes |