PHP Manual
Prev |  | Next

# mb_substitute_character

(PHP 4 >= 4.0.6)

mb_substitute_character -- Set/Get substitution character

## Description

``mixed mb_substitute_character` ([mixed substrchar])`

Warning
This function is EXPERIMENTAL. The behaviour of this function, the name of this function, and anything else documented about this function may change in a future release of PHP without notice. Be warned and use this function at your own risk.

mb_substitute_character() specifies substitution character when input character encoding is invalid or character code is not exist in output character encoding. Invalid characters may be substituted `NULL`(no output), string or integer value (Unicode character code value).

This setting affects mb_detect_encoding() and mb_send_mail().

`substchar` : Specify Unicode value as integer or specify as string as follows

- "none" : no output

- "long" : Output character code value (Example: U+3000,JIS+7E7E)

Return Value: If `substchar` is set, it returns `TRUE` for success, otherwise returns `FALSE`. If `substchar` is not set, it returns Unicode value or "`none`"/"`long`".

Example 1. mb_substitute_character() example
    /* Set with Unicode U+3013 (GETA MARK) */
    mb_substitute_character(0x3013);

    /* Set hex format */
    mb_substitute_character("long");

    /* Display current setting */
    echo mb_substitute_character();

Prev | Home | Next
mb_detect_order | Up | mb_output_handler