filter_input

(PHP 5 >= 5.2.0, PHP 7, PHP 8)

filter_input — Toma una variable externa concreta por su nombre y opcionalmente la filtra

Descripción

filter_input(
    int $type,
    string $var_name,
    int $filter = FILTER_DEFAULT,
    array|int $options = 0
): mixed

Parámetros

type
Una de las constantes INPUT_*.
Advertencia

El contenido de la superglobal que se está filtrando es el original "sin procesar" proporcionado por SAPI, antes de cualquier modificación del usuario a la superglobal. Para filtrar una superglobal modificada, utilice filter_var_array() en su lugar.

var_name
Nombre de una variable a filtrar dentro de la superglobal correspondiente type.
filter
El filtro a aplicar. Puede ser un filtro de validación usando una de las constantes FILTER_VALIDATE_*, un filtro de saneamiento usando una de las constantes FILTER_SANITIZE_* o FILTER_UNSAFE_RAW, o un filtro personalizado usando FILTER_CALLBACK.

Nota: Por omisión es FILTER_DEFAULT, que es un alias de FILTER_UNSAFE_RAW. Esto resultará en que no se aplique ningún filtro por omisión.

options
O bien un array asociativo de opciones, o bien una máscara de bits de constantes de indicadores de filtro FILTER_FLAG_*. Si el filter acepta opciones, los indicadores pueden ser proporcionados usando el campo "flags" del array.

Valores devueltos

Valor de la variable solicitada en caso de éxito, false si el filtro falla, o null si la variable var_name no está definida. Si se usa el flag FILTER_NULL_ON_FAILURE, devuelve false si la variable no está definida y null si el filtro falla.

Ejemplos

Ejemplo #1 Un ejemplo de filter_input()

<?php
$search_html = filter_input(INPUT_GET, 'search', FILTER_SANITIZE_SPECIAL_CHARS);
$search_url = filter_input(INPUT_GET, 'search', FILTER_SANITIZE_ENCODED);
echo "Has buscado $search_html.\n";
echo "<a href='?search=$search_url'>Busca de nuevo.</a>";
?>

Resultado del ejemplo anterior es similar a:

Has buscado Me &#38; son.
<a href='?search=Me%20%26%20son'>Busca de nuevo.</a>

Ver también