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 in other core functions. It is listed here for completeness. Use https://core.trac.wordpress.org/ticket/23688 instead.

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.

Return

string The canonical form of the charset.

Source

function _canonical_charset( $charset ) {
	if ( 'utf-8' === strtolower( $charset ) || 'utf8' === strtolower( $charset ) ) {

		return 'UTF-8';
	}

	if ( 'iso-8859-1' === strtolower( $charset ) || 'iso8859-1' === strtolower( $charset ) ) {

		return 'ISO-8859-1';
	}

	return $charset;
}

View all references View on Trac View on GitHub

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

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

Changelog

VersionDescription
3.6.0Introduced.

User Contributed Notes

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