htmlspecialchars

    (PHP 4, PHP 5, PHP 7, PHP 8)

    htmlspecialchars — Convert special characters to HTML entities

    Descrição

    htmlspecialchars(
        string$string,
        int$flags = ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401,
        ?string$encoding = null,
        bool$double_encode = true
    ): string

    Certain characters have special significance in HTML, and should be represented by HTML entities if they are to preserve their meanings. This function returns a string with these conversions made. If you require all input substrings that have associated named entities to be translated, use htmlentities() instead.

    If the input string passed to this function and the final document share the same character set, this function is sufficient to prepare input for inclusion in most contexts of an HTML document. If, however, the input can represent characters that are not coded in the final document character set and you wish to retain those characters (as numeric or named entities), both this function and htmlentities() (which only encodes substrings that have named entity equivalents) may be insufficient. You may have to use mb_encode_numericentity() instead.

    Performed translations
    CharacterReplacement
    & (ampersand)&
    " (double quote)", unless ENT_NOQUOTES is set
    ' (single quote)' (for ENT_HTML401) or ' (for ENT_XML1, ENT_XHTML or ENT_HTML5), but only when ENT_QUOTES is set
    < (less than)&lt;
    > (greater than)&gt;

    Parâmetros

    string

    The string being converted.

    flags

    A bitmask of one or more of the following flags, which specify how to handle quotes, invalid code unit sequences and the used document type. The default is ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401.

    Available flags constants
    Constant NameDescription
    ENT_COMPATWill convert double-quotes and leave single-quotes alone.
    ENT_QUOTESWill convert both double and single quotes.
    ENT_NOQUOTESWill leave both double and single quotes unconverted.
    ENT_IGNORE Silently discard invalid code unit sequences instead of returning an empty string. Using this flag is discouraged as it » may have security implications.
    ENT_SUBSTITUTE Replace invalid code unit sequences with a Unicode Replacement Character U+FFFD (UTF-8) or &#xFFFD; (otherwise) instead of returning an empty string.
    ENT_DISALLOWED Replace invalid code points for the given document type with a Unicode Replacement Character U+FFFD (UTF-8) or &#xFFFD; (otherwise) instead of leaving them as is. This may be useful, for instance, to ensure the well-formedness of XML documents with embedded external content.
    ENT_HTML401 Handle code as HTML 4.01.
    ENT_XML1 Handle code as XML 1.
    ENT_XHTML Handle code as XHTML.
    ENT_HTML5 Handle code as HTML 5.
    encoding

    Um argumento opcional que define a codificação usada na conversão de caracteres.

    Se omitido, encoding assume como padrão o valor da opção de configuração default_charset .

    Embora este argumento seja tecnicamente opcional, especificar o valor correto para o código é altamente recomendável se a opção de configuração default_charset puder ser definida incorretamente para a entrada fornecida.

    For the purposes of this function, the encodings ISO-8859-1, ISO-8859-15, UTF-8, cp866, cp1251, cp1252, and KOI8-R are effectively equivalent, provided the string itself is valid for the encoding, as the characters affected by htmlspecialchars() occupy the same positions in all of these encodings.

    Os seguintes conjuntos de caracteres são suportados:

    Conjuntos de caracteres suportados
    Conjunto de caracteresApelidosDescrição
    ISO-8859-1ISO8859-1 Western European, Latin-1.
    ISO-8859-5ISO8859-5 Conjunto de caracteres cirílicos pouco usado (Latim/Cirílico).
    ISO-8859-15ISO8859-15 Western European, Latin-9. Adiciona o símbolo do Euro, letras Francesas e Filandesas faltando no Latin-1 (ISO-8859-1).
    UTF-8  Código de multi-byte 8-bit Unicode compatível com ASCII.
    cp866ibm866, 866 Conjunto de caracteres do DOS específico para o Russo.
    cp1251Windows-1251, win-1251, 1251 Conjunto de caracteres do Windows específico para o Russo.
    cp1252Windows-1252, 1252 Conjunto de caracteres do Windows específico para a Europa Ocidental.
    KOI8-Rkoi8-ru, koi8r Russo.
    BIG5950 Chinês Tradicional, usado principalmente em Taiwan.
    GB2312936 Chins Simplificado, conjunto de caracteres padrão nacional.
    BIG5-HKSCS  Big5 com extenções de Hong Kong, Chinês Tradicional.
    Shift_JISSJIS, SJIS-win, cp932, 932 Japonês
    EUC-JPEUCJP, eucJP-win Japonês
    MacRoman  Conjunto de caracteres que era usado pelo Mac OS.
    ''  Uma string vazia ativa a detecção a partir de codificação de script (multibyte Zend), conjunto padrão de caracteres e localidade atual (consulte nl_langinfo() e setlocale()), nesta ordem. Não recomendado.

    Nota: Nenhum outro conjunto de caracteres é reconhecido. A codificação padrão será usada no lugar e um alerta será emitido.

    double_encode

    When double_encode is turned off PHP will not encode existing html entities, the default is to convert everything.

    Valor Retornado

    The converted string.

    If the input string contains an invalid code unit sequence within the given encoding an empty string will be returned, unless either the ENT_IGNORE or ENT_SUBSTITUTE flags are set.

    Registro de Alterações

    VersãoDescrição
    8.1.0flags changed from ENT_COMPAT to ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401.

    Exemplos

    Exemplo #1 htmlspecialchars() example

    <?php
    $new     = htmlspecialchars("<a href='test'>Test</a>", ENT_QUOTES);
    echo     $new; // &lt;a href=&#039;test&#039;&gt;Test&lt;/a&gt;
    ?>

    Notas

    Nota:

    Note that this function does not translate anything beyond what is listed above. For full entity translation, see htmlentities().

    Nota:

    In case of an ambiguous flags value, the following rules apply:

    Veja Também

    To Top