wp_check_invalid_utf8()
Checks for invalid UTF8 in a string.
Used By: sanitize_text_field(), esc_html()
No Hooks.
Return
String
. The checked text.
Usage
wp_check_invalid_utf8( $text, $strip );
- $text(string) (required)
- The text which is to be checked.
- $strip(true|false)
- Whether to attempt to strip out invalid UTF8.
Default: false
Examples
#1 Checking the function
$examples = [ 'Valid ASCII' => "a", 'Valid 2 Octet Sequence' => "\xc3\xb1", 'Valid 3 Octet Sequence' => "\xe2\x82\xa1", 'Valid 4 Octet Sequence' => "\xf0\x90\x8c\xbc", 'Valid 5 Octet Sequence (but not Unicode!)' => "\xf8\xa1\xa1\xa1\xa1", 'Valid 6 Octet Sequence (but not Unicode!)' => "\xfc\xa1\xa1\xa1\xa1\xa1", 'Invalid 2 Octet Sequence' => "\xc3\x28", 'Invalid Sequence Identifier' => "\xa0\xa1", 'Invalid 3 Octet Sequence (in 2nd Octet)' => "\xe2\x28\xa1", 'Invalid 3 Octet Sequence (in 3rd Octet)' => "\xe2\x82\x28", 'Invalid 4 Octet Sequence (in 2nd Octet)' => "\xf0\x28\x8c\xbc", 'Invalid 4 Octet Sequence (in 3rd Octet)' => "\xf0\x90\x28\xbc", 'Invalid 4 Octet Sequence (in 4th Octet)' => "\xf0\x28\x8c\x28", ]; $result = []; foreach ( $examples as $key => $value ) { $result[ $key ] = wp_check_invalid_utf8( $value ); } var_dump( $result );
Result:
array(13) { ["Valid ASCII"]=> string(1) "a" ["Valid 2 Octet Sequence"]=> string(2) "ñ" ["Valid 3 Octet Sequence"]=> string(3) "₡" ["Valid 4 Octet Sequence"]=> string(4) "𐌼" ["Valid 5 Octet Sequence (but not Unicode!)"]=> string(0) "" ["Valid 6 Octet Sequence (but not Unicode!)"]=> string(0) "" ["Invalid 2 Octet Sequence"]=> string(0) "" ["Invalid Sequence Identifier"]=> string(0) "" ["Invalid 3 Octet Sequence (in 2nd Octet)"]=> string(0) "" ["Invalid 3 Octet Sequence (in 3rd Octet)"]=> string(0) "" ["Invalid 4 Octet Sequence (in 2nd Octet)"]=> string(0) "" ["Invalid 4 Octet Sequence (in 3rd Octet)"]=> string(0) "" ["Invalid 4 Octet Sequence (in 4th Octet)"]=> string(0) "" }
Changelog
Since 2.8.0 | Introduced. |