WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

is_utf8_charset()

is_utf8_charset( string|null $blog_charset = null ): bool

In this article

Back to top

Indicates if a given slug for a character set represents the UTF-8 text encoding. If not provided, examines the current blog’s charset.

Description

A charset is considered to represent UTF-8 if it is a case-insensitive match of "UTF-8" with or without the hyphen.

Example:

true  === is_utf8_charset( 'UTF-8' );
true  === is_utf8_charset( 'utf8' );
false === is_utf8_charset( 'latin1' );
false === is_utf8_charset( 'UTF 8' );

// Only strings match.
false === is_utf8_charset( [ 'charset' => 'utf-8' ] );

// Without a given charset, it depends on the site option "blog_charset".
$is_utf8 = is_utf8_charset();

See also

Parameters

$blog_charsetstring|nulloptional
Slug representing a text character encoding, or "charset".
E.g. "UTF-8", "Windows-1252", "ISO-8859-1", "SJIS".
Default value is to infer from "blog_charset" option.

Default:null

Return

bool Whether the slug represents the UTF-8 encoding.

Source

function is_utf8_charset( $blog_charset = null ) {
	return _is_utf8_charset( $blog_charset ?? get_option( 'blog_charset' ) );
}

View all references View on Trac View on GitHub

UsesDescription
get_option()wp-includes/option.php

Retrieves an option value based on an option name.

Used byDescription
WP_Script_Modules::print_script_module_data()wp-includes/class-wp-script-modules.php

Print data associated with Script Modules.

wp_check_invalid_utf8()wp-includes/formatting.php

Checks for invalid UTF8 in a string.

_canonical_charset()wp-includes/functions.php

Retrieves a canonical form of the provided charset appropriate for passing to PHP functions such as htmlspecialchars() and charset HTML attributes.

Changelog

VersionDescription
6.6.1A wrapper for _is_utf8_charset
6.6.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.