WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

_canonical_charset()

_canonical_charset( string $charset ): string

In this article

Back to top

This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only by core. It is listed here for completeness.

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

Description

See also

Parameters

$charsetstringrequired
A charset name, e.g. "UTF-8", "Windows-1252", "SJIS".

Return

string The canonical form of the charset.

Source

function _canonical_charset( $charset ) {
	if ( is_utf8_charset( $charset ) ) {
		return 'UTF-8';
	}

	/*
	 * Normalize the ISO-8859-1 family of languages.
	 *
	 * This is not required for htmlspecialchars(), as it properly recognizes all of
	 * the input character sets that here are transformed into "ISO-8859-1".
	 *
	 * @todo Should this entire check be removed since it's not required for the stated purpose?
	 * @todo Should WordPress transform other potential charset equivalents, such as "latin1"?
	 */
	if (
		( 0 === strcasecmp( 'iso-8859-1', $charset ) ) ||
		( 0 === strcasecmp( 'iso8859-1', $charset ) )
	) {
		return 'ISO-8859-1';
	}

	return $charset;
}

View all references View on Trac View on GitHub

UsesDescription
is_utf8_charset()wp-includes/functions.php

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

Used byDescription
_wp_die_process_input()wp-includes/functions.php

Processes arguments passed to wp_die() consistently for its handlers.

_wp_specialchars()wp-includes/formatting.php

Converts a number of special characters into their HTML entities.

Changelog

VersionDescription
3.6.0Introduced.

User Contributed Notes

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