array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'pt_BR', ), 'this' => array ( 0 => 'function.mb-substitute-character.php', 1 => 'mb_substitute_character', 2 => 'Define/Obtém caractere de substituição', ), 'up' => array ( 0 => 'ref.mbstring.php', 1 => 'Strings Multibyte e Funções', ), 'prev' => array ( 0 => 'function.mb-strwidth.php', 1 => 'mb_strwidth', ), 'next' => array ( 0 => 'function.mb-substr.php', 1 => 'mb_substr', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'pt_BR', 'path' => 'reference/mbstring/functions/mb-substitute-character.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

mb_substitute_character

(PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8)

mb_substitute_character — Define/Obtém caractere de substituição

Descrição

mb_substitute_character(string|int|null $substitute_character = null): string|int|bool

Especifica um caractere de substituição quando a codificação de caracteres de entrada é inválida ou o código de caractere não existe na codificação de caracteres de saída. Caracteres inválidos podem ser substituídos por "none" (sem saída), string ou valor int (valor do código de caractere Unicode).

Essa configuração afeta as funções mb_convert_encoding(), mb_convert_variables(), mb_output_handler(), mb_scrub() e mb_send_mail().

Parâmetros

substitute_character

Especifique o valor Unicode como um int, ou como uma das seguintes strings:

  • "none": sem saída
  • "long": Valor do código de caractere de saída (Exemplo: U+3000, JIS+7E7E)
  • "entity": Entidade de caractere de saída (Exemplo: Ȁ)

Valor Retornado

Se substitute_character for configurado, retorna true para sucesso, caso contrário, retorna false. Se substitute_character não estiver configurado, retorna a configuração atual.

Registro de Alterações

Versão Descrição
8.0.0 Passar uma string vazia para substitute_character não é mais suportado; deve-se passar "none" em vez disso.
8.0.0 O parâmetro encoding agora pode ser nulo.

Exemplos

Exemplo #1 Exemplo de mb_substitute_character()

<?php
/* Definir com Unicode U+3013 (GETA MARK) */
mb_substitute_character(0x3013);

/* Definir no formato hexadecimal */
mb_substitute_character("long");

/* Exibir configuração atual */
echo mb_substitute_character();
?>