Documentación offline PHP master

stream_filter_append

master Ver versión oficial en línea Licencia CC-BY-3.0Descargado el 2026-08-02

En esta página

stream_filter_append

Añade un filtro a un flujo al final de la lista

Descripción#

stream_filter_append(resource $stream, string $filter_name, [int $mode], [mixed $params]): resource
```php

`stream_filter_append` añade el filtro `filter_name` a la lista de filtros adjuntos al flujo `stream`.

## Parámetros

`stream`  
El flujo de destino.

`filter_name`  
El nombre del filtro.

`mode`  
Por omisión, `stream_filter_append` añadirá el filtro a la lista de filtros de lectura si el fichero se abrió en modo lectura (`r` y/o `+`). El filtro también se adjuntará a la lista de filtros de escritura si el fichero se abrió en modo escritura (`w`, `a` y/o `+`). `STREAM_FILTER_READ`, `STREAM_FILTER_WRITE`, y/o `STREAM_FILTER_ALL` pueden también ser utilizadas en el parámetro `mode` para controlar este comportamiento.

`params`  
Este filtro se añadirá con los parámetros `params` al *final* de la lista de filtros, y será llamado al final de las operaciones de filtros. Para añadir un filtro al principio de la lista, utilice la función `stream_filter_prepend`.

## Valores devueltos

Devuelve un recurso en caso de éxito, o `false` si ocurre un error. El recurso puede ser utilizado para referirse a la instancia de este filtro durante una llamada a la función `stream_filter_remove`.

`false` es devuelto si `stream` no es un recurso o si `filter_name` no puede ser alcanzado.

## Ejemplos

Controlar la aplicación de los filtros

```php

Notas#

[!NOTE] stream_register_filter debe ser llamada antes de stream_filter_append para registrar el filtro bajo el nombre de filter_name.

[!NOTE] Los datos del flujo (locales y remotos) son devueltos en fragmentos, los datos no procesados se conservan en el búfer interno. Cuando un nuevo filtro es añadido al final del flujo, los datos en el búfer interno son pasados al nuevo filtro en ese momento. Esto es diferente del comportamiento de stream_filter_prepend.

[!NOTE] Cuando un filtro es añadido para lectura y escritura, se crean dos instancias del filtro. stream_filter_prepend debe ser llamada dos veces con STREAM_FILTER_READ y STREAM_FILTER_WRITE para obtener los recursos de los filtros.

Véase también#

stream_filter_register

stream_filter_prepend

stream_get_filters