The php_user_filter class

(PHP 5, PHP 7, PHP 8)

Introduction

Children of this class are passed to stream_filter_register(). Note that the __construct method is not called; instead, php_user_filter::onCreate() should be used for initialization.

Class synopsis

class php_user_filter {
/* Properties */
public string $filtername = "";
public mixed $params = "";
public ?resource $stream = null;
/* Methods */
public filter(
    resource $in,
    resource $out,
    int &$consumed,
    bool $closing
): int
public onClose(): void
public onCreate(): bool
}

Properties

filtername

Name of the filter registered by stream_filter_append().

params

stream

Table of Contents