filter_input

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

filter_inputObtém uma variável externa específica por nome e filtra-a opcionalmente

Descrição

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

Parâmetros

type
Uma das constantes INPUT_*.
Aviso

O conteúdo da superglobal que está sendo filtrada é o conteúdo "bruto" original fornecido pela SAPI, antes de qualquer modificação de usuário na superglobal. Para filtrar uma superglobal modificada, use a função filter_var().

var_name
Nome de uma variável a filtrar dentro da superglobal type correspondente.
filter
O filtro a ser aplicado. Pode ser um filtro de validação pelo uso de uma das constantes FILTER_VALIDATE_*, um filtro de sanitização pelo uso de uma das constantes FILTER_SANITIZE_* ou de FILTER_UNSAFE_RAW, ou um filtro cutomizado com o uso de FILTER_CALLBACK.

Nota: O padrão é FILTER_DEFAULT, que é um sinônimo de FILTER_UNSAFE_RAW. Isto resultará em nenhuma filtragem por padrão.

options
Um array associativo de opções, ou uma máscara de bits de constantes de opções de filtro FILTER_FLAG_*. Se filter aceitar opções, elas podem ser fornecidas pelo uso do campo "flags" do array.

Valor Retornado

Em caso de sucesso retorna a variável filtrada. Se a variável não estiver definida, retorna false. Em caso de falha, retorna false, a não ser que a opção FILTER_NULL_ON_FAILURE seja usada, neste caso retorna null.

Exemplos

Exemplo #1 Um exemplo 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
"Você pesquisou por $search_html.\n";
echo
"<a href='?search=$search_url'>Pesquise novamente.</a>";
?>

O exemplo acima produzirá algo semelhante a:

Você pesquisou por Me &#38; son.
<a href='?search=Me%20%26%20son'>Pesquise novamente.</a>

Veja Também